Condividi tramite

AppCredentials class

  • Riferimento
Pacchetto:
botframework-connector

Implementazione e cache di autenticazione di AppCredentials generali. Supporta qualsiasi flusso di credenziali client ADAL. Le sottoclassi possono implementare refreshToken per acquisire il token.

Costruttori

AppCredentials(string, string, string)

Inizializza una nuova istanza della classe AppCredentials.

Proprietà

appId
oAuthEndpoint

Ottiene l'endpoint OAuth da usare. Imposta l'endpoint OAuth da usare.
oAuthScope

Ottiene l'ambito OAuth da usare. Imposta l'ambito OAuth da usare.
tokenCacheKey

Metodi

getToken(boolean)

Ottiene un token di accesso OAuth.
isTrustedServiceUrl(string)

Controlla se l'URL del servizio è per un host attendibile o meno.
signRequest(WebResource)

Applicare le credenziali alla richiesta HTTP.
trustServiceUrl(string, Date)

Aggiunge l'host dell'URL del servizio agli host attendibili. Se non viene specificata l'ora di scadenza, la data di scadenza sarà la data corrente (utc) + 1 giorno.

Dettagli costruttore

AppCredentials(string, string, string)

Inizializza una nuova istanza della classe AppCredentials.

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

Parametri

appId

string

ID app.

channelAuthTenant

string

Opzionale. Tenant del token oauth.

oAuthScope

string

Ambito del token.

Dettagli proprietà

appId 

appId: string

Valore della proprietà

string

oAuthEndpoint

Ottiene l'endpoint OAuth da usare. Imposta l'endpoint OAuth da usare.

string oAuthEndpoint

Valore della proprietà

string

Oggetto OAuthEndpoint da usare.

oAuthScope

Ottiene l'ambito OAuth da usare. Imposta l'ambito OAuth da usare.

string oAuthScope

Valore della proprietà

string

Ambito OAuth da usare.

tokenCacheKey 

tokenCacheKey: string

Valore della proprietà

string

Dettagli metodo

getToken(boolean)

Ottiene un token di accesso OAuth.

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

Parametri

forceRefresh

boolean

True per forzare un aggiornamento del token; o false per ottenere un token memorizzato nella cache, se esistente.

Restituisce

Promise<string>

Promessa che rappresenta il lavoro in coda da eseguire.

Commenti

Se la promessa ha esito positivo, il risultato contiene la stringa del token di accesso.

isTrustedServiceUrl(string)

Avviso

Questa API è ora deprecata.

Controlla se l'URL del servizio è per un host attendibile o meno.

static function isTrustedServiceUrl(serviceUrl: string): boolean

Parametri

serviceUrl

string

URL del servizio

Restituisce

boolean

True se l'host dell'URL del servizio è attendibile; False in caso contrario.

signRequest(WebResource)

Applicare le credenziali alla richiesta HTTP.

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

Parametri

webResource

WebResource

Richiesta HTTP WebResource.

Restituisce

Promise<WebResource>

Promessa che rappresenta l'operazione asincrona.

trustServiceUrl(string, Date)

Avviso

Questa API è ora deprecata.

Aggiunge l'host dell'URL del servizio agli host attendibili. Se non viene specificata l'ora di scadenza, la data di scadenza sarà la data corrente (utc) + 1 giorno.

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

Parametri

serviceUrl

string

URL del servizio

expiration

Date