Skip to content

Updated identify connection fields to match deprecation status. #5067

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

Merged
merged 6 commits into from
Jun 17, 2022
Merged

Updated identify connection fields to match deprecation status. #5067

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
57780a8
Updated identify connection fields to match deprecation status.
DV8FromTheWorld Jun 16, 2022
20cc568
Update docs/topics/Gateway.md
DV8FromTheWorld Jun 16, 2022
573da9a
add identify changelog
shaydewael Jun 17, 2022
f8c4ae2
Merge branch 'main' into docs/update-identify-field
shaydewael Jun 17, 2022
01319bc
ayyy explicit api versions
shaydewael Jun 17, 2022
3214fa1
Update docs/topics/Gateway.md
shaydewael Jun 17, 2022
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
8 changes: 8 additions & 0 deletions docs/Change_Log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Change Log

## Updated Connection Property Field Names

#### Jun 17, 2022

The `$` prefix in [identify connection properties](#DOCS_TOPICS_GATEWAY/identify-identify-connection-properties) are deprecated. The new field names are `os`, `browser`, and `device`. When passed, the `$`-prefixed names will resolve to the new ones.

In API v11, support for the previous field names (`$os`, `$browser`, and `$device`) will be removed.

## Auto Moderation

#### Jun 16, 2022
Expand Down
25 changes: 14 additions & 11 deletions docs/topics/Gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,9 @@ This is a minimal `IDENTIFY` payload. `IDENTIFY` supports additional optional fi
"token": "my_token",
"intents": 513,
"properties": {
"$os": "linux",
"$browser": "my_library",
"$device": "my_library"
"os": "linux",
"browser": "my_library",
"device": "my_library"
}
}
}
Expand Down Expand Up @@ -570,11 +570,14 @@ Used to trigger the initial handshake with the gateway.

###### Identify Connection Properties

| Field | Type | Description |
| --------- | ------ | --------------------- |
| \$os | string | your operating system |
| \$browser | string | your library name |
| \$device | string | your library name |
| Field | Type | Description |
| ------ | ------ |-----------------------|
| os | string | your operating system |
| browser | string | your library name |
| device | string | your library name |

> warn
> These fields originally were $ prefixed (i.e: `$browser`) but [this syntax is deprecated](#DOCS_CHANGE_LOG/updated-connection-property-field-names). While they currently still work, it is recommended to move to non-prefixed fields.

###### Example Identify

Expand All @@ -584,9 +587,9 @@ Used to trigger the initial handshake with the gateway.
"d": {
"token": "my_token",
"properties": {
"$os": "linux",
"$browser": "disco",
"$device": "disco"
"os": "linux",
"browser": "disco",
"device": "disco"
},
"compress": true,
"large_threshold": 250,
Expand Down