ConfigurationBotFrameworkAuthentication class

Paquete:

botbuilder-core

Crea una instancia de BotFrameworkAuthentication a partir de un objeto con los valores de autenticación o una instancia de Configuration.

Extends

BotFrameworkAuthentication

Constructores

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

Inicializa una nueva instancia de la clase configurationBotFrameworkAuthentication de .

Métodos

authenticateChannelRequest(string)	Autenticar solicitudes de Protocolo de Bot Framework en Aptitudes.
authenticateRequest(Activity, string)	Valide las solicitudes de Protocolo de Bot Framework.
authenticateStreamingRequest(string, string)	Valide las solicitudes de Protocolo de Bot Framework.
createBotFrameworkClient()	Crea un BotFrameworkClient para llamar a Skills.
createConnectorFactory(ClaimsIdentity)	Crea un ConnectorFactory que se puede usar para crear ConnectorClients que pueden usar credenciales de este entorno en la nube concreto.
createUserTokenClient(ClaimsIdentity)	Crea la instancia de UserTokenClient adecuada.

Métodos heredados

getOriginatingAudience()

Obtiene la audiencia de origen del ámbito de Bot OAuth.

Detalles del constructor

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

Inicializa una nueva instancia de la clase configurationBotFrameworkAuthentication de .

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

Parámetros

botFrameworkAuthConfig

ConfigurationBotFrameworkAuthenticationOptions

Objeto ConfigurationBotFrameworkAuthenticationOptions.

credentialsFactory

ServiceClientCredentialsFactory

Instancia de ServiceClientCredentialsFactory.

authConfiguration

AuthenticationConfiguration

Objeto Configuration.

botFrameworkClientFetch

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

Una implementación personalizada de Fetch que se va a usar en elbotFrameworkClient de .

connectorClientOptions

ConnectorClientOptions

Objeto ConnectorClientOptions.

Detalles del método

authenticateChannelRequest(string)

Autenticar solicitudes de Protocolo de Bot Framework en Aptitudes.

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

Parámetros

authHeader

string

Encabezado de autenticación http recibido en la solicitud de aptitud.

Devoluciones

Promise<ClaimsIdentity>

UnClaimsIdentity de .

authenticateRequest(Activity, string)

Valide las solicitudes de Protocolo de Bot Framework.

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

Parámetros

activity

Activity

La actividad entrante.

authHeader

string

Encabezado de autenticación HTTP.

Devoluciones

Promise<AuthenticateRequestResult>

Un AuthenticateRequestResult.

authenticateStreamingRequest(string, string)

Valide las solicitudes de Protocolo de Bot Framework.

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

Parámetros

authHeader

string

Encabezado de autenticación HTTP.

channelIdHeader

string

Encabezado HTTP del identificador de canal.

Devoluciones

Promise<AuthenticateRequestResult>

Un AuthenticateRequestResult.

createBotFrameworkClient()

Crea un BotFrameworkClient para llamar a Skills.

function createBotFrameworkClient(): BotFrameworkClient

Devoluciones

BotFrameworkClient

Un BotFrameworkClient.

createConnectorFactory(ClaimsIdentity)

Crea un ConnectorFactory que se puede usar para crear ConnectorClients que pueden usar credenciales de este entorno en la nube concreto.

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

Parámetros

claimsIdentity

ClaimsIdentity

ClaimsIdentity de la actividad entrante.

Devoluciones

ConnectorFactory

UnConnectorFactory .

createUserTokenClient(ClaimsIdentity)

Crea la instancia de UserTokenClient adecuada.

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

Parámetros

claimsIdentity

ClaimsIdentity

ClaimsIdentity de la actividad entrante.

Devoluciones

Promise<UserTokenClient>

UnuserTokenClient de .

Detalles de los métodos heredados

getOriginatingAudience()

Obtiene la audiencia de origen del ámbito de Bot OAuth.

function getOriginatingAudience(): string

Devoluciones

string

Audiencia de origen.

heredado de BotFrameworkAuthentication.getOriginatingAudience