Partager via

ConfigurationBotFrameworkAuthentication class

  • Référence
Paquet:
botbuilder-core

Crée une instance BotFrameworkAuthentication à partir d’un objet avec les valeurs d’authentification ou une instance Configuration.

Extends

BotFrameworkAuthentication

Constructeurs

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

Initialise une nouvelle instance de la classe ConfigurationBotFrameworkAuthentication.

Méthodes

authenticateChannelRequest(string)

Authentifiez les demandes du protocole Bot Framework auprès de Compétences.
authenticateRequest(Activity, string)

Valider les demandes du protocole Bot Framework.
authenticateStreamingRequest(string, string)

Valider les demandes du protocole Bot Framework.
createBotFrameworkClient()

Crée un BotFrameworkClient pour appeler des compétences.
createConnectorFactory(ClaimsIdentity)

Crée un ConnectorFactory qui peut être utilisé pour créer ConnectorClients qui peut utiliser des informations d’identification à partir de cet environnement cloud particulier.
createUserTokenClient(ClaimsIdentity)

Crée l’instance UserTokenClient appropriée.

Méthodes héritées

getOriginatingAudience()

Obtient l’audience d’origine à partir de l’étendue OAuth du bot.

Détails du constructeur

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

Initialise une nouvelle instance de la classe ConfigurationBotFrameworkAuthentication.

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

Paramètres

botFrameworkAuthConfig
ConfigurationBotFrameworkAuthenticationOptions

Objet ConfigurationBotFrameworkAuthenticationOptions.

credentialsFactory

ServiceClientCredentialsFactory

Instance ServiceClientCredentialsFactory.

authConfiguration

AuthenticationConfiguration

Objet Configuration.

botFrameworkClientFetch

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

Implémentation fetch personnalisée à utiliser dans le BotFrameworkClient.

connectorClientOptions

ConnectorClientOptions

Objet ConnectorClientOptions.

Détails de la méthode

authenticateChannelRequest(string)

Authentifiez les demandes du protocole Bot Framework auprès de Compétences.

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

Paramètres

authHeader

string

En-tête d’authentification http reçu dans la demande de compétence.

Retours

Promise<ClaimsIdentity>

ClaimsIdentity.

authenticateRequest(Activity, string)

Valider les demandes du protocole Bot Framework.

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

Paramètres

activity

Activity

Activité entrante.

authHeader

string

En-tête d’authentification HTTP.

Retours

Promise<AuthenticateRequestResult>

Un AuthenticateRequestResult.

authenticateStreamingRequest(string, string)

Valider les demandes du protocole Bot Framework.

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

Paramètres

authHeader

string

En-tête d’authentification HTTP.

channelIdHeader

string

En-tête HTTP DE l’ID de canal.

Retours

Promise<AuthenticateRequestResult>

Un AuthenticateRequestResult.

createBotFrameworkClient()

Crée un BotFrameworkClient pour appeler des compétences.

function createBotFrameworkClient(): BotFrameworkClient

Retours

BotFrameworkClient

Un BotFrameworkClient.

createConnectorFactory(ClaimsIdentity)

Crée un ConnectorFactory qui peut être utilisé pour créer ConnectorClients qui peut utiliser des informations d’identification à partir de cet environnement cloud particulier.

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

Paramètres

claimsIdentity

ClaimsIdentity

ClaimsIdentity de l’activité entrante.

Retours

ConnectorFactory

ConnectorFactory.

createUserTokenClient(ClaimsIdentity)

Crée l’instance UserTokenClient appropriée.

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

Paramètres

claimsIdentity

ClaimsIdentity

ClaimsIdentity de l’activité entrante.

Retours

Promise<UserTokenClient>

Un UserTokenClient.

Détails de la méthode héritée

getOriginatingAudience()

Obtient l’audience d’origine à partir de l’étendue OAuth du bot.

function getOriginatingAudience(): string

Retours

string

Public d’origine.

héritée de BotFrameworkAuthentication.getOriginatingAudience