이 문서에서는 유저 객체에 대해 설명합니다.
유저 객체의 예시를 참고합니다.
id
| 타입 | 설명 |
|---|---|
string | 유저의 id. |
memberId
멤버 유저를 생성하기 위해서는
memberId를 사용해야 합니다.
| 타입 | 설명 |
|---|---|
string | 멤버 유저를 식별할 때 사용되는 id. 부트 옵션에 memberId를 전달할 경우 멤버 유저로 인식됩니다. |
name
| 타입 | 설명 |
|---|---|
string | undefined | 유저의 이름. 유저의 이름을 설정하기 위해서는 부트 옵션의 profile이나 updateUser를 사용합니다. |
avatarUrl
| 타입 | 설명 |
|---|---|
string | 유저의 아바타 이미지 URL. |
unread
| 타입 | 설명 |
|---|---|
number | 유저가 읽지 않은 모든 메시지의 수.alert 메시지의 수를 포함합니다. 채널 버튼에서 빨간 점으로 알림이 표현됩니다. |
alert
| 타입 | 설명 |
|---|---|
number | 유저가 읽지 않은 주요 메시지의 수. 채널 버튼에서 숫자로 알림이 표현됩니다. |
profile
| 타입 | 설명 |
|---|---|
object | undefined | 유저의 프로필 정보를 담고 있는 객체. 유저의 프로필을 설정하기 위해서는 부트 옵션의 profile이나 updateUser를 사용합니다. |
onFollowUpChanged는 유저가 프로필을 변경했을 때 실행될 콜백 함수를 등록합니다.
unsubscribeEmail
| 타입 | 설명 |
|---|---|
boolean | 유저의 마케팅 이메일 수신을 거부할지 여부. updateUser나 부트 옵션의 unsubscribeEmail로 설정할 수 있습니다. |
unsubscribeTexting
| 타입 | 설명 |
|---|---|
boolean | 유저의 마케팅 SMS 수신을 거부할지 여부. updateUser나 부트 옵션의 unsubscribeTexting으로 설정할 수 있습니다. |
tags
| 타입 | 설명 |
|---|---|
string[] | 유저의 태그 리스트. 태그는 소문자로 구성됩니다. updateUser와 addTags, removeTags로 설정할 수 있습니다. |
language
| 타입 | 설명 |
|---|---|
string | 유저의 언어. 번역 언어로 사용됩니다. updateUser와 부트 옵션의 language로 설정할 수 있습니다. 다음 32개의 언어를 지원합니다. : 'de'(German), 'hi'(Hindi), 'no'(Norwegian), 'ru'(Russian), 'fi'(Finnish), 'pt'(Portuguese), 'hr'(Croatian), 'fr'(French), 'hu'(Hungarian), 'uk'(Ukrainian), 'sk'(Slovak), 'ca'(Catalan), 'sv'(Swedish), 'ko'(Korean), 'id'(Indonesian), 'ms'(Malay), 'el'(Greek), 'en'(English), 'it'(Italian), 'es'(Spanish), 'he'(Hebrew), 'zh'(Chinese), 'cs'(Czech), 'ar'(Arabic), 'vi'(Vietnamese),'th'(Thai), 'ja'(Japanese), 'pl'(Polish), 'ro'(Romanian), 'da'(Danish), 'nl'(Dutch), 'tr'(Turkish) |
예시
{
"id": "USER_ID",
"memberId": "MEMBER_ID",
"name": "USER_NAME",
"avatarUrl": "AVATAR_URL",
"unread": 5,
"alert": 3,
"profile": {
"name": "USER_NAME",
"email": "USER_EMAIL",
"mobileNumber": "+821012345678",
"CUSTOM_VALUE_1": "VALUE_1",
"CUSTOM_VALUE_2": "VALUE_2"
},
"unsubscribeEmail": true,
"unsubscribeTexting": true,
"tags": ["tag1", "tag2"],
"language": "ko"
}