API 참조 문서

ccaas 웹 SDK 인스턴스의 인터페이스입니다.

속성

이 섹션에는 사용할 수 있는 속성이 포함되어 있습니다.

version

웹 SDK 버전입니다.

console.log(ccaas.VERSION)

클라이언트

이는 헤드리스 클라이언트의 인스턴스이며 헤드리스 클라이언트에서 사용할 수 있는 모든 항목이 포함되어 있습니다.

예를 들면 다음과 같습니다.

const client = ccaas.client
const chat = await client.loadOngoingChat()

메서드

위젯 인스턴스에서 사용할 수 있는 메서드입니다.

.config

위젯의 구성을 업데이트합니다.

ccaas.config({
  accent: 'green'
})

자세한 내용은 구성 섹션을 참고하세요.

.mount

지정된 요소에 위젯을 마운트합니다. 예를 들어 웹페이지에서 다음과 같이 지정합니다.

<div id="my-ccaas"></div>

그런 다음 다음을 사용하여 웹 SDK 위젯을 마운트할 수 있습니다.

ccaas.mount('#my-ccaas')

.unmount

웹페이지에서 웹 SDK 위젯을 삭제합니다.

ccaas.unmount()

.destroy

모든 것을 마운트 해제하고 삭제합니다.

ccaas.destroy()

.show

위젯 UI를 표시합니다.

ccaas.show()

.hide

위젯 UI를 숨깁니다.

ccaas.hide()

.start

지정된 옵션으로 위젯을 표시하고 시작합니다.

interface StartOption {
  menuKey?: string;
  ticketId?: string;
  preferredChannel?: string;
}

예:

ccaas.start({ menuKey: 'vip' })

이벤트

이 섹션에서는 웹 SDK에서 사용할 수 있는 이벤트를 설명합니다. 헤드리스 웹 SDK에서 사용할 수 있는 이벤트의 전체 목록은 헤드리스 웹 SDK 이벤트를 참고하세요.

.on 메서드를 사용하여 이벤트 리스너를 추가합니다. 아래 예시를 참조하세요.

const trackChat = (chat) => {
  console.log(chat)
}

ccaas.on('chat.updated', trackChat)

.off 메서드를 사용하여 이벤트 리스너를 삭제합니다. 아래 예시를 참조하세요.

ccaas.off('chat.updated', trackChat)

.on 및 .off 메서드는 헤드리스 웹 SDK의 .on 및 .off 메서드의 별칭입니다. 자세한 내용은 헤드리스 웹 SDK 가이드를 참고하세요.

표시

visible 이벤트는 위젯이 통신할 준비가 되면 발생합니다.

다음 예시는 visible 이벤트를 보여줍니다.

ccaas.on('visible', (visible) => {
  console.log(visible)  // true or false
})

chat.unread

chat.unread 이벤트는 읽지 않은 메시지 수가 변경될 때 발생합니다.

다음 예시는 chat.unread 이벤트를 보여줍니다.

ccaas.on('chat.unread', (count) => {
  console.log(count)
})

종료됨

exited 이벤트는 최종 사용자가 위젯을 닫을 때 발생합니다.

다음 예시는 exited 이벤트를 보여줍니다.

ccaas.on('exited', () => {
  // widget was exited
})