CloudChannelServiceHandler class

Paquet:

botbuilder

Classe permettant d’aider à implémenter le protocole Bot Framework à l’aide de BotFrameworkAuthentication.

Extends

ChannelServiceHandlerBase

Constructeurs

CloudChannelServiceHandler(BotFrameworkAuthentication)

Méthodes héritées

handleCreateConversation(string, ConversationParameters)	Crée une conversation.
handleDeleteActivity(string, string, string)	Supprime und’activité existant.
handleDeleteConversationMember(string, string, string)	Supprime un membre d’une conversation.
handleGetActivityMembers(string, string, string)	Énumère les membres d’uned’activité .
handleGetConversationMember(string, string, string)	Obtient le compte d’un seul membre de conversation.
handleGetConversationMembers(string, string)	Énumère les membres d’une conversation.
handleGetConversationPagedMembers(string, string, number, string)	Énumère les membres d’une conversation d’une page à la fois.
handleGetConversations(string, string, string)	Répertorie les conversations dans lesquelles le bot a participé.
handleReplyToActivity(string, string, string, Activity)	Envoie une réponse à uned’activité .
handleSendConversationHistory(string, string, Transcript)	Charge les activités historiques de la conversation.
handleSendToConversation(string, string, Activity)	Envoie une d’activité à la fin d’une conversation.
handleUpdateActivity(string, string, string, Activity)	Modifie und’activité déjà envoyé.
handleUploadAttachment(string, string, AttachmentData)	Stocke les données dans un magasin conforme lors de la gestion des entreprises.

Détails du constructeur

CloudChannelServiceHandler(BotFrameworkAuthentication)

new CloudChannelServiceHandler(auth: BotFrameworkAuthentication)

Paramètres

auth

BotFrameworkAuthentication

Authentification bot framework

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

handleCreateConversation(string, ConversationParameters)

Crée une conversation.

function handleCreateConversation(authHeader: string, parameters: ConversationParameters): Promise<ConversationResourceResponse>

Paramètres

authHeader

string

En-tête d’authentification.

parameters

ConversationParameters

(xref :botbuilder-core. ConversationParameters) pour créer la conversation à partir de.

Retours

Promise<ConversationResourceResponse>

Représentation Promise pour l’opération.

héritée deChannelServiceHandlerBase.handleCreateConversation

handleDeleteActivity(string, string, string)

Supprime und’activité existant.

function handleDeleteActivity(authHeader: string, conversationId: string, activityId: string): Promise<void>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

activityId

string

ID d’activité à supprimer.

Retours

Promise<void>

héritée deChannelServiceHandlerBase.handleDeleteActivity

handleDeleteConversationMember(string, string, string)

Supprime un membre d’une conversation.

function handleDeleteConversationMember(authHeader: string, conversationId: string, memberId: string): Promise<void>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

memberId

string

ID du membre à supprimer de cette conversation.

Retours

Promise<void>

héritée deChannelServiceHandlerBase.handleDeleteConversationMember

handleGetActivityMembers(string, string, string)

Énumère les membres d’uned’activité .

function handleGetActivityMembers(authHeader: string, conversationId: string, activityId: string): Promise<ChannelAccount[]>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

activityId

string

ID d’activité.

Retours

Promise<ChannelAccount[]>

Liste de ChannelAccount énumérée.

héritée deChannelServiceHandlerBase.handleGetActivityMembers

handleGetConversationMember(string, string, string)

Obtient le compte d’un seul membre de conversation.

function handleGetConversationMember(authHeader: string, userId: string, conversationId: string): Promise<ChannelAccount>

Paramètres

authHeader

string

En-tête d’authentification.

userId

string

ID d’utilisateur.

conversationId

string

ID de conversation.

Retours

Promise<ChannelAccount>

ChannelAccount pour l’ID d’utilisateur fourni.

héritée deChannelServiceHandlerBase.handleGetConversationMember

handleGetConversationMembers(string, string)

Énumère les membres d’une conversation.

function handleGetConversationMembers(authHeader: string, conversationId: string): Promise<ChannelAccount[]>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

Retours

Promise<ChannelAccount[]>

Liste de ChannelAccount énumérée.

héritée deChannelServiceHandlerBase.handleGetConversationMembers

handleGetConversationPagedMembers(string, string, number, string)

Énumère les membres d’une conversation d’une page à la fois.

function handleGetConversationPagedMembers(authHeader: string, conversationId: string, pageSize?: number, continuationToken?: string): Promise<PagedMembersResult>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

pageSize

number

Taille de page suggérée.

continuationToken

string

Jeton de continuation.

Retours

Promise<PagedMembersResult>

représentant le pagedMembersResult pour l’opération.

héritée deChannelServiceHandlerBase.handleGetConversationPagedMembers

handleGetConversations(string, string, string)

Répertorie les conversations dans lesquelles le bot a participé.

function handleGetConversations(authHeader: string, conversationId: string, continuationToken?: string): Promise<ConversationsResult>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

continuationToken

string

Un jeton d’ignorer ou de continuation.

Retours

Promise<ConversationsResult>

Représentation Promise pour l’opération.

héritée deChannelServiceHandlerBase.handleGetConversations

handleReplyToActivity(string, string, string, Activity)

Envoie une réponse à uned’activité .

function handleReplyToActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

activityId

string

L’ID d’activité auquel la réponse doit être répondue.

activity

Activity

Activité à envoyer.

Retours

Promise<ResourceResponse>

représentant le ResourceResponse pour l’opération.

héritée deChannelServiceHandlerBase.handleReplyToActivity

handleSendConversationHistory(string, string, Transcript)

Charge les activités historiques de la conversation.

function handleSendConversationHistory(authHeader: string, conversationId: string, transcript: Transcript): Promise<ResourceResponse>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

transcript

Transcript

(xref :botframework-schema. Transcription) des activités.

Retours

Promise<ResourceResponse>

représentant le ResourceResponse pour l’opération.

héritée deChannelServiceHandlerBase.handleSendConversationHistory

handleSendToConversation(string, string, Activity)

Envoie une d’activité à la fin d’une conversation.

function handleSendToConversation(authHeader: string, conversationId: string, activity: Activity): Promise<ResourceResponse>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

activity

Activity

Activité à envoyer.

Retours

Promise<ResourceResponse>

représentant le ResourceResponse pour l’opération.

héritée deChannelServiceHandlerBase.handleSendToConversation

handleUpdateActivity(string, string, string, Activity)

Modifie und’activité déjà envoyé.

function handleUpdateActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

activityId

string

ID d’activité à mettre à jour.

activity

Activity

L’activité de remplacement .

Retours

Promise<ResourceResponse>

représentant le ResourceResponse pour l’opération.

héritée deChannelServiceHandlerBase.handleUpdateActivity

handleUploadAttachment(string, string, AttachmentData)

Stocke les données dans un magasin conforme lors de la gestion des entreprises.

function handleUploadAttachment(authHeader: string, conversationId: string, attachmentUpload: AttachmentData): Promise<ResourceResponse>

Paramètres

authHeader

string

En-tête d’authentification.

conversationId

string

ID de conversation.

attachmentUpload

AttachmentData

(xref :botframework-schema. AttachmentData).

Retours

Promise<ResourceResponse>

représentant le ResourceResponse pour l’opération.

héritée deChannelServiceHandlerBase.handleUploadAttachment