ChannelServiceHandler class

Pacchetto:

botbuilder

Avviso

Questa API è ora deprecata.

Use CloudChannelServiceHandler instead. The ChannelServiceHandler implements API to forward activity to a skill and implements routing ChannelAPI calls from the Skill up through the bot/adapter.

Extends

ChannelServiceHandlerBase

Costruttori

ChannelServiceHandler(ICredentialProvider, AuthenticationConfiguration, string)

Inizializza una nuova istanza della classe ChannelServiceHandler usando un provider di credenziali.

Metodi ereditati

handleCreateConversation(string, ConversationParameters)	Crea una nuova conversazione.
handleDeleteActivity(string, string, string)	Elimina un'attività di esistente.
handleDeleteConversationMember(string, string, string)	Elimina un membro da una conversazione.
handleGetActivityMembers(string, string, string)	Enumera i membri di un'attività .
handleGetConversationMember(string, string, string)	Ottiene l'account di un singolo membro della conversazione.
handleGetConversationMembers(string, string)	Enumera i membri di una conversazione.
handleGetConversationPagedMembers(string, string, number, string)	Enumera i membri di una conversazione una pagina alla volta.
handleGetConversations(string, string, string)	Elenca le conversazioni in cui il bot ha partecipato.
handleReplyToActivity(string, string, string, Activity)	Invia una risposta a un'attività .
handleSendConversationHistory(string, string, Transcript)	Carica le attività storiche della conversazione.
handleSendToConversation(string, string, Activity)	Invia un 'attività alla fine di una conversazione.
handleUpdateActivity(string, string, string, Activity)	Modifica un'attività di esistente inviata in precedenza.
handleUploadAttachment(string, string, AttachmentData)	Archivia i dati in un archivio conforme quando si gestiscono le aziende.

Dettagli costruttore

ChannelServiceHandler(ICredentialProvider, AuthenticationConfiguration, string)

Inizializza una nuova istanza della classe ChannelServiceHandler usando un provider di credenziali.

new ChannelServiceHandler(credentialProvider: ICredentialProvider, authConfig: AuthenticationConfiguration, channelService?: string)

Parametri

credentialProvider

ICredentialProvider

Provider di credenziali.

authConfig

AuthenticationConfiguration

Configurazione dell'autenticazione.

channelService

string

Stringa che rappresenta il provider di canali.

Dettagli dei metodi ereditati

handleCreateConversation(string, ConversationParameters)

Crea una nuova conversazione.

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

Parametri

authHeader

string

Intestazione di autenticazione.

parameters

ConversationParameters

(xref:botbuilder-core. ConversationParameters) da cui creare la conversazione.

Restituisce

Promise<ConversationResourceResponse>

Rappresentazione Promise per l'operazione.

Ereditato daChannelServiceHandlerBase.handleCreateConversation

handleDeleteActivity(string, string, string)

Elimina un'attività di esistente.

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

activityId

string

ID attività da eliminare.

Restituisce

Promise<void>

Ereditato daChannelServiceHandlerBase.handleDeleteActivity

handleDeleteConversationMember(string, string, string)

Elimina un membro da una conversazione.

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

memberId

string

ID del membro da eliminare da questa conversazione.

Restituisce

Promise<void>

Ereditato daChannelServiceHandlerBase.handleDeleteConversationMember

handleGetActivityMembers(string, string, string)

Enumera i membri di un'attività .

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

activityId

string

ID attività.

Restituisce

Promise<ChannelAccount[]>

Elenco ChannelAccount enumerato.

Ereditato daChannelServiceHandlerBase.handleGetActivityMembers

handleGetConversationMember(string, string, string)

Ottiene l'account di un singolo membro della conversazione.

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

Parametri

authHeader

string

Intestazione di autenticazione.

userId

string

ID utente.

conversationId

string

ID conversazione.

Restituisce

Promise<ChannelAccount>

ChannelAccount per l'ID utente specificato.

Ereditato daChannelServiceHandlerBase.handleGetConversationMember

handleGetConversationMembers(string, string)

Enumera i membri di una conversazione.

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

Restituisce

Promise<ChannelAccount[]>

Elenco ChannelAccount enumerato.

Ereditato daChannelServiceHandlerBase.handleGetConversationMembers

handleGetConversationPagedMembers(string, string, number, string)

Enumera i membri di una conversazione una pagina alla volta.

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

pageSize

number

Dimensioni della pagina suggerite.

continuationToken

string

Token di continuazione.

Restituisce

Promise<PagedMembersResult>

che rappresenta il PagedMembersResult per l'operazione.

Ereditato daChannelServiceHandlerBase.handleGetConversationPagedMembers

handleGetConversations(string, string, string)

Elenca le conversazioni in cui il bot ha partecipato.

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

continuationToken

string

Token di skip o di continuazione.

Restituisce

Promise<ConversationsResult>

Rappresentazione Promise per l'operazione.

Ereditato daChannelServiceHandlerBase.handleGetConversations

handleReplyToActivity(string, string, string, Activity)

Invia una risposta a un'attività .

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

activityId

string

ID attività a cui si trova la risposta.

activity

Activity

attività di da inviare.

Restituisce

Promise<ResourceResponse>

che rappresenta il ResourceResponse per l'operazione.

Ereditato daChannelServiceHandlerBase.handleReplyToActivity

handleSendConversationHistory(string, string, Transcript)

Carica le attività storiche della conversazione.

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

transcript

Transcript

(xref:botframework-schema. Trascrizione) di attività.

Restituisce

Promise<ResourceResponse>

che rappresenta il ResourceResponse per l'operazione.

Ereditato daChannelServiceHandlerBase.handleSendConversationHistory

handleSendToConversation(string, string, Activity)

Invia un 'attività alla fine di una conversazione.

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

activity

Activity

attività di da inviare.

Restituisce

Promise<ResourceResponse>

che rappresenta il ResourceResponse per l'operazione.

Ereditato daChannelServiceHandlerBase.handleSendToConversation

handleUpdateActivity(string, string, string, Activity)

Modifica un'attività di esistente inviata in precedenza.

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

activityId

string

ID attività da aggiornare.

activity

Activity

L'attività di sostituzione .

Restituisce

Promise<ResourceResponse>

che rappresenta il ResourceResponse per l'operazione.

Ereditato daChannelServiceHandlerBase.handleUpdateActivity

handleUploadAttachment(string, string, AttachmentData)

Archivia i dati in un archivio conforme quando si gestiscono le aziende.

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

Parametri

authHeader

string

Intestazione di autenticazione.

conversationId

string

ID conversazione.

attachmentUpload

AttachmentData

(xref:botframework-schema. AttachmentData).

Restituisce

Promise<ResourceResponse>

che rappresenta il ResourceResponse per l'operazione.

Ereditato daChannelServiceHandlerBase.handleUploadAttachment