User represents a person who has been authenticated with the Velt SDK.
User has been authenticated, their profile can be seen within Velt’s collaboration features.
For example in the
Comments feature, the
User's name is shown by their comment and in
Additionally in the
Presence and in
Cursors features, the
User's name is shown by their avatar bubble and mouse cursors.
User has the following schema:
|The user’s unique identifier.|
|The user’s display name.|
|The user’s email address.|
|The URL of the user’s profile photo.|
|Your user’s group ID|
|An array of User Contact objects|
|Your user’s plan|
Users in the same group get added to each other’s contact list.
Over time, as
Users from the same
groupId sign in, they will be automatically added to each other’s contact list.
They can then
@mention or assign each other when they make comments.
User contacts list
UserContacts are used to load the list of people that a user can
@mention or assign when they make a comment. As we mentioned before,
Users in the same
groupId will get added to each other’s contact lists.
A User has a
contacts attribute that has an array of
UserContact objects. A
UserContact has the following schema:
|Unique user identifier that you use to identify your user|
|Your user’s full name|
|Your user’s avatar URL|
|Your user’s email|
|Your user’s group ID (only used for reference)|
|Either ‘private’ or ‘group’|
You can set the
UserContacts list to be empty initially or you can preload it with a list of contacts upon user authentication. If you preload the contact list, other members of the authenticated
groupId will also see the preloaded contacts unless the
visibility set to
User contact visibility
visibility attribute on a
UserContact object is either set to
When it is set to
private, they will only be added to the authenticated
User's contact list and will not be added to any other
User's contact list even if they have the same
When it is set to
group, they will be added to the contact lists of all
User's with the same
groupId as the authenticated