ChatConnector class

패키지:

botbuilder

Bot Framework를 통해 유니버설봇을 여러 채널에 연결합니다.

생성자

ChatConnector(IChatConnectorSettings)

ChatConnector의 새 instnace를 만듭니다.

메서드

delete(IAddress, (err: Error) => void)	기존 메시지를 삭제합니다.
deleteConversationMember(string, string, string, (err: Error) => void)	대화 내의 개별 사용자에 대한 데이터를 삭제합니다.
emulateOAuthCards(string, boolean, (err: Error) => void)	OAuthCards 전송을 에뮬레이트하도록 토큰 서비스에 지시합니다.
exportBotStateData(string, string, string | undefined, (err: Error, results: IBotStateDataResult) => void)	지정된 채널에 대해 유지되는 봇 상태 데이터를 내보냅니다.
getAccessToken((err: Error, accessToken: string) => void)	봇에 대한 현재 액세스 토큰을 가져옵니다.
getConversationPagedMembers(string, string, number | undefined, string | undefined, (err: Error, result?: IPagedMembersResult) => void)	대화의 멤버를 한 번에 한 페이지씩 열거합니다. 이 REST API는 ConversationId를 사용합니다. 필요에 따라 pageSize 및/또는 continuationToken을 제공할 수 있습니다. 대화의 멤버를 나타내는 ChannelAccounts 배열과 더 많은 값을 가져오는 데 사용할 수 있는 연속 토큰이 포함된 PagedMembersResult를 반환합니다. 각 호출과 함께 ChannelAccounts 레코드의 한 페이지가 반환됩니다. 페이지의 레코드 수는 채널과 호출에 따라 달라질 수 있습니다. pageSize 매개 변수를 제안으로 사용할 수 있습니다. 추가 결과가 없으면 응답에 연속 토큰이 포함되지 않습니다. 대화에 멤버가 없으면 멤버가 비어 있거나 응답에 표시되지 않습니다. 이전 요청의 연속 토큰이 있는 요청에 대한 응답은 이전 요청의 멤버를 거의 반환하지 않을 수 있습니다.
getConversations(string, string | undefined, (err: Error, result?: IConversationsResult) => void)	지정된 채널에서 봇이 가진 모든 대화 목록을 검색합니다. 결과는 다음 대화 페이지를 가져오는 데 사용할 수 있는 continuationToken 함께 페이지의 봇으로 다시 전송됩니다. 이 데이터는 deleteConversationMember() 메서드를 통해 사용자의 모든 대화 데이터를 삭제하는 데 사용할 수 있습니다.
getData(IBotStorageContext, (err: Error, data: IBotStorageData) => void)	Bot Frameworks 상태 서비스에서 데이터를 읽습니다.
getSignInLink(IChatConnectorAddress, string, (err: Error, link: string) => void)	SigninCard의 일부로 보낼 수 있는 토큰 서버에서 로그인 링크를 가져옵니다.
getUserToken(IChatConnectorAddress, string, string | undefined, (err: Error, results: ITokenResponse) => void)	로그인 흐름에 있는 사용자의 토큰을 검색하려고 시도합니다.
listen()	Express 또는 Restify 스타일 후크를 등록하여 새 메시지를 수신 대기합니다.
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)	등록 시 UniversalBot에서 채널에서 들어오는 이벤트를 수신하기 위한 처리기를 등록하기 위해 호출됩니다.
onInvoke((event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void)	들어오는 호출 이벤트를 수신하기 위한 처리기를 등록하는 데 사용됩니다.
saveData(IBotStorageContext, IBotStorageData, (err: Error) => void)	Bot Frameworks 상태 서비스에 데이터를 씁니다.
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)	사용자에게 보내는 메시지를 전달하기 위해 UniversalBot에서 호출됩니다.
sendConversationHistory(string, string, ITranscript, (err: Error, results: any) => void)	이 메서드를 사용하면 대화에 기록 활동을 업로드할 수 있습니다. 보낸 사람은 기록 활동에 고유한 ID와 적절한 타임스탬프가 있는지 확인해야 합니다. ID는 클라이언트에서 중복 작업을 처리하는 데 사용되며 타임스탬프는 클라이언트가 작업을 올바른 순서로 렌더링하는 데 사용됩니다.
signOutUser(IChatConnectorAddress, string, (err: Error, results: ITokenResponse) => void)	토큰 서버를 사용하여 사용자를 로그아웃합니다.
startConversation(IAddress, (err: Error, address?: IAddress) => void)	UniversalBot이 사용자와 새로운 사전 대응 대화를 시작하려고 할 때 호출됩니다. 커넥터는 채워진 대화 필드가 있는 올바른 형식의 주소 개체를 반환해야 합니다.
update(IMessage, (err: Error, address?: IAddress) => void)	기존 메시지를 새 메시지로 대체합니다.

