ChatConnector class

Paquete:

botbuilder

Conecta un UniversalBot a varios canales a través de Bot Framework.

Constructores

ChatConnector(IChatConnectorSettings)

Crea una nueva amenaza de ChatConnector.

Métodos

delete(IAddress, (err: Error) => void)	Elimina un mensaje existente.
deleteConversationMember(string, string, string, (err: Error) => void)	Elimina los datos de un usuario individual dentro de una conversación.
emulateOAuthCards(string, boolean, (err: Error) => void)	Indica al servicio de token que emule el envío de OAuthCards.
exportBotStateData(string, string, string | undefined, (err: Error, results: IBotStateDataResult) => void)	Exporta los datos de estado del bot guardados para un canal determinado.
getAccessToken((err: Error, accessToken: string) => void)	Obtiene el token de acceso actual para el bot.
getConversationPagedMembers(string, string, number | undefined, string | undefined, (err: Error, result?: IPagedMembersResult) => void)	Enumerar los miembros de una conversación una página a la vez. Esta API REST toma un ConversationId. Opcionalmente, se puede proporcionar pageSize o continuationToken. Devuelve un PagedMembersResult, que contiene una matriz de ChannelAccounts que representa los miembros de la conversación y un token de continuación que se puede usar para obtener más valores. Se devuelve una página de los registros ChannelAccounts con cada llamada. El número de registros de una página puede variar entre canales y llamadas. El parámetro pageSize se puede usar como sugerencia. Si no hay ningún resultado adicional, la respuesta no contendrá un token de continuación. Si no hay miembros en la conversación, los miembros estarán vacíos o no estarán presentes en la respuesta. Una respuesta a una solicitud que tiene un token de continuación de una solicitud anterior rara vez puede devolver miembros de una solicitud anterior.
getConversations(string, string | undefined, (err: Error, result?: IConversationsResult) => void)	Recupera una lista de todas las conversaciones que el bot tiene en un canal determinado. Los resultados se devolverán al bot en páginas junto con un continuationToken que se puede usar para capturar la siguiente página de conversaciones. Estos datos se pueden usar para eliminar todos los datos de conversación de un usuario a través del método deleteConversationMember().
getData(IBotStorageContext, (err: Error, data: IBotStorageData) => void)	Lee los datos del servicio de estado bot Frameworks.
getSignInLink(IChatConnectorAddress, string, (err: Error, link: string) => void)	Obtiene un vínculo de inicio de sesión del servidor de tokens que se puede enviar como parte de un SigninCard.
getUserToken(IChatConnectorAddress, string, string | undefined, (err: Error, results: ITokenResponse) => void)	Intenta recuperar el token de un usuario que está en un flujo de inicio de sesión.
listen()	Registra un enlace de estilo Express o Restify para escuchar nuevos mensajes.
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)	Llamado por UniversalBot en el momento de registro para registrar un controlador para recibir eventos entrantes de un canal.
onInvoke((event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void)	Se usa para registrar un controlador para recibir eventos de invocación entrantes.
saveData(IBotStorageContext, IBotStorageData, (err: Error) => void)	Escribe datos en el servicio de estado bot Frameworks.
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)	Llamado por UniversalBot para entregar mensajes salientes a un usuario.
sendConversationHistory(string, string, ITranscript, (err: Error, results: any) => void)	Este método permite cargar las actividades históricas en la conversación. El remitente debe asegurarse de que las actividades históricas tengan identificadores únicos y marcas de tiempo adecuadas. El cliente usa los identificadores para tratar las actividades duplicadas y el cliente usa las marcas de tiempo para representar las actividades en el orden correcto.
signOutUser(IChatConnectorAddress, string, (err: Error, results: ITokenResponse) => void)	Cierra la sesión del usuario con el servidor de tokens.
startConversation(IAddress, (err: Error, address?: IAddress) => void)	Se llama cuando un UniversalBot quiere iniciar una nueva conversación proactiva con un usuario. El conector debe devolver un objeto de dirección con formato correcto con un campo de de conversación rellenado .
update(IMessage, (err: Error, address?: IAddress) => void)	Reemplaza un mensaje existente por uno nuevo.

Detalles del constructor

ChatConnector(IChatConnectorSettings)

Crea una nueva amenaza de ChatConnector.

new ChatConnector(settings?: IChatConnectorSettings)

Parámetros

settings

IChatConnectorSettings

(Opcional) los parámetros de configuración que le permiten especificar el identificador de aplicación de bots & contraseña que se asignó en el portal para desarrolladores de Bot Frameworks.

Detalles del método

delete(IAddress, (err: Error) => void)

Elimina un mensaje existente.

function delete(address: IAddress, done: (err: Error) => void)

Parámetros

address

IAddress

done

(err: Error) => void

deleteConversationMember(string, string, string, (err: Error) => void)

Elimina los datos de un usuario individual dentro de una conversación.

function deleteConversationMember(serviceUrl: string, conversationId: string, memberId: string, done: (err: Error) => void)

