Models
User
User
Class Properties
Property | Type | Optional | Description |
---|---|---|---|
userId | string | No | Unique user identifier used to identify your user. |
name | string | Yes | The full name of your user. Defaults to a random avatar name if not provided. |
photoUrl | string | Yes | The display picture URL of your user. Defaults to a random avatar image if not provided. |
email | string | Yes | Required for sending email or Slack notifications to users about comments and mentions. |
plan | string | Yes | The product plan the user is on. |
organizationId | string | Yes | Autogenerated organizationId based on the organizationId you provide. |
clientorganizationId | string | Yes | The original organizationId provided by you. |
color | string | Yes | A color assigned to the user for the current session, used for avatar border, live cursor, selection etc. |
textColor | string | Yes | Used in the text color of the user’s intial when photoUrl is not present. |
type | string | Yes | The type of user. |
isReadOnly | boolean | Yes | Indicates if the user has read-only access. |
isAnonymous | boolean | Yes | Indicates if the user is anonymous and can only view comments. |
isGuest | boolean | Yes | Indicates if the user is a guest. |
groupId | string | Yes | [DEPRECATED] A domain name or identifier used to cluster a group of users who work together. |
clientGroupId | string | Yes | [DEPRECATED] The original groupId provided by the user. |
initial | string | Yes | First letter of the user’s first name. |
UserOptions
Class Properties
Property | Type | Optional | Description |
---|---|---|---|
replaceContacts | boolean | Yes | If set to true, it will replace the user’s personal and group contacts with the ones provided. |
authToken | string | Yes | The authentication token of the user. |
Was this page helpful?