getApi

getApi() ⇒ Object

The Api object contains various helper methods

Kind: global function
Returns: Object - Object containing these helper methods

abortRequest: ƒ (e)
buildFileURL: ƒ (e,t)
buildURL: ƒ (e,t,n,r)
bulk: ƒ (e,t,n)
call: ƒ (e,t,i,o,c)
clearBulkQueue: ƒ ()
clearStateProperty: ƒ (e)
clientID: ""
collection: ƒ (e,t,n,r,i)
count: ƒ (e,t,n,r)
css: ƒ (e,t,n)
debug: undefined
defaultErrorHandler: ƒ (e,t,n)
enumOptions: ƒ (e,t,n,r)
exportRecords: ƒ (e,t,r,i)
favorite: ƒ (e,t,n,r,i)
file: ƒ (e,t,n,r,i)
fileDownload: ƒ (e,t,n)
follow: ƒ (e,t,n,r,i)
getDownloadToken: ƒ ()
getMetadata: ƒ (e)
getMetadataHash: ƒ ()
getOAuthToken: ƒ ()
getRefreshToken: ƒ ()
getRequest: ƒ (e)
getStateProperty: ƒ (e)
getUserprefHash: ƒ ()
handleExternalLogin: ƒ (e,t,n)
info: ƒ (e)
isAuthRequest: ƒ (e)
isAuthenticated: ƒ ()
isExternalLogin: ƒ ()
isLoginRequest: ƒ (e)
isRequestInQueue: ƒ (e)
login: ƒ (e,t,r)
logout: ƒ (e,t)
me: ƒ (e,t,n,r)
needQueue: ƒ (e)
needRefreshAuthToken: ƒ (e,t)
ping: ƒ (e,t,r)
records: ƒ (e,t,n,r,i,a)
refreshingToken: ƒ (e)
relationships: ƒ (e,t,n,r,i,a)
resetAuth: ƒ ()
resetState: ƒ ()
search: ƒ (e,t,n)
serverUrl: "rest/v11_7"
setExternalLogin: ƒ (e)
setExternalLoginUICallback: ƒ (e)
setRefreshTokenSuccessCallback: ƒ (e)
setRefreshingToken: ƒ (e)
setStateProperty: ƒ (e,t)
signup: ƒ (e,t,r)
timeout: 180000
triggerBulkCall: ƒ (e)
updatePassword: ƒ (e,t,n)
verifyPassword: ƒ (e,t)
xhrDownloadFile: ƒ (e,t)

Since: v0.0.1
Example

// undefined
 getApi() // -> {}

 // defined
 // api = {
 //      ping: ƒ (e,t,r)
 //      records: ƒ (e,t,n,r,i,a)
 //      refreshingToken: ƒ (e)
 //      relationships: ƒ (e,t,n,r,i,a)
 //       ...
 //     }
 // }
 getApi() // -> returns an object { buildUrl, ... }