IVssRestClientOptions interface

Options for a specific instance of a REST client.

Properties

authTokenProvider

Auth token manager that can be used to get and attach auth tokens to requests. If not supplied, the default token provider is used if the serviceInstanceType option is supplied and is different from the hosting page's service instance type.

command

Current command for activity logging.

rootPath

The root URL path to use for this client. Can be relative or absolute.

sessionId

Current session id.

Property Details

authTokenProvider

Auth token manager that can be used to get and attach auth tokens to requests. If not supplied, the default token provider is used if the serviceInstanceType option is supplied and is different from the hosting page's service instance type.

authTokenProvider?: IAuthorizationTokenProvider

Property Value

command

Current command for activity logging.

command?: string

Property Value

string

rootPath

The root URL path to use for this client. Can be relative or absolute.

rootPath?: string | Promise<string>

Property Value

string | Promise<string>

sessionId

Current session id.

sessionId?: string

Property Value

string