카테고리
API Reference
API Reference
Boot Option
이 문서에서는 boot 시 인자로 전달하는 부트 옵션에 대해 설명합니다. 예시 코드는 시작하기를 참고합니다. 필수 옵션 pluginKey 타입 설명 string 채널의 플러그인 키. 선택 옵션 memberId 타입 설명 string 멤버 유저의 id. customLauncherSelector 타입 설명 string 커스텀 채널 버튼을 선택할 수 있는 CSS 선택자. 기본 채팅 버튼을 커스터마이징할 때 사용합니다. hideChannelButtonOnBoot 타입 설명 boolean 기본 채널 버튼을 숨길지 여부를 설정합니다. 기본값은 `false`입니다. zIndex 타입 설명 number SDK가 생성하는 엘리먼트의 z-index를 설정합니다. 채널 버튼, 메신저, 마케팅 팝업에 적용됩니다. 기본값은 10000000입니다. language 타입 설명 string ('en' | 'ko' | 'ja') 언어의 기본값을 설정합니다. 설정된 언어에 따라 텍스트를 다르게 표시합니다. 유저가
ChannelIO
boot SDK 사용을 위한 초기 설정을 진행합니다. 채널 버튼이 나타나고, 마케팅 팝업 등 여러 기능들이 동작할 준비를 마칩니다. 더 자세한 내용은 부트를 참고하세요. ChannelIO('boot', bootOption: object, callback?: Function) 매개변수 타입 설명 bootOption object SDK 사용을 위한 초기 설정 정보가 담긴 부트 옵션. callback (optional) Function 부트 이후 호출되는 콜백 함수. 부트 실패 시 첫 번째 인자로 에러 객체를, 두 번째 인자로 null을 전달합니다. 부트 성공 시 첫 번째 인자로 null을, 두 번째 인자로 유저 객체를 전달합니다. ChannelIO('boot', { pluginKey: 'YOUR_PLUGIN_KEY' }, function onBoot(error, user) { if (error) { console.error(error); } else { console.log('boot
User Object
이 문서에서는 유저 객체에 대해 설명합니다. 유저 객체의 예시를 참고합니다. id 타입 설명 string 유저의 id. memberId 멤버 유저를 생성하기 위해서는 memberId를 사용해야 합니다. 더 자세한 내용은 부트 옵션의 memberId와 부트하기를 참고합니다. 타입 설명 string 멤버 유저를 식별할 때 사용되는 id. 부트 옵션에 `memberId`를 전달할 경우 멤버 유저로 인식됩니다. name 타입 설명 string | undefined 유저의 이름. 유저의 이름을 설정하기 위해서는 부트 옵션의 profile이나 updateUser를 사용합니다. avatarUrl 타입 설명 string 유저의 아바타 이미지 URL. unread 타입 설명 number 유저가 읽지 않은 모든 메시지의 수. alert 메시지의 수를 포함합니다. 채널 버튼에서 빨간 점으로 알림이 표현됩니다. alert 타입 설명 number 유저가 읽지 않은 주요 메시지의 수. 채널 버튼에서 숫자로
레거시
이 문서에서는 더 이상 지원하지 않거나, 곧 지원이 중단되는 SDK에 대해 설명합니다. 이 문서에 기재된 레거시 SDK는 사용하지 않을 것을 권장합니다. 레거시 SDK는 언제든지 지원 중단될 수 있으며, 이로 인해 에러가 발생할 수 있습니다. 만약 이미 사용 중인 SDK가 있다면, 해당 SDK의 마이그레이션 가이드를 통해 빠른 시일 내에 교체할 것을 권장합니다. ChannelIO show 메신저를 엽니다. ChannelIO('show'); 마이그레이션 가이드 showMessenger를 사용합니다. hide 메신저를 닫습니다. ChannelIO('hide'); 마이그레이션 가이드 hideMessenger를 사용합니다. lounge 홈으로 이동합니다. ChannelIO('lounge'); openSupportBot 해당 API는 Deprecated 되었습니다. openWorkflow API를 사용해주세요. 서포트봇에 대한 지원 종료로 인해 해당 API는 Deprecated 되었으며, 해