MicrosoftAppCredentials class

Paket:

botframework-connector

Implementierung der MicrosoftAppCredentials-Authentifizierung

Extends

AppCredentials

Konstruktoren

MicrosoftAppCredentials(string, string, string, string)

Initialisiert eine neue Instanz der MicrosoftAppCredentials-Klasse .

Eigenschaften

appPassword
Empty	Ein leerer Satz von Anmeldeinformationen.
oAuthEndpoint	Ruft den zu verwendenden OAuth-Endpunkt ab. Legt den zu verwendenden OAuth-Endpunkt fest.
oAuthScope	Ruft den zu verwendenden OAuth-Bereich ab. Legt den zu verwendenden OAuth-Bereich fest.

Geerbte Eigenschaften

appId
tokenCacheKey

Geerbte Methoden

getToken(boolean)	Ruft ein OAuth-Zugriffstoken ab.
isTrustedServiceUrl(string)	Überprüft, ob die Dienst-URL für einen vertrauenswürdigen Host steht oder nicht.
signRequest(WebResource)	Wenden Sie die Anmeldeinformationen auf die HTTP-Anforderung an.
trustServiceUrl(string, Date)	Fügt die Host-Dienst-URL zu vertrauenswürdigen Hosts hinzu. Wenn keine Ablaufzeit angegeben ist, ist das Ablaufdatum das aktuelle Datum (utc) + 1 Tag.

Details zum Konstruktor

MicrosoftAppCredentials(string, string, string, string)

Initialisiert eine neue Instanz der MicrosoftAppCredentials-Klasse .

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

Parameter

appId

string

Die Microsoft-App-ID.

appPassword

string

Das Microsoft-App-Kennwort.

channelAuthTenant

string

Optional. Der oauth-Tokenmandant.

oAuthScope

string

Optional. Der Bereich für das Token.

Details zur Eigenschaft

appPassword

appPassword: string

Eigenschaftswert

string

Empty

Ein leerer Satz von Anmeldeinformationen.

static Empty: MicrosoftAppCredentials

Eigenschaftswert

MicrosoftAppCredentials

oAuthEndpoint

Ruft den zu verwendenden OAuth-Endpunkt ab. Legt den zu verwendenden OAuth-Endpunkt fest.

string oAuthEndpoint

Eigenschaftswert

string

Der zu verwendende OAuthEndpoint.

oAuthScope

Ruft den zu verwendenden OAuth-Bereich ab. Legt den zu verwendenden OAuth-Bereich fest.

string oAuthScope

Eigenschaftswert

string

Der zu verwendende OAuth-Bereich.

Geerbte Eigenschaftsdetails

appId

appId: string

Eigenschaftswert

string

Geerbt vonAppCredentials.appId

tokenCacheKey

tokenCacheKey: string

Eigenschaftswert

string

Geerbt vonAppCredentials.tokenCacheKey

Details zur geerbten Methode

getToken(boolean)

Ruft ein OAuth-Zugriffstoken ab.

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

Parameter

forceRefresh

boolean

True, um eine Aktualisierung des Tokens zu erzwingen; oder false, um ein zwischengespeichertes Token abzurufen, sofern es vorhanden ist.

Gibt zurück

Promise<string>

Eine Zusage, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

Wenn die Zusage erfolgreich ist, enthält das Ergebnis die Zugriffstokenzeichenfolge.

Geerbt vonAppCredentials.getToken

isTrustedServiceUrl(string)

Warnung

Diese API ist nun veraltet.

Überprüft, ob die Dienst-URL für einen vertrauenswürdigen Host steht oder nicht.

static function isTrustedServiceUrl(serviceUrl: string): boolean

Parameter

serviceUrl

string

Die Dienst-URL

Gibt zurück

boolean

True, wenn der Host der Dienst-URL vertrauenswürdig ist; False andernfalls.

Geerbt vonAppCredentials.isTrustedServiceUrl

signRequest(WebResource)

Wenden Sie die Anmeldeinformationen auf die HTTP-Anforderung an.

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

Parameter

webResource

WebResource

Die WebResource-HTTP-Anforderung.

Gibt zurück

Promise<WebResource>

Eine Zusage, die den asynchronen Vorgang darstellt.

Geerbt vonAppCredentials.signRequest

trustServiceUrl(string, Date)

Warnung

Diese API ist nun veraltet.

Fügt die Host-Dienst-URL zu vertrauenswürdigen Hosts hinzu. Wenn keine Ablaufzeit angegeben ist, ist das Ablaufdatum das aktuelle Datum (utc) + 1 Tag.

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

Parameter

serviceUrl

string

Die Dienst-URL

expiration

Date

Geerbt vonAppCredentials.trustServiceUrl