This repository has been archived by the owner on Nov 27, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation changes to bring current to 2016-03-01
- Loading branch information
Showing
197 changed files
with
4,013 additions
and
524 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# dnd_updated event | ||
|
||
{ | ||
"type": "dnd_updated", | ||
"user": "U1234", | ||
"dnd_status": { | ||
"dnd_enabled": true, | ||
"next_dnd_start_ts": 1450387800, | ||
"next_dnd_end_ts": 1450423800, | ||
"snooze_enabled": true, | ||
"snooze_endtime": 1450373897 | ||
} | ||
} | ||
|
||
The `dnd_updated` event is sent to the current user when their Do Not Disturb settings have changed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# dnd_updated_user event | ||
|
||
{ | ||
"type": "dnd_updated_user", | ||
"user": "U1234", | ||
"dnd_status": { | ||
"dnd_enabled": true, | ||
"next_dnd_start_ts": 1450387800, | ||
"next_dnd_end_ts": 1450423800 | ||
} | ||
} | ||
|
||
The `dnd_updated_user` event is sent to all connections for a team when a user's Do Not Disturb settings have changed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,9 @@ | ||
# group_archive event type | ||
|
||
{ | ||
"type": "group_archive", | ||
"channel": "G024BE91L" | ||
} | ||
{ | ||
"type": "group_archive", | ||
"channel": "G024BE91L" | ||
} | ||
|
||
The `group_archive` event is sent to all connections for members of a private | ||
group when that group is archived. Clients can use this to update their local | ||
list of private groups. | ||
channel when that private channel is archived. Clients can use this to update their local list of private channels. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
# group_close event type | ||
|
||
{ | ||
"type": "group_close", | ||
"user": "U024BE7LH", | ||
"channel": "G024BE91L" | ||
} | ||
{ | ||
"type": "group_close", | ||
"user": "U024BE7LH", | ||
"channel": "G024BE91L" | ||
} | ||
|
||
The `group_close` event is sent to all connections for a user when a private | ||
group is closed by that user. | ||
channel is closed by that user. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,10 @@ | ||
# group\_history\_changed message | ||
|
||
{ | ||
"type": "group_history_changed", | ||
"latest": "1358877455.000010" | ||
"ts": "1361482916.000003", | ||
"event_ts": "1361482916.000004" | ||
} | ||
{ | ||
"type": "group_history_changed", | ||
"latest": "1358877455.000010", | ||
"ts": "1361482916.000003", | ||
"event_ts": "1361482916.000004" | ||
} | ||
|
||
A `group_history_changed` event is sent to all clients in a group when bulk | ||
changes have occured to that group's history. When clients recieve this | ||
message they should reload chat history for the group if they have any cached | ||
messages before `latest`. | ||
A `group_history_changed` event is sent to all clients in a private channel when bulk changes have occurred to that group's history. When clients receive this message they should reload chat history for the private channel if they have any cached messages before `latest`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
# group_joined event type | ||
|
||
{ | ||
"type": "group_joined", | ||
"channel": { | ||
… | ||
} | ||
} | ||
{ | ||
"type": "group_joined", | ||
"channel": { | ||
... | ||
} | ||
} | ||
|
||
The `group_joined` event is sent to all connections for a user when that user | ||
joins a private group. In addition to this message, all existing members of | ||
the group will recieve a [`group_join` message event](/events/message/group_join). | ||
joins a private channel. In addition to this message, all existing members of | ||
the private channel will receive a [`group_join` message event](/events/message/group_join). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,15 @@ | ||
# group_left event type | ||
|
||
{ | ||
"type": "group_left", | ||
"channel": { | ||
… | ||
} | ||
} | ||
{ | ||
"type": "group_left", | ||
"channel": "G02ELGNBH" | ||
} | ||
|
||
The `group_left` event is sent to all connections for a user when that user | ||
leaves a private group. Clients should respond to this message by closing the | ||
group - this means that when a group is left from client A, it will | ||
automatically be closed in client B. | ||
leaves a private channel. Clients should respond to this message by closing the | ||
private channel - this means that when a private channel is left from client A, it will automatically be closed in client B. | ||
|
||
In addition to this message, all existing members of the group will recieve a | ||
The `channel` value is the string identifier for the private channel. | ||
|
||
In addition to this message, all existing members of the group will receive a | ||
[`group_leave` message event](/events/message/group_leave). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
# group_marked event type | ||
|
||
{ | ||
"type": "group_marked", | ||
"channel": "G024BE91L", | ||
"ts": "1401383885.000061" | ||
} | ||
{ | ||
"type": "group_marked", | ||
"channel": "G024BE91L", | ||
"ts": "1401383885.000061" | ||
} | ||
|
||
The `group_marked` event is sent to all open connections for a user when | ||
that user moves the read cursor in a private group by calling the | ||
that user moves the read cursor in a private channel by calling the | ||
[groups.mark API method](/methods/groups.mark). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,12 @@ | ||
# group_rename event type | ||
|
||
{ | ||
"type": "group_rename", | ||
"channel": { | ||
"id":"G02ELGNBH", | ||
"name":"new_name", | ||
"created":1360782804 | ||
} | ||
} | ||
{ | ||
"type": "group_rename", | ||
"channel": { | ||
"id":"G02ELGNBH", | ||
"name":"new_name", | ||
"created":1360782804 | ||
} | ||
} | ||
|
||
The `group_rename` event is sent to all connections for members of a private | ||
group when that group is renamed. Clients can use this to update their local | ||
list of private groups. | ||
When a private channel is renamed, the `group_rename` event is sent to all connections for members of a private channel. Clients can use this to update their local list of private channels. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,9 @@ | ||
# group_unarchive event type | ||
|
||
{ | ||
"type": "group_unarchive", | ||
"channel": "G024BE91L" | ||
} | ||
{ | ||
"type": "group_unarchive", | ||
"channel": "G024BE91L" | ||
} | ||
|
||
The `group_unarchive` event is sent to all connections for members of a private | ||
group when that group is unarchived. Clients can use this to update their local | ||
list of private groups. | ||
channel when that private channel is unarchived. Clients can use this to update their local list of private channels. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# mpim_close event type | ||
|
||
{ | ||
"type": "mpim_close", | ||
"user": "U024BE7LH", | ||
"channel": "G024BE91L" | ||
} | ||
|
||
The `mpim_close` event is sent to all connections for a user when a multiparty direct message | ||
is closed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# mpim\_history\_changed message | ||
|
||
{ | ||
"type": "mpim_history_changed", | ||
"latest": "1358877455.000010" | ||
"ts": "1361482916.000003", | ||
"event_ts": "1361482916.000004", | ||
"is_mpim": 1, | ||
} | ||
|
||
A `mpim_history_changed` event is sent to all clients in a mpim when bulk | ||
changes have occured to that mpim's history. When clients receive this | ||
message they should reload chat history for the mpim if they have any cached | ||
messages before `latest`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# mpim_joined event type | ||
|
||
{ | ||
"type": "mpim_joined", | ||
"channel": { | ||
"is_mpim":true, | ||
'is_open':false, | ||
… | ||
} | ||
} | ||
|
||
The `mpim_joined` event is sent to all connections for a user when that user | ||
joins a multiparty DM. In addition to this message, `group_joined` and | ||
`group_join` events will also be sent for backwards compatibility, since MPIMs | ||
can also be treated as groups. Clients that are MPIM aware can ignore all | ||
`group_join` and `group_joined` events when the channel's `is_mpim` flag is | ||
set to true. MPIMs will always start closed for everyone but the creator. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# mpim_open event type | ||
|
||
{ | ||
"type": "mpim_open", | ||
"user": "U024BE7LH", | ||
"channel": "G024BE91L" | ||
} | ||
|
||
The `mpim_open` event is sent to all connections for a user when a multiparty direct message | ||
is opened. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# reconnect_url event type | ||
|
||
{ | ||
"type": "reconnect_url" | ||
} | ||
|
||
The `reconnect_url` event is currently unsupported and experimental. |
Oops, something went wrong.