Client class

Package:

@microsoft/teams.common

Constructors

Client(ClientOptions)

Properties

interceptors
middlewares	Registered HTTP middleware in execution order.
name
token

Methods

clear()	Clear (Eject) all interceptors
clone(ClientOptions)	Create a copy of the client
delete<T, R, D>(string, RequestConfig<D>)
eject(number)	Eject an interceptor
get<T, R, D>(string, RequestConfig<D>)
patch<T, R, D>(string, D, RequestConfig<D>)
post<T, R, D>(string, D, RequestConfig<D>)
put<T, R, D>(string, D, RequestConfig<D>)
request<T, R, D>(RequestConfig<D>)
use(Interceptor)	Register an interceptor for request/response/error compatibility.
use(Middleware)	Register HTTP middleware.

Constructor Details

Client(ClientOptions)

new Client(options?: ClientOptions)

Parameters

options

ClientOptions

Property Details

interceptors

readonly Interceptor[] interceptors

Property Value

readonly Interceptor[]

middlewares

Registered HTTP middleware in execution order.

readonly Middleware[] middlewares

Property Value

readonly Middleware[]

name

name: string

Property Value

string

token

token?: Token

Property Value

Token

Method Details

clear()

Clear (Eject) all interceptors

function clear()

clone(ClientOptions)

Create a copy of the client

function clone(options?: ClientOptions): Client

Parameters

options

ClientOptions

Returns

Client

delete<T, R, D>(string, RequestConfig<D>)

function delete<T, R, D>(url: string, config?: RequestConfig<D>): Promise<R>

Parameters

url

string

config

RequestConfig<D>

Returns

Promise<R>

eject(number)

Eject an interceptor

function eject(id: number)

Parameters

id

number

get<T, R, D>(string, RequestConfig<D>)

function get<T, R, D>(url: string, config?: RequestConfig<D>): Promise<R>

Parameters

url

string

config

RequestConfig<D>

Returns

Promise<R>

patch<T, R, D>(string, D, RequestConfig<D>)

function patch<T, R, D>(url: string, data?: D, config?: RequestConfig<D>): Promise<R>

Parameters

url

string

data

D

config

RequestConfig<D>

Returns

Promise<R>

post<T, R, D>(string, D, RequestConfig<D>)

function post<T, R, D>(url: string, data?: D, config?: RequestConfig<D>): Promise<R>

Parameters

url

string

data

D

config

RequestConfig<D>

Returns

Promise<R>

put<T, R, D>(string, D, RequestConfig<D>)

function put<T, R, D>(url: string, data?: D, config?: RequestConfig<D>): Promise<R>

Parameters

url

string

data

D

config

RequestConfig<D>

Returns

Promise<R>

request<T, R, D>(RequestConfig<D>)

function request<T, R, D>(config: RequestConfig<D>): Promise<R>

Parameters

config

RequestConfig<D>

Returns

Promise<R>

use(Interceptor)

Register an interceptor for request/response/error compatibility.

function use(interceptor: Interceptor): number

Parameters

interceptor

Interceptor

Returns

number

use(Middleware)

Register HTTP middleware.

function use(middleware: Middleware): number

Parameters

middleware

Middleware

Returns

number