생성자 세부 정보

ChatConnector(IChatConnectorSettings)

ChatConnector의 새 instnace를 만듭니다.

new ChatConnector(settings?: IChatConnectorSettings)

매개 변수

settings

IChatConnectorSettings

(선택 사항) Bot Frameworks 개발자 포털에서 할당된 봇 앱 ID & 암호를 지정할 수 있는 구성 매개 변수입니다.

메서드 세부 정보

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

기존 메시지를 삭제합니다.

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

매개 변수

address

IAddress

done

(err: Error) => void

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

대화 내의 개별 사용자에 대한 데이터를 삭제합니다.

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

매개 변수

serviceUrl

string

업데이트되는 채널의 서비스 URL입니다. 이는 봇에 전송된 메시지의 address.serviceUrl 찾을 수 있습니다.

conversationId

string

삭제할 멤버와의 대화 ID입니다.

memberId

string

삭제할 멤버의 ID입니다.

done

(err: Error) => void

삭제 작업이 완료되면 콜백이 호출됩니다.

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

OAuthCards 전송을 에뮬레이트하도록 토큰 서비스에 지시합니다.

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

매개 변수

serviceUrl

string

쿼리할 채널의 서비스 URL입니다. 이는 봇에 전송된 메시지의 address.serviceUrl 찾을 수 있습니다.

emulate

boolean

true 경우 토큰 서비스는 OAuthCards 전송을 에뮬레이트합니다.

done

(err: Error) => void

작업이 완료되면 콜백이 호출됩니다.

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

지정된 채널에 대해 유지되는 봇 상태 데이터를 내보냅니다.

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

매개 변수

serviceUrl

string

쿼리할 채널의 서비스 URL입니다. 이는 봇에 전송된 메시지의 address.serviceUrl 찾을 수 있습니다.

channelId

string

내보낼 채널의 ID입니다. 이는 봇에 전송된 메시지의 address.channelId 찾을 수 있습니다.

continuationToken

string | undefined

가져올 결과의 다음 페이지에 대한 연속 토큰입니다. 이는 요청된 첫 번째 페이지에 대해 undefined 합니다.

done

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

결과의 다음 페이지를 수신하기 위한 콜백입니다.

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

봇에 대한 현재 액세스 토큰을 가져옵니다.

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

매개 변수

callback

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

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

대화의 멤버를 한 번에 한 페이지씩 열거합니다. 이 REST API는 ConversationId를 사용합니다. 필요에 따라 pageSize 및/또는 continuationToken을 제공할 수 있습니다. 대화의 멤버를 나타내는 ChannelAccounts 배열과 더 많은 값을 가져오는 데 사용할 수 있는 연속 토큰이 포함된 PagedMembersResult를 반환합니다.

각 호출과 함께 ChannelAccounts 레코드의 한 페이지가 반환됩니다. 페이지의 레코드 수는 채널과 호출에 따라 달라질 수 있습니다. pageSize 매개 변수를 제안으로 사용할 수 있습니다. 추가 결과가 없으면 응답에 연속 토큰이 포함되지 않습니다. 대화에 멤버가 없으면 멤버가 비어 있거나 응답에 표시되지 않습니다.

이전 요청의 연속 토큰이 있는 요청에 대한 응답은 이전 요청의 멤버를 거의 반환하지 않을 수 있습니다.

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

매개 변수

serviceUrl

string

쿼리할 채널의 서비스 URL입니다. 이는 봇에 전송된 메시지의 address.serviceUrl 찾을 수 있습니다.

conversationId

string

conversationId

