Compartilhar via

ConfigurationBotFrameworkAuthentication class

  • Referência
Pacote:
botbuilder-core

Cria uma instância BotFrameworkAuthentication de um objeto com os valores de autenticação ou uma instância de Configuração .

Extends

BotFrameworkAuthentication

Construtores

ConfigurationBotFrameworkAuthentication(ConfigurationBotFrameworkAuthenticationOptions, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Inicializa uma nova instância da classe ConfigurationBotFrameworkAuthentication.

Métodos

authenticateChannelRequest(string)

Autenticar solicitações de Protocolo do Bot Framework para Habilidades.
authenticateRequest(Activity, string)

Validar solicitações do Bot Framework Protocol.
authenticateStreamingRequest(string, string)

Validar solicitações do Bot Framework Protocol.
createBotFrameworkClient()

Cria um BotFrameworkClient para chamar habilidades.
createConnectorFactory(ClaimsIdentity)

Cria um ConnectorFactory que pode ser usado para criar ConnectorClients que podem usar credenciais desse ambiente de nuvem específico.
createUserTokenClient(ClaimsIdentity)

Cria a instância userTokenClient apropriada.

Métodos herdados

getOriginatingAudience()

Obtém o público de origem do escopo do Bot OAuth.

Detalhes do construtor

ConfigurationBotFrameworkAuthentication(ConfigurationBotFrameworkAuthenticationOptions, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Inicializa uma nova instância da classe ConfigurationBotFrameworkAuthentication.

new ConfigurationBotFrameworkAuthentication(botFrameworkAuthConfig?: ConfigurationBotFrameworkAuthenticationOptions, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions)

Parâmetros

botFrameworkAuthConfig
ConfigurationBotFrameworkAuthenticationOptions

Um objeto ConfigurationBotFrameworkAuthenticationOptions.

credentialsFactory

ServiceClientCredentialsFactory

Uma instância ServiceClientCredentialsFactory.

authConfiguration

AuthenticationConfiguration

Um objeto de Configuração de .

botFrameworkClientFetch

(input: RequestInfo, init?: RequestInit) => Promise<Response>

Uma implementação personalizada do Fetch a ser usada no BotFrameworkClient.

connectorClientOptions

ConnectorClientOptions

Um objeto ConnectorClientOptions.

Detalhes do método

authenticateChannelRequest(string)

Autenticar solicitações de Protocolo do Bot Framework para Habilidades.

function authenticateChannelRequest(authHeader: string): Promise<ClaimsIdentity>

Parâmetros

authHeader

string

O cabeçalho de autenticação http recebido na solicitação de habilidade.

Retornos

Promise<ClaimsIdentity>

UmclaimsIdentity .

authenticateRequest(Activity, string)

Validar solicitações do Bot Framework Protocol.

function authenticateRequest(activity: Activity, authHeader: string): Promise<AuthenticateRequestResult>

Parâmetros

activity

Activity

A atividade de entrada.

authHeader

string

O cabeçalho de autenticação HTTP.

Retornos

Promise<AuthenticateRequestResult>

UmAuthenticateRequestResult .

authenticateStreamingRequest(string, string)

Validar solicitações do Bot Framework Protocol.

function authenticateStreamingRequest(authHeader: string, channelIdHeader: string): Promise<AuthenticateRequestResult>

Parâmetros

authHeader

string

O cabeçalho de autenticação HTTP.

channelIdHeader

string

O cabeçalho HTTP da ID do canal.

Retornos

Promise<AuthenticateRequestResult>

UmAuthenticateRequestResult .

createBotFrameworkClient()

Cria um BotFrameworkClient para chamar habilidades.

function createBotFrameworkClient(): BotFrameworkClient

Retornos

BotFrameworkClient

Um BotFrameworkClient.

createConnectorFactory(ClaimsIdentity)

Cria um ConnectorFactory que pode ser usado para criar ConnectorClients que podem usar credenciais desse ambiente de nuvem específico.

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

Parâmetros

claimsIdentity

ClaimsIdentity

ClaimsIdentity da atividade de entrada.

Retornos

ConnectorFactory

UmConnectorFactory .

createUserTokenClient(ClaimsIdentity)

Cria a instância userTokenClient apropriada.

function createUserTokenClient(claimsIdentity: ClaimsIdentity): Promise<UserTokenClient>

Parâmetros

claimsIdentity

ClaimsIdentity

ClaimsIdentity da atividade de entrada.

Retornos

Promise<UserTokenClient>

UmUserTokenClient .

Detalhes do método herdado

getOriginatingAudience()

Obtém o público de origem do escopo do Bot OAuth.

function getOriginatingAudience(): string

Retornos

string

O público de origem.

Herdado de BotFrameworkAuthentication.getOriginatingAudience