Condividi tramite

MicrosoftAppCredentials class

  • Riferimento
Pacchetto:
botframework-connector

Implementazione dell'autenticazione di MicrosoftAppCredentials

Extends
AppCredentials

Costruttori

MicrosoftAppCredentials(string, string, string, string)

Inizializza una nuova istanza della classe MicrosoftAppCredentials.

Proprietà

appPassword
Empty

Set vuoto di credenziali.
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.

Proprietà ereditate

appId
tokenCacheKey

Metodi ereditati

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

MicrosoftAppCredentials(string, string, string, string)

Inizializza una nuova istanza della classe MicrosoftAppCredentials.

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

Parametri

appId

string

ID app Microsoft.

appPassword

string

Password dell'app Microsoft.

channelAuthTenant

string

Opzionale. Tenant del token oauth.

oAuthScope

string

Opzionale. Ambito del token.

Dettagli proprietà

appPassword 

appPassword: string

Valore della proprietà

string

Empty

Set vuoto di credenziali.

static Empty: MicrosoftAppCredentials

Valore della proprietà

MicrosoftAppCredentials

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.

Dettagli proprietà ereditate

appId 

appId: string

Valore della proprietà

string

ereditato daAppCredentials.appId

tokenCacheKey 

tokenCacheKey: string

Valore della proprietà

string

Ereditato daAppCredentials.tokenCacheKey

Dettagli dei metodi ereditati

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.

ereditato daAppCredentials.getToken

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.

ereditato daAppCredentials.isTrustedServiceUrl

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.

ereditato daAppCredentials.signRequest

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

ereditato daAppCredentials.trustServiceUrl