Compartilhar via

ParameterizedBotFrameworkAuthentication class

  • Referência
Pacote:
botframework-connector
Extends
BotFrameworkAuthentication

Construtores

ParameterizedBotFrameworkAuthentication(boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Métodos

authenticateChannelRequest(string)
authenticateRequest(Activity, string)

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

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

Cria um BotFrameworkClient usado 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.
getOriginatingAudience()

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

Detalhes do construtor

ParameterizedBotFrameworkAuthentication(boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions) 

new ParameterizedBotFrameworkAuthentication(validateAuthority: boolean, toChannelFromBotLoginUrl: string, toChannelFromBotOAuthScope: string, toBotFromChannelTokenIssuer: string, oAuthUrl: string, toBotFromChannelOpenIdMetadataUrl: string, toBotFromEmulatorOpenIdMetadataUrl: string, callerId: string, credentialsFactory: ServiceClientCredentialsFactory, authConfiguration: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions)

Parâmetros

validateAuthority

boolean

O valor de autoridade de validação a ser usado.

toChannelFromBotLoginUrl

string

A url de logon do canal para o canal do bot.

toChannelFromBotOAuthScope

string

O canal para o escopo do bot oauth.

toBotFromChannelTokenIssuer

string

O bot para o emissor do token de canal.

oAuthUrl

string

A URL do OAuth.

toBotFromChannelOpenIdMetadataUrl

string

A url de metadados para bot do Channel Open ID.

toBotFromEmulatorOpenIdMetadataUrl

string

A url de metadados para bot do Emulador Open ID.

callerId

string

O callerId definido em umade atividades de autenticada.

credentialsFactory
ServiceClientCredentialsFactory

O ServiceClientCredentialsFactory a ser usado para criar credenciais.

authConfiguration
AuthenticationConfiguration

O AuthenticationConfiguration a ser usado.

botFrameworkClientFetch

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

A busca a ser usada no BotFrameworkClient.

connectorClientOptions
ConnectorClientOptions

O ConnectorClientOptions a ser usado ao criar ConnectorClients.

Detalhes do método

authenticateChannelRequest(string) 

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>

O resultado da validação de identidade.

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 recebido na solicitação de habilidade.

Retornos

Promise<AuthenticateRequestResult>

Prometa com AuthenticateRequestResult.

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 recebido na solicitação de habilidade.

channelIdHeader

string

O cabeçalho HTTP da ID do canal.

Retornos

Promise<AuthenticateRequestResult>

Prometa com AuthenticateRequestResult.

createBotFrameworkClient()

Cria um BotFrameworkClient usado para chamar habilidades.

function createBotFrameworkClient(): BotFrameworkClient

Retornos

BotFrameworkClient

Uma instância de BotFrameworkClient para chamar Skills.

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

Um ConnectorFactory.

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>

Prometa com a instância userTokenClient.

getOriginatingAudience()

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

function getOriginatingAudience(): string

Retornos

string

O público de origem.