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 el adaptador.

Métodos

handleCreateConversation(string, ConversationParameters)	Crea una nueva conversación.
handleDeleteActivity(string, string, string)	Elimina una actividad de existente.
handleDeleteConversationMember(string, string, string)	Elimina un miembro de una conversación.
handleGetActivityMembers(string, string, string)	Enumera los miembros de un Activity.
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 unactividad de .
handleSendConversationHistory(string, string, Transcript)	Carga las actividades históricas de la conversación.
handleSendToConversation(string, string, Activity)	Envía un de actividad de al final de una conversación.
handleUpdateActivity(string, string, string, Activity)	Edita unactividad de existente enviado anteriormente.
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 a partir de .

Devoluciones

Promise<ConversationResourceResponse>

Representación Promise para la operación.

handleDeleteActivity(string, string, string)

Elimina una actividad de 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 un Activity.

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

Identificador de usuario.

conversationId

string

Identificador de conversación.

Devoluciones

Promise<ChannelAccount>

El 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 de 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>

Un que representa el PagedMembersResult de 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

Un token de omisión o continuación.

Devoluciones

Promise<ConversationsResult>

Representación Promise para la operación.

handleReplyToActivity(string, string, string, Activity)

Envía una respuesta a unactividad de .

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 se va a responder.

activity

Activity

El actividad de que se va a enviar.

Devoluciones

Promise<ResourceResponse>

Un que representa el 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>

Un que representa el ResourceResponse para la operación.

handleSendToConversation(string, string, Activity)

Envía un de actividad de 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

El actividad de que se va a enviar.

Devoluciones

Promise<ResourceResponse>

Un que representa el ResourceResponse para la operación.

handleUpdateActivity(string, string, string, Activity)

Edita unactividad de existente enviado anteriormente.

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

Elde actividad de reemplazo de .

Devoluciones

Promise<ResourceResponse>

Un que representa el 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>

Un que representa el ResourceResponse para la operación.