CloudAdapter class

  • Référence
Paquet:
botbuilder

Adaptateur qui implémente le protocole Bot Framework et peut être hébergé dans différents environnements cloud, publics et privés.

Extends

CloudAdapterBase

Constructeurs

CloudAdapter(BotFrameworkAuthentication)

Initialise une nouvelle instance de la classe CloudAdapter .

Propriétés héritées

BotIdentityKey
ConnectorClientKey
ConnectorFactoryKey
OAuthScopeKey
onTurnError
UserTokenClientKey

Méthodes

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

Utilisé pour connecter l’adaptateur à un canal nommé.
process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Gérez une connexion de socket web en appliquant une fonction logique à chaque demande de streaming.
process(Request, Response, (context: TurnContext) => Promise<void>)

Traiter une requête web en appliquant une fonction logique.

Méthodes héritées

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)
continueConversationAsync(string | ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> | string, (context: TurnContext) => Promise<void>)
createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>)
deleteActivity(TurnContext, Partial<ConversationReference>)
sendActivities(TurnContext, Partial<Activity>[])
updateActivity(TurnContext, Partial<Activity>)
use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

Ajoute un intergiciel au pipeline de l’adaptateur.

Détails du constructeur

CloudAdapter(BotFrameworkAuthentication)

Initialise une nouvelle instance de la classe CloudAdapter .

new CloudAdapter(botFrameworkAuthentication?: BotFrameworkAuthentication)

Paramètres

botFrameworkAuthentication

BotFrameworkAuthentication

Instance BotFrameworkAuthentication facultative

Détails de la propriété héritée

BotIdentityKey 

BotIdentityKey: symbol

Valeur de propriété

symbol

Hérité de BotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

Valeur de propriété

symbol

Hérité de BotAdapter.ConnectorClientKey

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Valeur de propriété

symbol

Hérité de CloudAdapterBase.ConnectorFactoryKey

OAuthScopeKey 

OAuthScopeKey: symbol

Valeur de propriété

symbol

Hérité de BotAdapter.OAuthScopeKey

onTurnError 

onTurnError: (context: TurnContext, error: Error) => Promise<void>

Valeur de propriété

(context: TurnContext, error: Error) => Promise<void>

Hérité de BotAdapter.onTurnError

UserTokenClientKey 

UserTokenClientKey: symbol

Valeur de propriété

symbol

Hérité de CloudAdapterBase.UserTokenClientKey

Détails de la méthode

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

Utilisé pour connecter l’adaptateur à un canal nommé.

function connectNamedPipe(pipeName: string, logic: (context: TurnContext) => Promise<void>, appId: string, audience: string, callerId?: string, retryCount?: number): Promise<void>

Paramètres

pipeName

string

Nom du canal auquel se connecter (remarque : génère deux serveurs de canal nommés en ajoutant .incoming » et « .outgoing » à ce nom)

logic

(context: TurnContext) => Promise<void>

La fonction logique à appeler pour les tours de bot résultants.

appId

string

ID d’application bot

audience

string

Audience à utiliser pour la communication sortante. Le varie en fonction de l’environnement cloud.

callerId

string

Facultatif, l’ID de l’appelant

retryCount

number

Facultatif, le nombre de fois où une nouvelle tentative de connexion a échoué (la valeur par défaut est 7)

Retours

Promise<void>

process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Gérez une connexion de socket web en appliquant une fonction logique à chaque demande de streaming.

function process(req: Request, socket: INodeSocket, head: INodeBuffer, logic: (context: TurnContext) => Promise<void>): Promise<void>

Paramètres

req
Request

Requête HTTP entrante

socket

INodeSocket

INodeSocket correspondant

head

INodeBuffer

INodeBuffer correspondant

logic

(context: TurnContext) => Promise<void>

Fonction logique à appliquer

Retours

Promise<void>

promesse représentant l’opération asynchrone.

process(Request, Response, (context: TurnContext) => Promise<void>)

Traiter une requête web en appliquant une fonction logique.

function process(req: Request, res: Response, logic: (context: TurnContext) => Promise<void>): Promise<void>

Paramètres

req
Request

Réponse HTTP correspondante

res
Response
logic

(context: TurnContext) => Promise<void>

Fonction logique à appliquer

Retours

Promise<void>

promesse représentant l’opération asynchrone.

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

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)

Avertissement

Cette API est à présent déconseillée.

function continueConversation(_reference: Partial<ConversationReference>, _logic: (context: TurnContext) => Promise<void>): Promise<void>

Paramètres

_reference

Partial<ConversationReference>

_logic

(context: TurnContext) => Promise<void>

Retours

Promise<void>

Hérité de CloudAdapterBase.continueConversation

continueConversationAsync(string | ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> | string, (context: TurnContext) => Promise<void>) 

function continueConversationAsync(botAppIdOrClaimsIdentity: string | ClaimsIdentity, reference: Partial<ConversationReference>, logicOrAudience: (context: TurnContext) => Promise<void> | string, maybeLogic?: (context: TurnContext) => Promise<void>): Promise<void>

Paramètres

botAppIdOrClaimsIdentity

string | ClaimsIdentity

reference

Partial<ConversationReference>

logicOrAudience

(context: TurnContext) => Promise<void> | string

maybeLogic

(context: TurnContext) => Promise<void>

Retours

Promise<void>

Hérité de CloudAdapterBase.continueConversationAsync

createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>) 

function createConversationAsync(botAppId: string, channelId: string, serviceUrl: string, audience: string, conversationParameters: ConversationParameters, logic: (context: TurnContext) => Promise<void>): Promise<void>

Paramètres

botAppId

string

channelId

string

serviceUrl

string

audience

string

conversationParameters

ConversationParameters

logic

(context: TurnContext) => Promise<void>

Retours

Promise<void>

Hérité de CloudAdapterBase.createConversationAsync

deleteActivity(TurnContext, Partial<ConversationReference>) 

function deleteActivity(context: TurnContext, reference: Partial<ConversationReference>): Promise<void>

Paramètres

context

TurnContext

reference

Partial<ConversationReference>

Retours

Promise<void>

Hérité de CloudAdapterBase.deleteActivity

sendActivities(TurnContext, Partial<Activity>[]) 

function sendActivities(context: TurnContext, activities: Partial<Activity>[]): Promise<ResourceResponse[]>

Paramètres

context

TurnContext

activities

Partial<Activity>[]

Retours

Promise<ResourceResponse[]>

Hérité de CloudAdapterBase.sendActivities

updateActivity(TurnContext, Partial<Activity>) 

function updateActivity(context: TurnContext, activity: Partial<Activity>): Promise<ResourceResponse | void>

Paramètres

context

TurnContext

activity

Partial<Activity>

Retours

Promise<ResourceResponse | void>

Hérité de CloudAdapterBase.updateActivity

use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

Ajoute un intergiciel au pipeline de l’adaptateur.

function use(middlewares: (context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]): this

Paramètres

middlewares

(context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]

Les gestionnaires d’intergiciels ou d’intergiciels à ajouter.

Retours

this

Objet adaptateur mis à jour.

Remarques

Le middleware est ajouté à l’adaptateur au moment de l’initialisation. Chaque tour, l’adaptateur appelle son intergiciel dans l’ordre dans lequel vous l’avez ajouté.

Hérité de BotAdapter.use