pageSize

number | undefined

가져올 결과 수(기본값: 20)

continuationToken

string | undefined

가져올 결과의 다음 페이지에 대한 연속 토큰입니다. 이는 요청된 첫 번째 페이지에 대해 undefined 합니다.

done

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

결과의 다음 페이지를 수신하기 위한 콜백입니다.

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

지정된 채널에서 봇이 가진 모든 대화 목록을 검색합니다. 결과는 다음 대화 페이지를 가져오는 데 사용할 수 있는 continuationToken 함께 페이지의 봇으로 다시 전송됩니다. 이 데이터는 deleteConversationMember() 메서드를 통해 사용자의 모든 대화 데이터를 삭제하는 데 사용할 수 있습니다.

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

매개 변수

serviceUrl

string

쿼리할 채널의 서비스 URL입니다. 이는 봇에 전송된 메시지의 address.serviceUrl 찾을 수 있습니다.

continuationToken

string | undefined

가져올 결과의 다음 페이지에 대한 연속 토큰입니다. 이는 요청된 첫 번째 페이지에 대해 undefined 합니다.

done

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

결과의 다음 페이지를 수신하기 위한 콜백입니다.

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

Bot Frameworks 상태 서비스에서 데이터를 읽습니다.

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

매개 변수

context

IBotStorageContext

callback

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

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

SigninCard의 일부로 보낼 수 있는 토큰 서버에서 로그인 링크를 가져옵니다.

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

매개 변수

address

IChatConnectorAddress

로그인 링크를 가져올 사용자 및 채널의 주소입니다.

connectionName

string

사용할 인증 연결의 이름입니다.

done

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

링크를 검색하기 위한 콜백입니다.

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

로그인 흐름에 있는 사용자의 토큰을 검색하려고 시도합니다.

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

매개 변수

address

IChatConnectorAddress

로그인할 사용자 및 채널의 주소입니다.

connectionName

string

사용할 인증 연결의 이름입니다.

magicCode

string | undefined

(선택 사항) 선택적 사용자가 유효성을 검사할 코드를 입력했습니다.

done

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

사용자 토큰을 검색하기 위한 콜백입니다.

listen()

Express 또는 Restify 스타일 후크를 등록하여 새 메시지를 수신 대기합니다.

function listen()

반환

(req: any, res: any) => 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

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

들어오는 호출 이벤트를 수신하기 위한 처리기를 등록하는 데 사용됩니다.

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

매개 변수

handler

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

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

Bot Frameworks 상태 서비스에 데이터를 씁니다.

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

매개 변수

context

IBotStorageContext

data

IBotStorageData

callback

(err: Error) => void

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

사용자에게 보내는 메시지를 전달하기 위해 UniversalBot에서 호출됩니다.

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

매개 변수

messages

IMessage[]

done

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

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

이 메서드를 사용하면 대화에 기록 활동을 업로드할 수 있습니다. 보낸 사람은 기록 활동에 고유한 ID와 적절한 타임스탬프가 있는지 확인해야 합니다. ID는 클라이언트에서 중복 작업을 처리하는 데 사용되며 타임스탬프는 클라이언트가 작업을 올바른 순서로 렌더링하는 데 사용됩니다.

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

매개 변수

serviceUrl

string

쿼리할 채널의 서비스 URL입니다. 이는 봇에 전송된 메시지의 address.serviceUrl 찾을 수 있습니다.

conversationId

string

보낼 기록과 대화의 ID입니다.

transcript

ITranscript

done

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

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

토큰 서버를 사용하여 사용자를 로그아웃합니다.

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

매개 변수

address

IChatConnectorAddress

로그아웃할 사용자 및 채널의 주소입니다.

connectionName

string

사용할 인증 연결의 이름입니다.

done

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

사용자 토큰을 검색하기 위한 콜백입니다.

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

UniversalBot이 사용자와 새로운 사전 대응 대화를 시작하려고 할 때 호출됩니다. 커넥터는 채워진 대화 필드가 있는 올바른 형식의 주소 개체를 반환해야 합니다.

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

매개 변수

address

IAddress

done

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

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

기존 메시지를 새 메시지로 대체합니다.

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

매개 변수

message

IMessage

done

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