UserTokenClientImpl class

Referensi

Paket:: botframework-connector

Memperluas: UserTokenClient

Konstruktor

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

Metode

exchangeToken(string, string, string, TokenExchangeRequest)	Melakukan operasi pertukaran token seperti untuk akses menyeluruh.
getAadTokens(string, string, string[], string)	Mengambil token Azure Active Directory untuk sumber daya tertentu pada koneksi yang dikonfigurasi.
getSignInResource(string, Activity, string)	Secara asinkron Dapatkan sumber daya masuk mentah untuk dikirim ke pengguna untuk masuk.
getTokenStatus(string, string, string)	Mengambil status token untuk setiap koneksi yang dikonfigurasi untuk pengguna tertentu.
getUserToken(string, string, string, string)	Mencoba mengambil token untuk pengguna yang berada dalam alur masuk.
signOutUser(string, string, string)	Mengeluarkan pengguna dengan server token.

Detail Konstruktor

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

new UserTokenClientImpl(appId: string, credentials: ServiceClientCredentials, oauthEndpoint: string, connectorClientOptions?: ConnectorClientOptions)

Parameter

appId: string

AppId.

credentials: ServiceClientCredentials

AppCredentials untuk OAuth.

oauthEndpoint: string

Titik akhir OAuth API.

connectorClientOptions: ConnectorClientOptions

Objek ConnectorClientOptions.

Detail Metode

exchangeToken(string, string, string, TokenExchangeRequest)

Melakukan operasi pertukaran token seperti untuk akses menyeluruh.

function exchangeToken(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

Parameter

userId: string

Id pengguna yang akan dikaitkan dengan token.

connectionName: string

Nama koneksi autentikasi yang akan digunakan.

channelId: string

Id saluran yang akan dikaitkan dengan token.

exchangeRequest: TokenExchangeRequest

Detail permintaan pertukaran, baik token untuk ditukar atau uri untuk ditukar.

Mengembalikan

Promise<TokenResponse>

Janji yang mewakili hasil operasi.

getAadTokens(string, string, string[], string)

Mengambil token Azure Active Directory untuk sumber daya tertentu pada koneksi yang dikonfigurasi.

function getAadTokens(userId: string, connectionName: string, resourceUrls: string[], channelId: string): Promise<Record<string, TokenResponse>>

Parameter

userId: string

Id pengguna yang akan dikaitkan dengan token.

connectionName: string

Nama koneksi autentikasi yang akan digunakan.

resourceUrls: string[]

Daftar URL sumber daya untuk mengambil token.

channelId: string

Id saluran yang akan dikaitkan dengan token.

Mengembalikan

Promise<Record<string, TokenResponse>>

Janji Kamus resourceUrl ke TokenResponse yang sesuai.

getSignInResource(string, Activity, string)

Secara asinkron Dapatkan sumber daya masuk mentah untuk dikirim ke pengguna untuk masuk.

function getSignInResource(connectionName: string, activity: Activity, finalRedirect: string): Promise<SignInUrlResponse>

Parameter

connectionName: string

Nama koneksi autentikasi yang akan digunakan.

activity: Activity

Aktivitas tempat memperoleh status pertukaran token.

finalRedirect: string

URL akhir yang akan dialihkan oleh alur OAuth.

Mengembalikan

Promise<SignInUrlResponse>

Sumber daya SignInUrlResponse.

getTokenStatus(string, string, string)

Mengambil status token untuk setiap koneksi yang dikonfigurasi untuk pengguna tertentu.

function getTokenStatus(userId: string, channelId: string, includeFilter: string): Promise<TokenStatus[]>

Parameter

userId: string

Id pengguna yang akan dikaitkan dengan token.

channelId: string

Id saluran yang akan dikaitkan dengan token.

includeFilter: string

IncludeFilter.

Mengembalikan

Promise<TokenStatus[]>

Janji dengan Array Status Token.

getUserToken(string, string, string, string)

Mencoba mengambil token untuk pengguna yang berada dalam alur masuk.

function getUserToken(userId: string, connectionName: string, channelId: string, magicCode: string): Promise<TokenResponse>

Parameter

userId: string

Id pengguna yang akan dikaitkan dengan token.

connectionName: string

Nama koneksi autentikasi yang akan digunakan.

channelId: string

Id saluran yang akan dikaitkan dengan token.

magicCode: string

(Opsional) Pengguna opsional memasukkan kode untuk divalidasi.

Mengembalikan

Promise<TokenResponse>

Respons token.

signOutUser(string, string, string)

Mengeluarkan pengguna dengan server token.

function signOutUser(userId: string, connectionName: string, channelId: string): Promise<void>

Parameter

userId: string

Id pengguna yang akan dikaitkan dengan token.

connectionName: string

Nama koneksi autentikasi yang akan digunakan.

channelId: string

Id saluran yang akan dikaitkan dengan token.

Mengembalikan

Promise<void>