Compartilhar via

MicrosoftAppCredentials class

  • Referência
Pacote:
botframework-connector

Implementação de autenticação do MicrosoftAppCredentials

Extends
AppCredentials

Construtores

MicrosoftAppCredentials(string, string, string, string)

Inicializa uma nova instância da classe MicrosoftAppCredentials.

Propriedades

appPassword
Empty

Um conjunto vazio de credenciais.
oAuthEndpoint

Obtém o ponto de extremidade OAuth a ser usado. Define o ponto de extremidade OAuth a ser usado.
oAuthScope

Obtém o escopo OAuth a ser usado. Define o escopo OAuth a ser usado.

Propriedades herdadas

appId
tokenCacheKey

Métodos herdados

getToken(boolean)

Obtém um token de acesso OAuth.
isTrustedServiceUrl(string)

Verifica se a URL do serviço é para um host confiável ou não.
signRequest(WebResource)

Aplique as credenciais à solicitação HTTP.
trustServiceUrl(string, Date)

Adiciona o host da URL de serviço a hosts confiáveis. Se a hora de expiração não for fornecida, a data de validade será atual (utc) data + 1 dia.

Detalhes do construtor

MicrosoftAppCredentials(string, string, string, string)

Inicializa uma nova instância da classe MicrosoftAppCredentials.

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

Parâmetros

appId

string

A ID do aplicativo da Microsoft.

appPassword

string

A senha do aplicativo da Microsoft.

channelAuthTenant

string

Opcional. O locatário do token oauth.

oAuthScope

string

Opcional. O escopo do token.

Detalhes da propriedade

appPassword 

appPassword: string

Valor da propriedade

string

Empty

Um conjunto vazio de credenciais.

static Empty: MicrosoftAppCredentials

Valor da propriedade

MicrosoftAppCredentials

oAuthEndpoint

Obtém o ponto de extremidade OAuth a ser usado. Define o ponto de extremidade OAuth a ser usado.

string oAuthEndpoint

Valor da propriedade

string

O OAuthEndpoint a ser usado.

oAuthScope

Obtém o escopo OAuth a ser usado. Define o escopo OAuth a ser usado.

string oAuthScope

Valor da propriedade

string

O escopo OAuth a ser usado.

Detalhes das propriedades herdadas

appId 

appId: string

Valor da propriedade

string

Herdado deAppCredentials.appId

tokenCacheKey 

tokenCacheKey: string

Valor da propriedade

string

herdado deappCredentials.tokenCacheKey

Detalhes do método herdado

getToken(boolean)

Obtém um token de acesso OAuth.

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

Parâmetros

forceRefresh

boolean

True para forçar uma atualização do token; ou false para obter um token armazenado em cache se ele existir.

Retornos

Promise<string>

Uma promessa que representa o trabalho enfileirado a ser executado.

Comentários

Se a promessa for bem-sucedida, o resultado conterá a cadeia de caracteres de token de acesso.

herdado deAppCredentials.getToken

isTrustedServiceUrl(string)

Aviso

Essa API foi preterida.

Verifica se a URL do serviço é para um host confiável ou não.

static function isTrustedServiceUrl(serviceUrl: string): boolean

Parâmetros

serviceUrl

string

A URL do serviço

Retornos

boolean

True se o host da URL de serviço for confiável; False caso contrário.

Herdado deAppCredentials.isTrustedServiceUrl

signRequest(WebResource)

Aplique as credenciais à solicitação HTTP.

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

Parâmetros

webResource

WebResource

A solicitação HTTP do WebResource.

Retornos

Promise<WebResource>

Uma promessa que representa a operação assíncrona.

herdado de AppCredentials.signRequest

trustServiceUrl(string, Date)

Aviso

Essa API foi preterida.

Adiciona o host da URL de serviço a hosts confiáveis. Se a hora de expiração não for fornecida, a data de validade será atual (utc) data + 1 dia.

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

Parâmetros

serviceUrl

string

A URL do serviço

expiration

Date

Herdado deAppCredentials.trustServiceUrl