ChannelServiceHandlerBase class

Pacote:

botbuilder

O ChannelServiceHandlerBase implementa a API para encaminhar a atividade para uma habilidade e implementa o roteamento de chamadas ChannelAPI do Skill por meio do bot/adaptador.

Métodos

handleCreateConversation(string, ConversationParameters)	Cria uma nova Conversa.
handleDeleteActivity(string, string, string)	Exclui umde Atividade de existente.
handleDeleteConversationMember(string, string, string)	Exclui um membro de uma conversa.
handleGetActivityMembers(string, string, string)	Enumera os membros de uma atividade .
handleGetConversationMember(string, string, string)	Obtém a conta de um único membro de conversa.
handleGetConversationMembers(string, string)	Enumera os membros de uma conversa.
handleGetConversationPagedMembers(string, string, number, string)	Enumera os membros de uma conversa uma página de cada vez.
handleGetConversations(string, string, string)	Lista as conversas nas quais o bot participou.
handleReplyToActivity(string, string, string, Activity)	Envia uma resposta a umde Atividade de .
handleSendConversationHistory(string, string, Transcript)	Carrega as atividades históricas da conversa.
handleSendToConversation(string, string, Activity)	Envia um de Atividade de ao final de uma conversa.
handleUpdateActivity(string, string, string, Activity)	Edita umde atividade de existente enviado anteriormente.
handleUploadAttachment(string, string, AttachmentData)	Armazena dados em um repositório em conformidade ao lidar com empresas.

Detalhes do método

handleCreateConversation(string, ConversationParameters)

Cria uma nova Conversa.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

parameters

ConversationParameters

(xref:botbuilder-core. ConversationParameters) para criar a conversa.

Retornos

Promise<ConversationResourceResponse>

Uma representação Promise para a operação.

handleDeleteActivity(string, string, string)

Exclui umde Atividade de existente.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

activityId

string

A ID da atividade a ser excluída.

Retornos

Promise<void>

handleDeleteConversationMember(string, string, string)

Exclui um membro de uma conversa.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

memberId

string

Id do membro a ser excluído desta conversa.

Retornos

Promise<void>

handleGetActivityMembers(string, string, string)

Enumera os membros de uma atividade .

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

activityId

string

A ID da atividade.

Retornos

Promise<ChannelAccount[]>

A lista ChannelAccount enumerada.

handleGetConversationMember(string, string, string)

Obtém a conta de um único membro de conversa.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

userId

string

A ID do usuário.

conversationId

string

A ID da conversa.

Retornos

Promise<ChannelAccount>

O ChannelAccount para a ID de usuário fornecida.

handleGetConversationMembers(string, string)

Enumera os membros de uma conversa.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

Retornos

Promise<ChannelAccount[]>

A lista ChannelAccount enumerada.

handleGetConversationPagedMembers(string, string, number, string)

Enumera os membros de uma conversa uma página de cada vez.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

pageSize

number

Tamanho da página sugerido.

continuationToken

string

Um token de continuação.

Retornos

Promise<PagedMembersResult>

Um Promise que representa o PagedMembersResult para a operação.

handleGetConversations(string, string, string)

Lista as conversas nas quais o bot participou.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

continuationToken

string

Um token de ignorar ou de continuação.

Retornos

Promise<ConversationsResult>

Uma representação Promise para a operação.

handleReplyToActivity(string, string, string, Activity)

Envia uma resposta a umde Atividade de .

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

activityId

string

A ID da atividade à qual a resposta é.

activity

Activity

A atividade de a ser enviada.

Retornos

Promise<ResourceResponse>

Um Promise que representa o ResourceResponse para a operação.

handleSendConversationHistory(string, string, Transcript)

Carrega as atividades históricas da conversa.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

transcript

Transcript

(xref:botframework-schema. Transcrição) de atividades.

Retornos

Promise<ResourceResponse>

Um Promise que representa o ResourceResponse para a operação.

handleSendToConversation(string, string, Activity)

Envia um de Atividade de ao final de uma conversa.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

activity

Activity

A atividade de a ser enviada.

Retornos

Promise<ResourceResponse>

Um Promise que representa o ResourceResponse para a operação.

handleUpdateActivity(string, string, string, Activity)

Edita umde atividade de existente enviado anteriormente.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

activityId

string

A ID da atividade a ser atualizada.

activity

Activity

Ode atividade de de substituição.

Retornos

Promise<ResourceResponse>

Um Promise que representa o ResourceResponse para a operação.

handleUploadAttachment(string, string, AttachmentData)

Armazena dados em um repositório em conformidade ao lidar com empresas.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação.

conversationId

string

A ID da conversa.

attachmentUpload

AttachmentData

(xref:botframework-schema. AttachmentData).

Retornos

Promise<ResourceResponse>

Um Promise que representa o ResourceResponse para a operação.