payload 정의

소스라이브 사용과 관련된 payload 정의는 아래와 같습니다.

setInit

매개변수	type	Require	Description
broadcastId	String	true	방송 ID
env	String	false	미사용시 운영으로 처리됩니다. `example('stage')`
platform	String	false	'CAFE24' \| 'SHOPBY' 이커머스 간편 연동을 위한 값입니다.

실제 사용 예시는 라이브러리 기본 사용법 페이지 를 참고해주세요

setFloatingType

매개변수	type	Require	Description
type	'scroll' \| 'basic'	true	플로팅 타입에 대한 정의입니다.
size	width: string; height?: String	false	플로팅 사이즈 정의 , 값은 css 의 값입니다.
restrictionArea	element?: Element; elementId?: String;	false	Object 로 세팅이 필요하며 드래그 가능 영역의 HTML 요소를 지정할수 있습니다. 두개의 값중 하나만 가집니다.
position	position:String; offsetX?:number; offsetY?:number;	false	Object 로 세팅이 필요하며 position 값은 'top left' ,'top right' ,'bottom left' ,bottom right' 4가지로 지정할수 있습니다. 적혀진 위치로 플로팅이 랜딩되머 20 px 떨어진 위치로 지정됩니다. offsetX, offsetY 는 지정된 위치에서 미세조정이 필요시 추가하면 됩니다.
buttonList	string[]	false	buttonList 추가시 Array 로 매계변수 선언이 필요하며 닫기 버튼은 'exit', 확대버튼은 fullscreen 을 Array 에 세팅후 선언가능 (하나만 가능합니다.)

실제 사용 예시는 플로팅 기능 을 참고해주세요

setMemberObject

매개변수	type	Require	Description
nickName	String	true	채팅창에 표기되는 닉네임입니다.
memberId	String	true	고객사 고유의 고객ID 입니다.
gender	String	false	성별 데이
memberType	"0" \| "1"	false	1은 회원 0은 비회원으로 인식됩니다.
age	String	false	나이 데이터

실제 사용 예시는 라이브러리 인증 기능 을 참고해주세요.

setMemberToken

매개변수	type	Require	Description
X	String	true	JWT 토큰

실제 사용 예시는 라이브러리 인증 기능 을 참고해주세요.

Updated 24 days ago