Class ClientCredentialsClient

accessCodeResponse

apiUrl

getAccessTokenPromise

redirectUrl

settings

_addApiVersion

• _addApiVersion(url): string

• Parameters

  • url: string

  Returns string

_ajax

• _ajax(config): void

• Parameters

  • config: IAjaxCallConfig

  Returns void

_call

• _call<T>(options, resolve, reject): void

• Type Parameters

  • T

  Parameters

  • options: CallOptions

  • resolve: ((result) => void)

    • • (result): void

      • Parameters

        • result: T

        Returns void

  • reject: ((error) => void)

    • • (error): void

      • Parameters

        • error: IClientError

        Returns void

  Returns void

_getAccessToken

• _getAccessToken(async, resolve, reject, tokenFailures): void

• Parameters

  • async: boolean

    true if method is called asynchronously.

  • resolve: ((response) => void)

    • • (response): void

      • Parameters

        • response: IAccessToken

        Returns void

  • reject: ((error) => void)

    • • (error): void

      • Parameters

        • error: IClientError

        Returns void

  • tokenFailures: number

    Bitwise flag that indicates which methods we have tried. 1: accessToken failed. 2: refreshToken failed

  Returns void

callWithUserAuth

• callWithUserAuth<T>(options, resolve, reject): void

• Invokes a asynchronous request but with a valid access token. If access token exists, it's used. If access token gives 401 error, then a new is requested and the call is tried again

  Type Parameters

  • T

  Parameters

  • options: CallOptions

    options to pass to the ajax call

  • resolve: ((result) => void)

    callback for resolving a successful call

    • • (result): void

      • Parameters

        • result: T

        Returns void

  • reject: ((error) => void)

    callback for resolving an erroneous call

    • • (error): void

      • Parameters

        • error: IClientError

        Returns void

  Returns void

callWithUserAuthSync

• callWithUserAuthSync<T>(options, resolve, reject): void

• Invokes a synchronous request but with a valid access token. If access token exists, it's used. If access token gives 401 error, then a new is requested and the call is tried again

  Type Parameters

  • T

  Parameters

  • options: CallOptions

    options to pass to the ajax call

  • resolve: ((result) => void)

    callback for resolving a successful call

    • • (result): void

      • Parameters

        • result: T

        Returns void

  • reject: ((error) => void)

    callback for resolving an erroneous call

    • • (error): void

      • Parameters

        • error: IClientError

        Returns void

  Returns void

formUrlEncodeObject

• formUrlEncodeObject(data, key?, list?): string

• Converts an object to a x-www-form-urlencoded string

  Parameters

  • data: any

    The data object to convert

  • key: string = null

    The key describing the data, should be left empty on first call

  • list: string[] = []

    The list of added key=value pairs

  Returns string

get

• get<T>(path, resolve, reject): void | Promise<T>

• Type Parameters

  • T

  Parameters

  • path: string

  • resolve: ((result) => void)

    • • (result): void

      • Parameters

        • result: T

        Returns void

  • reject: ((error) => void)

    • • (error): void

      • Parameters

        • error: IClientError

        Returns void

  Returns void | Promise<T>

getAccessToken

• getAccessToken(async): Promise<IAccessToken>

• Parameters

  • async: boolean

  Returns Promise<IAccessToken>

getAccessTokenSync

• getAccessTokenSync(resolve, reject, tokenFailures): void

• Parameters

  • resolve: ((response) => void)

    • • (response): void

      • Parameters

        • response: IAccessToken

        Returns void

  • reject: ((error) => void)

    • • (error): void

      • Parameters

        • error: IClientError

        Returns void

  • tokenFailures: number

  Returns void

getApiUrl

• getApiUrl(): string

• Returns string

getCachedAccessToken

• getCachedAccessToken(): string

• Returns string

hasCachedCredentials

• hasCachedCredentials(): boolean

• Checks if the current client has any cached credentials (access or refresh).

  Returns boolean

json

• json<T>(path, argument, resolve, reject): void | Promise<T>

• Type Parameters

  • T

  Parameters

  • path: string

  • argument: any

  • resolve: ((result) => void)

    • • (result): void

      • Parameters

        • result: T

        Returns void

  • reject: ((error) => void)

    • • (error): void

      • Parameters

        • error: IClientError

        Returns void

  Returns void | Promise<T>

post

• post<T>(options, resolve, reject): void | Promise<T>

• Type Parameters

  • T

  Parameters

  • options: CallOptions

    call options for the post method

  • resolve: ((result) => void)

    callback for resolving a successful call

    • • (result): void

      • Parameters

        • result: T

        Returns void

  • reject: ((error) => void)

    callback for resolving an erroneous call

    • • (error): void

      • Parameters

        • error: IClientError

        Returns void

  Returns void | Promise<T>

postSync

• postSync<T>(options): T

• Performs a synchronous post operation. Will block processing until response is received

  Type Parameters

  • T

  Parameters

  • options: CallOptions

    call options for the post method

  Returns T

  the json content in object form

removeCachedCredentials

• removeCachedCredentials(): void

• Removes any cached authentication credentials

  Returns void