ChannelServiceHandlerBase class

Paquete:

botbuilder

ChannelServiceHandlerBase implementa la API para reenviar la actividad a una aptitud e implementa el enrutamiento de llamadas ChannelAPI desde la aptitud hasta el bot o adaptador.

Métodos

handleCreateConversation(string, ConversationParameters)	Crea una nueva conversación.
handleDeleteActivity(string, string, string)	Elimina una actividad existente.
handleDeleteConversationMember(string, string, string)	Elimina un miembro de una conversación.
handleGetActivityMembers(string, string, string)	Enumera los miembros de una actividad.
handleGetConversationMember(string, string, string)	Obtiene la cuenta de un único miembro de conversación.
handleGetConversationMembers(string, string)	Enumera los miembros de una conversación.
handleGetConversationPagedMembers(string, string, number, string)	Enumera los miembros de una conversación una página a la vez.
handleGetConversations(string, string, string)	Enumera las conversaciones en las que ha participado el bot.
handleReplyToActivity(string, string, string, Activity)	Envía una respuesta a una actividad.
handleSendConversationHistory(string, string, Transcript)	Carga las actividades históricas de la conversación.
handleSendToConversation(string, string, Activity)	Envía una actividad al final de una conversación.
handleUpdateActivity(string, string, string, Activity)	Edita una actividad existente enviada previamente.
handleUploadAttachment(string, string, AttachmentData)	Almacena datos en un almacén compatible cuando se trabaja con empresas.

Detalles del método

handleCreateConversation(string, ConversationParameters)

Crea una nueva conversación.

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

Parámetros

authHeader

string

Encabezado de autenticación.

parameters

ConversationParameters

(xref:botbuilder-core. ConversationParameters) para crear la conversación.

Devoluciones

Promise<ConversationResourceResponse>

Representación Promise de la operación.

handleDeleteActivity(string, string, string)

Elimina una actividad existente.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

activityId

string

Identificador de actividad que se va a eliminar.

Devoluciones

Promise<void>

handleDeleteConversationMember(string, string, string)

Elimina un miembro de una conversación.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

memberId

string

Identificador del miembro que se va a eliminar de esta conversación.

Devoluciones

Promise<void>

handleGetActivityMembers(string, string, string)

Enumera los miembros de una actividad.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

activityId

string

Identificador de actividad.

Devoluciones

Promise<ChannelAccount[]>

Lista ChannelAccount enumerada.

handleGetConversationMember(string, string, string)

Obtiene la cuenta de un único miembro de conversación.

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

Parámetros

authHeader

string

Encabezado de autenticación.

userId

string

Id. de usuario.

conversationId

string

Identificador de conversación.

Devoluciones

Promise<ChannelAccount>

ChannelAccount para el identificador de usuario proporcionado.

handleGetConversationMembers(string, string)

Enumera los miembros de una conversación.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

Devoluciones

Promise<ChannelAccount[]>

Lista ChannelAccount enumerada.

handleGetConversationPagedMembers(string, string, number, string)

Enumera los miembros de una conversación una página a la vez.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

pageSize

number

Tamaño de página sugerido.

continuationToken

string

Token de continuación.

Devoluciones

Promise<PagedMembersResult>

que Promise representa pagedMembersResult para la operación.

handleGetConversations(string, string, string)

Enumera las conversaciones en las que ha participado el bot.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

continuationToken

string

Token de omisión o continuación.

Devoluciones

Promise<ConversationsResult>

Representación Promise de la operación.

handleReplyToActivity(string, string, string, Activity)

Envía una respuesta a una actividad.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

activityId

string

Identificador de actividad al que va la respuesta.

activity

Activity

Actividad que se va a enviar.

Devoluciones

Promise<ResourceResponse>

que Promise representa ResourceResponse para la operación.

handleSendConversationHistory(string, string, Transcript)

Carga las actividades históricas de la conversación.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

transcript

Transcript

(xref:botframework-schema. Transcripción) de actividades.

Devoluciones

Promise<ResourceResponse>

que Promise representa ResourceResponse para la operación.

handleSendToConversation(string, string, Activity)

Envía una actividad al final de una conversación.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

activity

Activity

Actividad que se va a enviar.

Devoluciones

Promise<ResourceResponse>

que Promise representa ResourceResponse para la operación.

handleUpdateActivity(string, string, string, Activity)

Edita una actividad existente enviada previamente.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

activityId

string

Identificador de actividad que se va a actualizar.

activity

Activity

Actividad de reemplazo.

Devoluciones

Promise<ResourceResponse>

que Promise representa ResourceResponse para la operación.

handleUploadAttachment(string, string, AttachmentData)

Almacena datos en un almacén compatible cuando se trabaja con empresas.

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

Parámetros

authHeader

string

Encabezado de autenticación.

conversationId

string

Identificador de conversación.

attachmentUpload

AttachmentData

(xref:botframework-schema. AttachmentData).

Devoluciones

Promise<ResourceResponse>

que Promise representa ResourceResponse para la operación.