Partager via

AppCredentials class

  • Référence
Paquet:
botframework-connector

Implémentation et cache d’authentification AppCredentials générales. Prend en charge tout flux d’informations d’identification du client ADAL. Les sous-classes peuvent implémenter refreshToken pour acquérir le jeton.

Constructeurs

AppCredentials(string, string, string)

Initialise une nouvelle instance de la classe AppCredentials.

Propriétés

appId
oAuthEndpoint

Obtient le point de terminaison OAuth à utiliser. Définit le point de terminaison OAuth à utiliser.
oAuthScope

Obtient l’étendue OAuth à utiliser. Définit l’étendue OAuth à utiliser.
tokenCacheKey

Méthodes

getToken(boolean)

Obtient un jeton d’accès OAuth.
isTrustedServiceUrl(string)

Vérifie si l’URL du service est pour un hôte approuvé ou non.
signRequest(WebResource)

Appliquez les informations d’identification à la requête HTTP.
trustServiceUrl(string, Date)

Ajoute l’hôte de l’URL du service aux hôtes approuvés. Si l’heure d’expiration n’est pas fournie, la date d’expiration est la date actuelle (utc) + 1 jour.

Détails du constructeur

AppCredentials(string, string, string)

Initialise une nouvelle instance de la classe AppCredentials.

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

Paramètres

appId

string

ID d’application.

channelAuthTenant

string

Optionnel. Locataire de jeton oauth.

oAuthScope

string

Étendue du jeton.

Détails de la propriété

appId 

appId: string

Valeur de propriété

string

oAuthEndpoint

Obtient le point de terminaison OAuth à utiliser. Définit le point de terminaison OAuth à utiliser.

string oAuthEndpoint

Valeur de propriété

string

OAuthEndpoint à utiliser.

oAuthScope

Obtient l’étendue OAuth à utiliser. Définit l’étendue OAuth à utiliser.

string oAuthScope

Valeur de propriété

string

Étendue OAuth à utiliser.

tokenCacheKey 

tokenCacheKey: string

Valeur de propriété

string

Détails de la méthode

getToken(boolean)

Obtient un jeton d’accès OAuth.

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

Paramètres

forceRefresh

boolean

True pour forcer une actualisation du jeton ; ou false pour obtenir un jeton mis en cache s’il existe.

Retours

Promise<string>

Promesse qui représente le travail mis en file d’attente à exécuter.

Remarques

Si la promesse réussit, le résultat contient la chaîne de jeton d’accès.

isTrustedServiceUrl(string)

Avertissement

Cette API est à présent déconseillée.

Vérifie si l’URL du service est pour un hôte approuvé ou non.

static function isTrustedServiceUrl(serviceUrl: string): boolean

Paramètres

serviceUrl

string

URL du service

Retours

boolean

True si l’hôte de l’URL du service est approuvé ; False sinon.

signRequest(WebResource)

Appliquez les informations d’identification à la requête HTTP.

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

Paramètres

webResource

WebResource

Requête HTTP WebResource.

Retours

Promise<WebResource>

Promesse représentant l’opération asynchrone.

trustServiceUrl(string, Date)

Avertissement

Cette API est à présent déconseillée.

Ajoute l’hôte de l’URL du service aux hôtes approuvés. Si l’heure d’expiration n’est pas fournie, la date d’expiration est la date actuelle (utc) + 1 jour.

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

Paramètres

serviceUrl

string

URL du service

expiration

Date