CallSession class

패키지:

botbuilder-calling

사용자와의 봇 대화를 관리합니다.

생성자

CallSession(ICallSessionOptions)

세션의 인스턴스를 만듭니다.

속성

conversationData	대화의 모든 구성원에게 표시되는 공유 대화 데이터입니다.
dialogData	현재 대화 상자에만 표시되는 데이터입니다.
library	대화 상자의 봇 루트 라이브러리입니다.
message	사용자로부터 받은 메시지입니다. 봇에서 시작된 메시지의 경우 "to" & "from" 필드만 포함할 수 있습니다.
privateConversationData	사용자에게만 표시되는 비공개 대화 데이터입니다.
sessionState	세션 현재 상태 정보입니다.
userData	봇과의 모든 대화에서 유지되는 사용자에 대한 데이터입니다.

메서드

answer()	수동으로 통화에 응답합니다. 봇이 작업을 수행할 때 호출이 자동으로 응답됩니다.
beginDialog<T>(string, T)	대화 컨트롤을 새 대화 상자에 전달합니다. 현재 대화 상자는 자식 대화 상자가 완료될 때까지 일시 중단됩니다. 자식이 종료되면 현재 대화 상자는 자식에서 반환된 결과를 검사할 수 있는 dialogResumed() 대한 호출을 받습니다.
dispatch(ISessionState, IEvent)	처리를 위해 메시지를 디스패치합니다. 세션은 메시지를 처리하기 위해 활성 대화 상자에 메시지 앞에 설치된 미들웨어를 호출합니다.
endConversation(string | string[] | IAction | IIsAction, any[])	현재 대화를 종료하고 필요에 따라 사용자에게 메시지를 보냅니다. 통화가 자동으로 중단되거나 거부됩니다.
endDialog(string | string[] | IAction | IIsAction, any[])	현재 대화 상자를 종료하고 필요에 따라 사용자에게 메시지를 보냅니다. 완료된이유로 IDialogResult.resumed을 사용하여 부모가 다시 시작됩니다.
endDialogWithResult(IDialogResult<any>)	현재 대화 상자를 종료하고 필요에 따라 대화 부모에 결과를 반환합니다.
error(Error)	오류가 발생했음을 알 수 있습니다. 봇은 on('error', err) 이벤트를 통해 오류 신호를 전송합니다.
gettext(string, any[])	메시지 언어에 대한 지역화된 문자열을 로드합니다. 인수가 전달되면 지역화된 문자열이 템플릿으로 처리되고 sprintf-js 사용하여 형식이 지정됩니다(자세한 내용은 해당 문서 참조).
hangup()	설정된 호출을 수동으로 종료합니다. 봇이 사용자에게 입력하라는 메시지를 중지하면 호출이 자동으로 종료됩니다.
isReset()	세션이 다시 설정되면 true를 반환합니다.
messageSent()	이 세션에 대한 메시지를 보낸 경우 true를 반환합니다.
ngettext(string, string, number)	메시지 언어에 대한 지역화된 문자열의 복수 형식을 로드합니다. 출력 문자열은 문자열의 %d 개수로 바꿔 개수를 포함하도록 형식이 지정됩니다.
on(string, Function)	이벤트 수신기를 등록합니다.
reject()	들어오는 호출을 거부합니다.
replaceDialog<T>(string, T)	현재 대화 상자를 종료하고 새 대화 상자를 시작합니다. 부모 대화는 새 대화가 완료될 때까지 다시 시작되지 않습니다.
reset(string, any)	세션 호출 스택을 지우고 구성된 dialogId를 사용하여 대화를 다시 시작합니다.
save()	dialogData, userData, conversationdata또는 [privateConversationData'(#privateconversationdata)에 대한 변경 내용 저장을 트리거합니다.
send(string | string[] | IAction | IIsAction, any[])	사용자에게 PlayPrompt 작업을 보냅니다.
sendBatch()	현재 일괄 처리를 즉시 종료하고 대기 중인 메시지를 배달합니다.

생성자 세부 정보

CallSession(ICallSessionOptions)

세션의 인스턴스를 만듭니다.

new CallSession(options: ICallSessionOptions)

매개 변수

options

ICallSessionOptions

세션 구성 옵션입니다.

속성 세부 정보

conversationData

대화의 모든 구성원에게 표시되는 공유 대화 데이터입니다.

conversationData: any

속성 값

any

dialogData

현재 대화 상자에만 표시되는 데이터입니다.

dialogData: any

속성 값

any

library

대화 상자의 봇 루트 라이브러리입니다.

library: Library

속성 값

Library

message

사용자로부터 받은 메시지입니다. 봇에서 시작된 메시지의 경우 "to" & "from" 필드만 포함할 수 있습니다.

message: IEvent

속성 값

IEvent

privateConversationData

사용자에게만 표시되는 비공개 대화 데이터입니다.

privateConversationData: any

속성 값

any

sessionState

세션 현재 상태 정보입니다.

sessionState: ISessionState

속성 값

ISessionState

userData

봇과의 모든 대화에서 유지되는 사용자에 대한 데이터입니다.

userData: any

속성 값

any

메서드 세부 정보

answer()

수동으로 통화에 응답합니다. 봇이 작업을 수행할 때 호출이 자동으로 응답됩니다.

function answer()

반환

CallSession

beginDialog<T>(string, T)

대화 컨트롤을 새 대화 상자에 전달합니다. 현재 대화 상자는 자식 대화 상자가 완료될 때까지 일시 중단됩니다. 자식이 종료되면 현재 대화 상자는 자식에서 반환된 결과를 검사할 수 있는 dialogResumed() 대한 호출을 받습니다.

function beginDialog<T>(id: string, args?: T)

매개 변수

id

string

시작할 대화 상자의 고유 ID입니다.

args

T

(선택 사항) begin() 메서드를 대화 상자에 전달할 인수입니다.

반환

CallSession

dispatch(ISessionState, IEvent)

처리를 위해 메시지를 디스패치합니다. 세션은 메시지를 처리하기 위해 활성 대화 상자에 메시지 앞에 설치된 미들웨어를 호출합니다.

function dispatch(sessionState: ISessionState, message: IEvent)

매개 변수

sessionState

ISessionState

현재 세션 상태입니다. null 구성된 dialogId시작하여 새 대화가 시작됩니다.

message

IEvent

디스패치할 메시지입니다.

반환

CallSession

endConversation(string | string[] | IAction | IIsAction, any[])

현재 대화를 종료하고 필요에 따라 사용자에게 메시지를 보냅니다. 통화가 자동으로 중단되거나 거부됩니다.

function endConversation(action?: string | string[] | IAction | IIsAction, args: any[])

매개 변수

action

string | string[] | IAction | IIsAction

(선택 사항)

• 작업:{string} - 보낼 메시지의 텍스트입니다. 메시지는 구성된 로캘라이저 세션을 사용하여 지역화됩니다. 메시지에 인수가 전달되면 sprintf-js사용하여 형식이 지정됩니다.
• 작업:{string[]} - 보낸 메시지가 배열에서 임의로 선택됩니다.
• 작업:{IAction|IIsAction} - 보낼 작업입니다.

args

any[]

(선택 사항) 메시지 {string|string[]}때 최종 출력 텍스트의 서식을 지정하는 데 사용되는 인수입니다.

반환

CallSession

endDialog(string | string[] | IAction | IIsAction, any[])

현재 대화 상자를 종료하고 필요에 따라 사용자에게 메시지를 보냅니다. 완료된이유로 IDialogResult.resumed을 사용하여 부모가 다시 시작됩니다.

function endDialog(action?: string | string[] | IAction | IIsAction, args: any[])

매개 변수

action

string | string[] | IAction | IIsAction

(선택 사항)

• 작업:{string} - 보낼 메시지의 텍스트입니다. 메시지는 구성된 로캘라이저 세션을 사용하여 지역화됩니다. 메시지에 인수가 전달되면 sprintf-js사용하여 형식이 지정됩니다.
• 작업:{string[]} - 보낸 메시지가 배열에서 임의로 선택됩니다.
• 작업:{IAction|IIsAction} - 보낼 작업입니다.

args

any[]

(선택 사항) 메시지 {string|string[]}때 최종 출력 텍스트의 서식을 지정하는 데 사용되는 인수입니다.

반환

CallSession

endDialogWithResult(IDialogResult<any>)

현재 대화 상자를 종료하고 필요에 따라 대화 부모에 결과를 반환합니다.

function endDialogWithResult(result?: IDialogResult<any>)

매개 변수

result

IDialogResult<any>

반환

CallSession

error(Error)

오류가 발생했음을 알 수 있습니다. 봇은 on('error', err) 이벤트를 통해 오류 신호를 전송합니다.

function error(err: Error)

매개 변수

err

Error

발생한 오류입니다.

반환

CallSession

gettext(string, any[])

메시지 언어에 대한 지역화된 문자열을 로드합니다. 인수가 전달되면 지역화된 문자열이 템플릿으로 처리되고 sprintf-js 사용하여 형식이 지정됩니다(자세한 내용은 해당 문서 참조).

function gettext(msgid: string, args: any[])

매개 변수

msgid

string

지역화된 문자열 테이블에서 키로 사용할 문자열입니다. 일반적으로 문자열의 영어 버전일 뿐입니다.

args

any[]

(선택 사항) 최종 출력 문자열의 형식을 지정하는 데 사용되는 인수입니다.

반환

string

hangup()

설정된 호출을 수동으로 종료합니다. 봇이 사용자에게 입력하라는 메시지를 중지하면 호출이 자동으로 종료됩니다.

function hangup()

반환

CallSession

isReset()

세션이 다시 설정되면 true를 반환합니다.

function isReset()

반환

boolean

messageSent()

이 세션에 대한 메시지를 보낸 경우 true를 반환합니다.

function messageSent()

반환

boolean

ngettext(string, string, number)

메시지 언어에 대한 지역화된 문자열의 복수 형식을 로드합니다. 출력 문자열은 문자열의 %d 개수로 바꿔 개수를 포함하도록 형식이 지정됩니다.

function ngettext(msgid: string, msgid_plural: string, count: number)

매개 변수

msgid

string

지역화된 문자열 테이블에서 키로 사용할 문자열의 단수 형식입니다. %d 사용하여 개수를 이동해야 하는 위치를 지정합니다.

msgid_plural

string

지역화된 문자열 테이블에서 키로 사용할 문자열의 복수 형식입니다. %d 사용하여 개수를 이동해야 하는 위치를 지정합니다.

count

number

문자열의 단수 또는 복수 형식을 사용해야 하는지 여부를 결정할 때 사용할 개수입니다.

반환

string

on(string, Function)

이벤트 수신기를 등록합니다.

function on(event: string, listener: Function)

매개 변수

event

string

이벤트의 이름입니다. 이벤트 유형:

• 오류: 오류가 발생했습니다. IErrorEvent

listener

Function

호출할 함수입니다.

reject()

들어오는 호출을 거부합니다.

function reject()

반환

CallSession

replaceDialog<T>(string, T)

현재 대화 상자를 종료하고 새 대화 상자를 시작합니다. 부모 대화는 새 대화가 완료될 때까지 다시 시작되지 않습니다.

function replaceDialog<T>(id: string, args?: T)

매개 변수

id

string

시작할 대화 상자의 고유 ID입니다.

args

T

(선택 사항) begin() 메서드를 대화 상자에 전달할 인수입니다.

반환

CallSession

reset(string, any)

세션 호출 스택을 지우고 구성된 dialogId를 사용하여 대화를 다시 시작합니다.

function reset(dialogId?: string, dialogArgs?: any)

매개 변수

dialogId

string

(선택 사항) 시작할 대화 상자의 ID입니다.

dialogArgs

any

(선택 사항) begin() 메서드를 대화 상자에 전달할 인수입니다.

반환

CallSession

save()

dialogData, userData, conversationdata또는 [privateConversationData'(#privateconversationdata)에 대한 변경 내용 저장을 트리거합니다.

function save()

반환

CallSession

send(string | string[] | IAction | IIsAction, any[])

사용자에게 PlayPrompt 작업을 보냅니다.

function send(action: string | string[] | IAction | IIsAction, args: any[])

매개 변수

action

string | string[] | IAction | IIsAction

• 작업:{string} - 보낼 메시지의 텍스트입니다. 메시지는 구성된 로캘라이저 세션을 사용하여 지역화됩니다. 메시지에 인수가 전달되면 sprintf-js사용하여 형식이 지정됩니다.
• 작업:{string[]} - 보낸 메시지가 배열에서 임의로 선택됩니다.
• 작업:{IAction|IIsAction} - 보낼 작업입니다.

args

any[]

(선택 사항) 작업 {string|string[]} 때 최종 출력 텍스트의 서식을 지정하는 데 사용되는 인수입니다.

반환

CallSession

sendBatch()

현재 일괄 처리를 즉시 종료하고 대기 중인 메시지를 배달합니다.

function sendBatch()