Class PinClient

Hierarchy

BaseClient
- PinClient

Implements

IClient

Constructors

constructor

new PinClient(props): PinClient
Parameters
- props: IPinClientProps
Returns PinClient
Overrides BaseClient.constructor
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/PinClient.ts:102

Properties

accessCode

accessCode: IAuthorizePollPinCodeResponse

accessCodeResponse

accessCodeResponse: IAccessCodeResponse

activateUrl

activateUrl: string

apiUrl

apiUrl: string

defaultTexts

defaultTexts: IPinClientTexts = ...

getAccessTokenPromise

getAccessTokenPromise: Promise<IAccessToken>

monitorPinCodeReject

monitorPinCodeReject: ((error) => void)

Type declaration

- (error): void
- Parameters
  - error: IClientError
  Returns void

monitorPinCodeResolve

monitorPinCodeResolve: ((response) => void)

Type declaration

- (response): void
- Parameters
  - response: IAuthorizePollPinCodeResponse
  Returns void

monitorPinCodeTimeout

monitorPinCodeTimeout: any

pin: string

props

props: IPinClientProps

redirectUrl

redirectUrl: string

settings

settings: ClientSettings

Methods

_addApiVersion

_addApiVersion(url): string
Parameters
- url: string
Returns string
Inherited from BaseClient._addApiVersion
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:73

_ajax

_ajax(config): void
Parameters
- config: IAjaxCallConfig
Returns void
Inherited from BaseClient._ajax
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:140

_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
Inherited from BaseClient._call
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:99

_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
Inherited from BaseClient._getAccessToken
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:230

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
Inherited from BaseClient.callWithUserAuth
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:315

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
Inherited from BaseClient.callWithUserAuthSync
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:353

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
Inherited from BaseClient.formUrlEncodeObject
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:199

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>
Implementation of IClient.get

Inherited from BaseClient.get
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:371

getAccessCode

getAccessCode(async, resolve, reject): void
Parameters
- async: boolean
- resolve: ((response) => void)
  - - (response): void
    - Parameters
      
      response: IGetAccessCodeResponse
      
      Returns void
- reject: ((error) => void)
  - - (error): void
    - Parameters
      
      error: IClientError
      
      Returns void
Returns void
Overrides BaseClient.getAccessCode
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/PinClient.ts:181

getAccessToken

getAccessToken(async): Promise<IAccessToken>
Parameters
- async: boolean
Returns Promise<IAccessToken>
Implementation of IClient.getAccessToken

Inherited from BaseClient.getAccessToken
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:213

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
Inherited from BaseClient.getAccessTokenSync
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:210

getApiUrl

getApiUrl(): string
Returns string
Implementation of IClient.getApiUrl

Inherited from BaseClient.getApiUrl
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:70

getCachedAccessToken

getCachedAccessToken(): string
Returns string
Inherited from BaseClient.getCachedAccessToken
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:419

hasCachedCredentials

hasCachedCredentials(): boolean
Checks if the current client has any cached credentials (access or refresh).

Returns boolean
Implementation of IClient.hasCachedCredentials

Inherited from BaseClient.hasCachedCredentials
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:428

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>
Implementation of IClient.json

Inherited from BaseClient.json
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:422

monitorPinCode

monitorPinCode(async, resolve, reject): void
Parameters
- async: boolean
- resolve: ((response) => void)
  - - (response): void
    - Parameters
      
      response: IAuthorizePollPinCodeResponse
      
      Returns void
- reject: ((error) => void)
  - - (error): void
    - Parameters
      
      error: IClientError
      
      Returns void
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/PinClient.ts:155

pinCodeRequest

pinCodeRequest(async, resolve, reject): void
Parameters
- async: boolean
- resolve: ((response) => void)
  - - (response): void
    - Parameters
      
      response: IAuthorizePinCodeResponse
      
      Returns void
- reject: ((error) => void)
  - - (error): void
    - Parameters
      
      error: IClientError
      
      Returns void
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/PinClient.ts:107

pollPinCode

pollPinCode(async, resolve, reject): void
Parameters
- async: boolean
- resolve: ((response) => void)
  - - (response): void
    - Parameters
      
      response: IAuthorizePollPinCodeResponse
      
      Returns void
- reject: ((error) => void)
  - - (error): void
    - Parameters
      
      error: IClientError
      
      Returns void
Returns void
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/PinClient.ts:133

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>
Implementation of IClient.post

Inherited from BaseClient.post
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:392

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
Implementation of IClient.postSync

Inherited from BaseClient.postSync
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:409

removeCachedCredentials

removeCachedCredentials(): void
Removes any cached authentication credentials

Returns void
Implementation of IClient.removeCachedCredentials

Inherited from BaseClient.removeCachedCredentials
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:434

requestAccessToken

requestAccessToken(async, resolve, reject): void
Parameters
- async: boolean
- resolve: ((response) => void)
  - - (response): void
    - Parameters
      
      response: IAccessToken
      
      Returns void
- reject: ((error) => void)
  - - (error): void
    - Parameters
      
      error: IClientError
      
      Returns void
Returns void
Inherited from BaseClient.requestAccessToken
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/BaseClient.ts:284

`Private` translate

translate<T>(text, ...args): string
Type Parameters
- T extends keyof IPinClientTexts
Parameters
- text: T
- Rest ...args: string[]
Returns string
- Defined in ImageVault.ClientScript/Scripts/imagevault-client-script/scripts/ts/PinClient.ts:123

Class PinClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: IPinClientProps

Returns PinClient

Properties

accessCode

accessCodeResponse

activateUrl

apiUrl

defaultTexts

getAccessTokenPromise

monitorPinCodeReject

Type declaration

Parameters

error: IClientError

Returns void

monitorPinCodeResolve

Type declaration

Parameters

response: IAuthorizePollPinCodeResponse

Returns void

monitorPinCodeTimeout

pin

props

redirectUrl

settings

Methods

_addApiVersion

Parameters

url: string

Returns string

_ajax

Parameters

config: IAjaxCallConfig

Returns void

_call

Type Parameters

T

Parameters

options: CallOptions

resolve: ((result) => void)

Parameters

result: T

Returns void

reject: ((error) => void)

Parameters

error: IClientError

Returns void

Returns void

_getAccessToken

Parameters

async: boolean

resolve: ((response) => void)

Parameters

response: IAccessToken

Returns void

reject: ((error) => void)

Parameters

error: IClientError

Returns void

tokenFailures: number

Returns void

callWithUserAuth

Type Parameters

T

Parameters

options: CallOptions

resolve: ((result) => void)

Parameters

result: T

Returns void

reject: ((error) => void)