Parámetros

serviceUrl

string

Dirección URL del servicio para el canal que se está actualizando. Esto se puede encontrar en el address.serviceUrl de un mensaje enviado al bot.

conversationId

string

Identificador de la conversación con el miembro que se va a eliminar.

memberId

string

Identificador del miembro que se va a eliminar.

done

(err: Error) => void

Devolución de llamada invocada tras la finalización de la operación de eliminación.

emulateOAuthCards(string, boolean, (err: Error) => void)

Indica al servicio de token que emule el envío de OAuthCards.

function emulateOAuthCards(serviceUrl: string, emulate: boolean, done: (err: Error) => void)

Parámetros

serviceUrl

string

Dirección URL del servicio para el canal que se está consultando. Esto se puede encontrar en el address.serviceUrl de un mensaje enviado al bot.

emulate

boolean

Si true el servicio de token emulará el envío de OAuthCards.

done

(err: Error) => void

Devolución de llamada invocada tras la finalización de la operación.

exportBotStateData(string, string, string | undefined, (err: Error, results: IBotStateDataResult) => void)

Exporta los datos de estado del bot guardados para un canal determinado.

function exportBotStateData(serviceUrl: string, channelId: string, continuationToken: string | undefined, done: (err: Error, results: IBotStateDataResult) => void)

Parámetros

serviceUrl

string

Dirección URL del servicio para el canal que se está consultando. Esto se puede encontrar en el address.serviceUrl de un mensaje enviado al bot.

channelId

string

Identificador del canal que se va a exportar. Esto se puede encontrar en el address.channelId de un mensaje enviado al bot.

continuationToken

string | undefined

Token de continuación de la página siguiente de resultados que se va a capturar. Debe ser undefined para la primera página solicitada.

done

(err: Error, results: IBotStateDataResult) => void

Devolución de llamada para recibir la siguiente página de resultados.

getAccessToken((err: Error, accessToken: string) => void)

Obtiene el token de acceso actual para el bot.

function getAccessToken(callback: (err: Error, accessToken: string) => void)

Parámetros

callback

(err: Error, accessToken: string) => void

getConversationPagedMembers(string, string, number | undefined, string | undefined, (err: Error, result?: IPagedMembersResult) => void)

Enumerar los miembros de una conversación una página a la vez. Esta API REST toma un ConversationId. Opcionalmente, se puede proporcionar pageSize o continuationToken. Devuelve un PagedMembersResult, que contiene una matriz de ChannelAccounts que representa los miembros de la conversación y un token de continuación que se puede usar para obtener más valores.

Se devuelve una página de los registros ChannelAccounts con cada llamada. El número de registros de una página puede variar entre canales y llamadas. El parámetro pageSize se puede usar como sugerencia. Si no hay ningún resultado adicional, la respuesta no contendrá un token de continuación. Si no hay miembros en la conversación, los miembros estarán vacíos o no estarán presentes en la respuesta.

Una respuesta a una solicitud que tiene un token de continuación de una solicitud anterior rara vez puede devolver miembros de una solicitud anterior.

function getConversationPagedMembers(serviceUrl: string, conversationId: string, pageSize: number | undefined, continuationToken: string | undefined, done: (err: Error, result?: IPagedMembersResult) => void)

Parámetros

serviceUrl

string

Dirección URL del servicio para el canal que se está consultando. Esto se puede encontrar en el address.serviceUrl de un mensaje enviado al bot.

conversationId

string

ConversationId

pageSize

number | undefined

Número de resultados que se van a obtener (el valor predeterminado es 20)

continuationToken

string | undefined

Token de continuación de la página siguiente de resultados que se va a capturar. Debe ser undefined para la primera página solicitada.

done

(err: Error, result?: IPagedMembersResult) => void

Devolución de llamada para recibir la siguiente página de resultados.

getConversations(string, string | undefined, (err: Error, result?: IConversationsResult) => void)

Recupera una lista de todas las conversaciones que el bot tiene en un canal determinado. Los resultados se devolverán al bot en páginas junto con un continuationToken que se puede usar para capturar la siguiente página de conversaciones. Estos datos se pueden usar para eliminar todos los datos de conversación de un usuario a través del método deleteConversationMember().

function getConversations(serviceUrl: string, continuationToken: string | undefined, done: (err: Error, result?: IConversationsResult) => void)

Parámetros

serviceUrl

string

Dirección URL del servicio para el canal que se está consultando. Esto se puede encontrar en el address.serviceUrl de un mensaje enviado al bot.

continuationToken

string | undefined

Token de continuación de la página siguiente de resultados que se va a capturar. Debe ser undefined para la primera página solicitada.

done

(err: Error, result?: IConversationsResult) => void

Devolución de llamada para recibir la siguiente página de resultados.

getData(IBotStorageContext, (err: Error, data: IBotStorageData) => void)

Lee los datos del servicio de estado bot Frameworks.

