Class ApiBase

Index

Constructors

Methods

delete dispose get getAuthSession getConfiguration getDomain getValidJwt jwt patch post put renewJwt

Constructors

constructor

new ApiBase(configuration: SDKConfiguration): ApiBase
Parameters
- configuration: SDKConfiguration
Returns ApiBase
- Defined in apiBase.ts:165

Methods

delete

delete(requestInfo: RequestInfo): Promise<void>
Performs an HTTP DELETE request given a parameters hash
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<void>
Promise
- Defined in apiBase.ts:243

dispose

dispose(): void
Cancels any pending renewal. Deliberately not a permanent kill switch: a client that keeps being used reschedules, so React StrictMode's mount/cleanup/mount does not disable renewals for good.

Returns void
- Defined in apiBase.ts:432

get

get<T>(requestInfo: RequestInfo): Promise<T>
Performs an HTTP GET request given a parameters hash
Type Parameters
- T
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<T>
Promise
- Defined in apiBase.ts:203

getAuthSession

getAuthSession(): Promise<AuthSession>
Returns Promise<AuthSession>
- Defined in apiBase.ts:316

getConfiguration

getConfiguration(): SDKConfiguration
Returns the configuration of the api

Returns SDKConfiguration
- Defined in apiBase.ts:261

getDomain

getDomain(): string
Gets the current domain

Returns string
- Defined in apiBase.ts:252

getValidJwt

getValidJwt(): Promise<string>
Returns a usable JWT, authenticating or renewing the session as needed.

Returns Promise<string>
- Defined in apiBase.ts:312

jwt

jwt(): string
Returns the JWT held by the current session, without authenticating.

Returns string
- Defined in apiBase.ts:305

patch

patch<T>(requestInfo: RequestInfo): Promise<T>
Performs an HTTP PATCH request given a parameters hash
Type Parameters
- T
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<T>
Promise
- Defined in apiBase.ts:233

post

post<T>(requestInfo: RequestInfo): Promise<T>
Performs an HTTP POST request given a parameters hash
Type Parameters
- T
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<T>
Promise
- Defined in apiBase.ts:213

put

put<T>(requestInfo: RequestInfo): Promise<T>
Performs an HTTP POST request given a parameters hash
Type Parameters
- T
Parameters
- requestInfo: RequestInfo
  Parameters to use while performing the request
Returns Promise<T>
Promise
- Defined in apiBase.ts:223

renewJwt

renewJwt(): Promise<AccessTokens>
Renew the JWT using the auth property

Returns Promise<AccessTokens>
Promise Returns the new JWT string
- Defined in apiBase.ts:502