Skip to content

docs: ✏️ Add embedded Field for Client Status Object #7733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: ✏️ Add embedded Field for Client Status Object #7733

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/events/gateway-events.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1123,11 +1123,12 @@ The user object within this event can be partial, the only field which must be s

Active sessions are indicated with an "online", "idle", or "dnd" string per platform. If a user is offline or invisible, the corresponding field is not present.

| Field | Type | Description |
|----------|--------|-----------------------------------------------------------------------------------|
| desktop? | string | User's status set for an active desktop (Windows, Linux, Mac) application session |
| mobile? | string | User's status set for an active mobile (iOS, Android) application session |
| web? | string | User's status set for an active web (browser, bot user) application session |
| Field | Type | Description |
|-----------|--------|-------------------------------------------------------------------------------------------|
| desktop? | string | User's status set for an active desktop (Windows, Linux, Mac) application session |
| mobile? | string | User's status set for an active mobile (iOS, Android) application session |
| web? | string | User's status set for an active web (browser, bot user) application session |
| embedded? | string | User's status set for an active embedded (Xbox, PlayStation, in-game) application session |

#### Activity Object

Expand Down