Options
All
  • Public
  • Public/Protected
  • All
Menu

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

  • object
    • UserInfo

Index

Properties

Optional first_name

first_name: undefined | string

The users's first name

Optional frontend

frontend: undefined | string

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

Optional last_name

last_name: undefined | string

The users's last name

Optional locale

locale: undefined | 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: undefined | string

URL of the profile picture

Optional tags

tags: string[]

A list of tags set on the user

Optional timezone

timezone: undefined | string

The users's timezone

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc