On this page

Manage user updates

Update user details and receive events whenever someone updates them.

Requires App Context

Enable App Context in the Admin Portal to store user data.

Update user details​

Edit user metadata with Update() or UpdateUser().

  • Update() - call on a User object (no ID needed)
  • UpdateUser() - call on a Chat object (requires user ID)

Method signature​

These methods take the following parameters:

  • Update()

    1user.Update(ChatUserData updatedData);
    2

    3public class ChatUserData
    4{
    5    public string Username { get; set; } = string.Empty;
    6    public string ExternalId { get; set; } = string.Empty;
    7    public string ProfileUrl { get; set; } = string.Empty;
    8    public string Email { get; set; } = string.Empty;
    9    public string CustomDataJson { get; set; } = string.Empty;
    10    public string Status { get; set; } = string.Empty;
    11    public string Type { get; set; } = string.Empty;
    12}

  • UpdateUser()

    1chat.UpdateUser(
    2    string Id, 
    3    ChatUserData updatedData
    4)
    5

    6public class ChatUserData
    7{
    8    public string Username { get; set; } = string.Empty;
    9    public string ExternalId { get; set; } = string.Empty;
    10    public string ProfileUrl { get; set; } = string.Empty;
    11    public string Email { get; set; } = string.Empty;
    12    public string CustomDataJson { get; set; } = string.Empty;
    13    public string Status { get; set; } = string.Empty;
    14    public string Type { get; set; } = string.Empty;
    15}

Input​

ParameterRequired in Update()Required in UpdateUser()Description
Id
Type: string
Default:
n/a
No
Yes
Unique user identifier.
 → Username
Type: string
Default:
n/a
No
No
Display name for the user (must not be empty or consist only of whitespace characters).
 → ExternalId
Type: string
Default:
n/a
No
No
User's identifier in an external system. You can use it to match Id with a similar identifier from an external database.
 → ProfileUrl
Type: string
Default:
n/a
No
No
URL of the user's profile picture.
 → Email
Type: string
Default:
n/a
No
No
User's email address.
 → CustomDataJson
Type: ObjectCustom
Default:
n/a
No
No
JSON providing custom data about the user. Values must be scalar only; arrays or objects are not supported. Filtering App Context data through the custom property is not recommended in SDKs.
 → Status
Type: string
Default:
n/a
No
No
Tag that lets you categorize your app users by their current state. The tag choice is entirely up to you and depends on your use case. For example, you can use status to mark users in your chat app as Invited, Active, or Archived.
 → Type
Type: string
Default:
n/a
No
No
Tag that lets you categorize your app users by their functional roles. The tag choice is entirely up to you and depends on your use case. For example, you can use type to group users by their roles in your app, such as Moderator, Player, or Support-Agent.
API limits

To learn about the maximum length of parameters used to set user metadata, refer to REST API docs.

Output​

Both methods return an awaitable Task.

Sample code​

Change the link to the user's support_agent_15 LinkedIn profile to https://www.linkedin.com/mkelly_vp2.

  • Update()

    1

  • UpdateUser()

    1

Get user updates​

Receive updates when User objects are edited or deleted:

  • StreamUpdates() - monitors a single user
  • StreamUpdatesOn() - monitors multiple users

Both methods accept a callback invoked when user metadata changes. They subscribe to a channel and add an objects event listener for uuid events.

Call StreamUpdates(true) to enable the OnUpdated and OnDeleted events on the user entity. OnUpdated fires when user metadata changes. OnDeleted fires when the user is hard-deleted from App Context.

Method naming

Earlier versions used SetListeningForUpdates() to enable streaming. This method has been superseded by StreamUpdates(), though it remains available for backward compatibility.

Method signature​

These methods take the following parameters:

  • StreamUpdates()

    1user.StreamUpdates(bool stream)

  • OnUpdated

    1// event on the User entity
    2public event Action<User> OnUpdated;
    3// needs a corresponding event handler
    4void EventHandler(User user)

  • OnDeleted

    1// event on the User entity
    2public event Action OnDeleted;
    3// needs a corresponding event handler
    4void EventHandler()

  • StreamUpdatesOn() (static)

    1User.StreamUpdatesOn(
    2    List<User> users,
    3    Action<User> listener
    4)

Input​

ParameterRequired in StreamUpdates()Required in OnUpdated / OnDeletedRequired in StreamUpdatesOn()Description
stream
Type: bool
Default:
n/a
Yes
n/a
n/a
Whether to start (true) or stop (false) listening to User object updates.
users
Type: List<User>
Default:
n/a
No
No
Yes
List of User objects for which you want to get updates.
listener
Type: Action<User>
Default:
n/a
No
No
Yes
Callback that receives the specific user that was updated.

Output​

These methods don't return a value. Updates are delivered through event handlers or callback functions.

Sample code​

  • StreamUpdates() and OnUpdated

    Get updates on support_agent_15.

    1

  • StreamUpdatesOn()

    Get updates on support-agent-1 and support-agent-2.

    1
Last updated on
On this page