Interface UserInfo

Contains the information that is known about the user.

Any key / value properties can be set in the information, using [[ChatBubble.putUserInfo]]. The properties listed here are special, in the sense that they are used by the platform. Some properties (tags, frontend) cannot be updated through the putUserInfo call.

Hierarchy

  • Record<string, any>
    • UserInfo

Properties

first_name? frontend? last_name? locale? profile_picture? tags? timezone? user_data?

Properties

Optional first_name

first_name?: string

The users's first name

Optional frontend

frontend?: string

The primary channel that the user users to chat with the bot

Optional last_name

last_name?: string

The users's last name

Optional locale

locale?: string

The user's locale. Note that this locale can be different than the one that is passed in to [[ChatBubble]]; the bot might have decided to switch locale.

Optional profile_picture

profile_picture?: string

URL of the profile picture

Optional tags

tags?: string[]

A list of tags set on the user

Optional timezone

timezone?: string

The users's timezone

Optional user_data

user_data?: Record<string, any>

Any additional data

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc