Set User Presence
    • Dark
      Light
    • PDF

    Set User Presence

    • Dark
      Light
    • PDF

    Article summary

    Set the user presence status. By default, there are four different statuses available in your workspace:

    • online

    • busy

    • away

    • offline

    Set default user presence status

    Method

    Requires Auth

    UserPresence:setDefaultStatus

    Yes

    /Payload parameters

    Argument

    Example

    Required

    Description

    status

    online

    Required

    The user presence status to be set as default.

    Example call

    {
        "msg": "method",
        "method": "UserPresence:setDefaultStatus",
        "id": "42",
        "params": [ "online" ]
    }

    Example response

    {
        "msg": "result",
        "id": "42",
        "result": true
    }

    Set temporary user presence status

    To set a temporary status, send a request to UserPresence:{status} with empty parameters. It only accepts either of these two status options: away and online. It is particularly useful when the client detects that the user is currently not actively using the application (thus "away") and when the user returns, indicating they are "online" again.

    Method

    Requires Auth

    UserPresence:away

    Yes

    Example call

    {
        "msg": "method",
        "method": "UserPresence:away",
        "id": "47",
        "params":[]
    }

    Example response

    {
        "msg": "result",
        "id": "42",
        "result": true
    }


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence