Delegate

Delegate protocol used by OAuth2Client to communicate important events.

Hierarchy

• APIClientDelegate
  • Delegate

Index

Methods

• api
• oauth

Methods

api

• api(client: APIClient, willSendRequest: HTTPRequest): any
• api(client: APIClient, didSendRequest: HTTPRequest, receivedError: Error, requestId?: String, rateLimit?: APIRateLimit): any
• api(client: APIClient, didSendRequest: HTTPRequest, receivedResponse: HTTPResponse): any
• api<T>(client: APIClient, didSendRequest: HTTPRequest, receivedResponse: APIResponse<T>): any
• api(client: APIClient, shouldRetryRequest: HTTPRequest): APIRetry

• Inherited from APIClientDelegate.api

  Invoked immediately prior to a URLRequest being converted to a DataTask.

  ---

  Parameters

  • client: APIClient

  • willSendRequest: HTTPRequest

  Returns any

oauth

• oauth(client: OAuth2Client, willRefreshToken: Token): void
• oauth(client: OAuth2Client, didRefreshToken: Token, replacedWithNewToken?: Token): void

• Sent before a token will begin to refresh.

  ---

  Parameters

  • client: OAuth2Client

  • willRefreshToken: Token

  Returns void