User Object

string

ユーザーのID

string

Member userを識別するために使用されるID。

Boot OptionでmemberIdが指定されている場合、そのユーザーはメンバーユーザーとみなされます。

string | undefined

ユーザーの名前

updateUserを介して設定されます。

string

ユーザーのアバター画像のURL

number

ユーザーの未読通知の総数。

これにはアラートの数も含まれます。チャネルボタン上に赤い点が表示されます。

number

ユーザーにとって重要な未読通知の数。

チャネルボタン上に数字として表示されます。

object | undefined

ユーザーのプロフィール情報。

updateUserを介して、またはブートオプションの profileを使用して設定されます。

boolean

ユーザーがマーケティングメールの受信を拒否（オプトアウト）しているかどうかを示します。

updateUserを介して、またはブートオプションの unsubscribeEmailを使用して設定されます。

boolean

ユーザーがマーケティングSMSの受信を拒否（オプトアウト）しているかどうかを示します。

updateUserを介して、またはブートオプションの unsubscribeTextingを使用して設定されます。

string[]

ユーザーに関連付けられたタグのリスト。すべてのタグは小文字で保持されます。

updateUser、addTags、またはremoveTagsを介して設定・操作されます。

string

ユーザーの言語設定。翻訳目的で使用されます。

updateUserを介して、またはブートオプションの languageを指定することで設定されます。

以下の32言語がサポートされています。

'de'(ドイツ語)、'hi'(ヒンディー語)、'no'(ノルウェー語)、'ru'(ロシア語)、'fi'(フィンランド語)、'pt'(ポルトガル語)、'hr'(クロアチア語)、'fr'(フランス語)、'hu'(ハンガリー語)、'uk'(ウクライナ語)、'sk'(スロバキア語)、'ca'(カタルーニャ語)、'sv'(スウェーデン語)、'ko'(韓国語)、'id'(インドネシア語)、'ms'(マレー語)、'el'(ギリシャ語)、'en'(英語)、'it'(イタリア語)、'es'(スペイン語)、'he'(ヘブライ語)、'zh'(中国語)、'cs'(チェコ語)、'ar'(アラビア語)、'vi'(ベトナム語)、'th'(タイ語)、'ja'(日本語)、'pl'(ポーランド語)、'ro'(ルーマニア語)、'da'(デンマーク語)、'nl'(オランダ語)、'tr'(トルコ語)