MicrosoftAppCredentials class

Paket:

botframework-connector

Implementasi autentikasi MicrosoftAppCredentials

Memperluas

AppCredentials

Konstruktor

MicrosoftAppCredentials(string, string, string, string)

Menginisialisasi instans baru kelas MicrosoftAppCredentials.

Properti

appPassword
Empty	Sekumpulan kredensial kosong.
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.

Properti yang Diwariskan

appId
tokenCacheKey

Metode yang Diwarisi

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

MicrosoftAppCredentials(string, string, string, string)

Menginisialisasi instans baru kelas MicrosoftAppCredentials.

new MicrosoftAppCredentials(appId: string, appPassword: string, channelAuthTenant?: string, oAuthScope?: string)

Parameter

appId

string

ID aplikasi Microsoft.

appPassword

string

Kata sandi aplikasi Microsoft.

channelAuthTenant

string

Fakultatif. Penyewa token oauth.

oAuthScope

string

Fakultatif. Cakupan untuk token.

Detail Properti

appPassword

appPassword: string

Nilai Properti

string

Empty

Sekumpulan kredensial kosong.

static Empty: MicrosoftAppCredentials

Nilai Properti

MicrosoftAppCredentials

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.

Detail Properti yang Diwariskan

appId

appId: string

Nilai Properti

string

Diwarisi DariAppCredentials.appId

tokenCacheKey

tokenCacheKey: string

Nilai Properti

string

Diwariskan DariAppCredentials.tokenCacheKey

Detail Metode yang Diwarisi

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.

Diwariskan DariAppCredentials.getToken

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.

Diwarisi DariAppCredentials.isTrustedServiceUrl

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.

Diwarisi DariAppCredentials.signRequest

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

Diwariskan DariAppCredentials.trustServiceUrl