Partager via

ParameterizedBotFrameworkAuthentication class

  • Référence
Paquet:
botframework-connector
Extends
BotFrameworkAuthentication

Constructeurs

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

Méthodes

authenticateChannelRequest(string)
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 utilisé 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.
getOriginatingAudience()

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

Détails du constructeur

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)

Paramètres

validateAuthority

boolean

Valeur de l’autorité de validation à utiliser.

toChannelFromBotLoginUrl

string

Canal à partir de l’URL de connexion du bot.

toChannelFromBotOAuthScope

string

Canal à partir de l’étendue oauth du bot.

toBotFromChannelTokenIssuer

string

Bot à partir de l’émetteur de jeton de canal.

oAuthUrl

string

URL OAuth.

toBotFromChannelOpenIdMetadataUrl

string

Url des métadonnées d’OPEN ID de canal à partir du bot.

toBotFromEmulatorOpenIdMetadataUrl

string

Url des métadonnées open ID de l’émulateur.

callerId

string

L’callerId défini sur une Activités authentifiées.

credentialsFactory
ServiceClientCredentialsFactory

Le ServiceClientCredentialsFactory à utiliser pour créer des informations d’identification.

authConfiguration
AuthenticationConfiguration

AuthenticationConfiguration à utiliser.

botFrameworkClientFetch

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

Extraction à utiliser dans BotFrameworkClient.

connectorClientOptions
ConnectorClientOptions

Les ConnectorClientOptions à utiliser lors de la création de ConnectorClients.

Détails de la méthode

authenticateChannelRequest(string) 

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>

Résultat de la validation d’identité.

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 reçu dans la demande de compétence.

Retours

Promise<AuthenticateRequestResult>

Promesse avec 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 reçu dans la demande de compétence.

channelIdHeader

string

En-tête HTTP ID de canal.

Retours

Promise<AuthenticateRequestResult>

Promesse avec AuthenticateRequestResult.

createBotFrameworkClient()

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

function createBotFrameworkClient(): BotFrameworkClient

Retours

BotFrameworkClient

Instance BotFrameworkClient pour appeler Skills.

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

A 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>

Promesse avec l’instance UserTokenClient.

getOriginatingAudience()

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

function getOriginatingAudience(): string

Retours

string

Public d’origine.