IConnector interface

패키지:

botbuilder

UniversalBot용 커넥터 플러그 인에 의해 구현됩니다.

메서드

delete(IAddress, (err: Error) => void)	(선택 사항) send()사용하여 이전에 보낸 메시지를 삭제하기 위해 호출할 수 있는 메서드입니다.
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)	등록 시 UniversalBot에서 채널에서 들어오는 이벤트를 수신하기 위한 처리기를 등록하기 위해 호출됩니다.
onInvoke((event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void)	(선택 사항) 들어오는 호출 이벤트를 수신하기 위한 처리기를 등록하기 위해 등록 시 UniversalBot에 의해 호출됩니다. 호출 이벤트는 수신된 요청에 대한 응답의 일부로 본문 인라인을 반환해야 하는 특수 이벤트입니다.
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)	사용자에게 보내는 메시지를 보냅니다. 이 메서드는 UniversalBot.send() 또는 Session.send()호출할 때마다 호출됩니다. 보낸 메시지의 주소를 가져오는 편리한 방법으로 session.connector.send() 사용하여 이 메서드를 수동으로 호출할 수 있습니다. 그런 다음 이 주소를 저장하고 나중에 사용하여 메시지를 업데이트하거나 삭제할 수 있습니다. 유의해야 할 한 가지는 session.connector.send() 수동으로 호출하는 경우 보내는 메시지가 일반적으로 실행되는 미들웨어를 우회한다는 것입니다. session.send(msg).sendBatch(function (err, addresses) { }) 호출은 동일한 작업을 수행하지만 나가는 메시지가 미들웨어를 통해 전송되도록 합니다.
startConversation(IAddress, (err: Error, address?: IAddress) => void)	UniversalBot이 사용자와 새로운 사전 대응 대화를 시작하려고 할 때 호출됩니다. 커넥터는 IAddress.conversation 필드를 올바르게 형식이 지정된 주소를 반환해야 합니다. 일반적으로 UniversalBot.beginDialog() 호출할 때 호출되지만 전송되는 메시지에 대해 null이 IAddress.conversation 언제든지 호출됩니다.
update(IMessage, (err: Error, address?: IAddress) => void)	(선택 사항) send()사용하여 이전에 보낸 메시지를 바꾸기 위해 호출할 수 있는 메서드입니다.

메서드 세부 정보

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

(선택 사항) send()사용하여 이전에 보낸 메시지를 삭제하기 위해 호출할 수 있는 메서드입니다.

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

매개 변수

address

IAddress

삭제할 메시지의 주소입니다.

callback

(err: Error) => void

작업이 완료되면 호출하는 함수입니다.

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

등록 시 UniversalBot에서 채널에서 들어오는 이벤트를 수신하기 위한 처리기를 등록하기 위해 호출됩니다.

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

매개 변수

handler

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

"invoke" 형식이 아닌 이벤트를 수신할 때마다 호출해야 하는 함수입니다.

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

(선택 사항) 들어오는 호출 이벤트를 수신하기 위한 처리기를 등록하기 위해 등록 시 UniversalBot에 의해 호출됩니다. 호출 이벤트는 수신된 요청에 대한 응답의 일부로 본문 인라인을 반환해야 하는 특수 이벤트입니다.

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

매개 변수

handler

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

"invoke" 이벤트를 수신할 때마다 호출해야 하는 함수입니다.

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

사용자에게 보내는 메시지를 보냅니다. 이 메서드는 UniversalBot.send() 또는 Session.send()호출할 때마다 호출됩니다. 보낸 메시지의 주소를 가져오는 편리한 방법으로 session.connector.send() 사용하여 이 메서드를 수동으로 호출할 수 있습니다. 그런 다음 이 주소를 저장하고 나중에 사용하여 메시지를 업데이트하거나 삭제할 수 있습니다. 유의해야 할 한 가지는 session.connector.send() 수동으로 호출하는 경우 보내는 메시지가 일반적으로 실행되는 미들웨어를 우회한다는 것입니다. session.send(msg).sendBatch(function (err, addresses) { }) 호출은 동일한 작업을 수행하지만 나가는 메시지가 미들웨어를 통해 전송되도록 합니다.

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

매개 변수

messages

IMessage[]

사용자를 보낼 메시지 배열입니다.

callback

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

작업이 완료되면 호출하는 함수입니다.

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

UniversalBot이 사용자와 새로운 사전 대응 대화를 시작하려고 할 때 호출됩니다. 커넥터는 IAddress.conversation 필드를 올바르게 형식이 지정된 주소를 반환해야 합니다. 일반적으로 UniversalBot.beginDialog() 호출할 때 호출되지만 전송되는 메시지에 대해 null이 IAddress.conversation 언제든지 호출됩니다.

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

매개 변수

address

IAddress

대화를 시작할 사용자의 주소입니다. IAddress.conversation 필드는 null이어야 합니다.

callback

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

작업이 완료되면 호출하는 함수입니다.

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

(선택 사항) send()사용하여 이전에 보낸 메시지를 바꾸기 위해 호출할 수 있는 메서드입니다.

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

매개 변수

message

IMessage

기존 메시지를 덮어쓸 메시지입니다. message.address 필드에는 send()대한 이전 호출에서 반환된 주소가 포함되어야 합니다.

callback

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

작업이 완료되면 호출하는 함수입니다.