function getData(context: IBotStorageContext, callback: (err: Error, data: IBotStorageData) => void)

Parámetros

context

IBotStorageContext

callback

(err: Error, data: IBotStorageData) => void

getSignInLink(IChatConnectorAddress, string, (err: Error, link: string) => void)

Obtiene un vínculo de inicio de sesión del servidor de tokens que se puede enviar como parte de un SigninCard.

function getSignInLink(address: IChatConnectorAddress, connectionName: string, done: (err: Error, link: string) => void)

Parámetros

address

IChatConnectorAddress

Dirección del usuario y el canal para los que se va a obtener el vínculo de inicio de sesión.

connectionName

string

Nombre de la conexión de autenticación que se va a usar.

done

(err: Error, link: string) => void

Devolución de llamada para recuperar el vínculo.

getUserToken(IChatConnectorAddress, string, string | undefined, (err: Error, results: ITokenResponse) => void)

Intenta recuperar el token de un usuario que está en un flujo de inicio de sesión.

function getUserToken(address: IChatConnectorAddress, connectionName: string, magicCode: string | undefined, done: (err: Error, results: ITokenResponse) => void)

Parámetros

address

IChatConnectorAddress

Dirección del usuario y el canal para iniciar sesión.

connectionName

string

Nombre de la conexión de autenticación que se va a usar.

magicCode

string | undefined

(Opcional) El usuario opcional especificó el código para validarlo.

done

(err: Error, results: ITokenResponse) => void

Devolución de llamada para recuperar el token de usuarios.

listen()

Registra un enlace de estilo Express o Restify para escuchar nuevos mensajes.

function listen()

Devoluciones

(req: any, res: any) => void

onEvent((events: IEvent[], callback?: (err: Error) => void) => void)

Llamado por UniversalBot en el momento de registro para registrar un controlador para recibir eventos entrantes de un canal.

function onEvent(handler: (events: IEvent[], callback?: (err: Error) => void) => void)

Parámetros

handler

(events: IEvent[], callback?: (err: Error) => void) => void

onInvoke((event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void)

Se usa para registrar un controlador para recibir eventos de invocación entrantes.

function onInvoke(handler: (event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void)

Parámetros

handler

(event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void

saveData(IBotStorageContext, IBotStorageData, (err: Error) => void)

Escribe datos en el servicio de estado bot Frameworks.

function saveData(context: IBotStorageContext, data: IBotStorageData, callback?: (err: Error) => void)

Parámetros

context

IBotStorageContext

data

IBotStorageData

callback

(err: Error) => void

send(IMessage[], (err: Error, addresses?: IAddress[]) => void)

Llamado por UniversalBot para entregar mensajes salientes a un usuario.

function send(messages: IMessage[], done: (err: Error, addresses?: IAddress[]) => void)

Parámetros

messages

IMessage[]

done

(err: Error, addresses?: IAddress[]) => void

sendConversationHistory(string, string, ITranscript, (err: Error, results: any) => void)

Este método permite cargar las actividades históricas en la conversación. El remitente debe asegurarse de que las actividades históricas tengan identificadores únicos y marcas de tiempo adecuadas. El cliente usa los identificadores para tratar las actividades duplicadas y el cliente usa las marcas de tiempo para representar las actividades en el orden correcto.

function sendConversationHistory(serviceUrl: string, conversationId: string, transcript: ITranscript, done: (err: Error, results: any) => void)

Parámetros

serviceUrl

string

Dirección URL del servicio para el canal que se está consultando. Esto se puede encontrar en el address.serviceUrl de un mensaje enviado al bot.

conversationId

string

Identificador de la conversación con el historial que se va a enviar.

transcript

ITranscript

done

(err: Error, results: any) => void

signOutUser(IChatConnectorAddress, string, (err: Error, results: ITokenResponse) => void)

Cierra la sesión del usuario con el servidor de tokens.

function signOutUser(address: IChatConnectorAddress, connectionName: string, done: (err: Error, results: ITokenResponse) => void)

Parámetros

address

IChatConnectorAddress

Dirección del usuario y el canal para cerrar la sesión.

connectionName

string

Nombre de la conexión de autenticación que se va a usar.

done

(err: Error, results: ITokenResponse) => void

Devolución de llamada para recuperar el token de usuarios.

startConversation(IAddress, (err: Error, address?: IAddress) => void)

Se llama cuando un UniversalBot quiere iniciar una nueva conversación proactiva con un usuario. El conector debe devolver un objeto de dirección con formato correcto con un campo de de conversación rellenado .

function startConversation(address: IAddress, done: (err: Error, address?: IAddress) => void)

Parámetros

address

IAddress

done

(err: Error, address?: IAddress) => void

update(IMessage, (err: Error, address?: IAddress) => void)

Reemplaza un mensaje existente por uno nuevo.

function update(message: IMessage, done: (err: Error, address?: IAddress) => void)

Parámetros

message

IMessage

done

(err: Error, address?: IAddress) => void