Bagikan melalui

AppCredentials class

  • Referensi
Paket:
botframework-connector

Implementasi dan cache autentikasi AppCredentials umum. Mendukung alur kredensial klien ADAL apa pun. Subkelas dapat mengimplementasikan refreshToken untuk memperoleh token.

Konstruktor

AppCredentials(string, string, string)

Menginisialisasi instans baru AppCredentials.

Properti

appId
oAuthEndpoint

Mendapatkan titik akhir OAuth untuk digunakan. Mengatur titik akhir OAuth yang akan digunakan.
oAuthScope

Mendapatkan cakupan OAuth untuk digunakan. Mengatur cakupan OAuth yang akan digunakan.
tokenCacheKey

Metode

getToken(boolean)

Mendapatkan token akses OAuth.
isTrustedServiceUrl(string)

Memeriksa apakah url layanan adalah untuk host tepercaya atau tidak.
signRequest(WebResource)

Terapkan kredensial ke permintaan HTTP.
trustServiceUrl(string, Date)

Menambahkan host url layanan ke host tepercaya. Jika waktu kedaluwarsa tidak disediakan, tanggal kedaluwarsa akan menjadi tanggal (utc) saat ini + 1 hari.

Detail Konstruktor

AppCredentials(string, string, string)

Menginisialisasi instans baru AppCredentials.

new AppCredentials(appId: string, channelAuthTenant?: string, oAuthScope?: string)

Parameter

appId

string

ID Aplikasi.

channelAuthTenant

string

Fakultatif. Penyewa token oauth.

oAuthScope

string

Cakupan untuk token.

Detail Properti

appId 

appId: string

Nilai Properti

string

oAuthEndpoint

Mendapatkan titik akhir OAuth untuk digunakan. Mengatur titik akhir OAuth yang akan digunakan.

string oAuthEndpoint

Nilai Properti

string

OAuthEndpoint yang akan digunakan.

oAuthScope

Mendapatkan cakupan OAuth untuk digunakan. Mengatur cakupan OAuth yang akan digunakan.

string oAuthScope

Nilai Properti

string

Cakupan OAuth yang akan digunakan.

tokenCacheKey 

tokenCacheKey: string

Nilai Properti

string

Detail Metode

getToken(boolean)

Mendapatkan token akses OAuth.

function getToken(forceRefresh?: boolean): Promise<string>

Parameter

forceRefresh

boolean

Benar untuk memaksa refresh token; atau false untuk mendapatkan token yang di-cache jika ada.

Mengembalikan

Promise<string>

Janji yang mewakili pekerjaan yang diantrekan untuk dijalankan.

Keterangan

Jika janji berhasil, hasilnya berisi string token akses.

isTrustedServiceUrl(string)

Peringatan

API ini sudah tidak digunakan lagi.

Memeriksa apakah url layanan adalah untuk host tepercaya atau tidak.

static function isTrustedServiceUrl(serviceUrl: string): boolean

Parameter

serviceUrl

string

Url layanan

Mengembalikan

boolean

True jika host url layanan tepercaya; Salah jika tidak.

signRequest(WebResource)

Terapkan kredensial ke permintaan HTTP.

function signRequest(webResource: WebResource): Promise<WebResource>

Parameter

webResource

WebResource

Permintaan HTTP WebResource.

Mengembalikan

Promise<WebResource>

Janji yang mewakili operasi asinkron.

trustServiceUrl(string, Date)

Peringatan

API ini sudah tidak digunakan lagi.

Menambahkan host url layanan ke host tepercaya. Jika waktu kedaluwarsa tidak disediakan, tanggal kedaluwarsa akan menjadi tanggal (utc) saat ini + 1 hari.

static function trustServiceUrl(serviceUrl: string, expiration?: Date)

Parameter

serviceUrl

string

Url layanan

expiration

Date