Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Commit

Permalink
Documentation changes to bring current to 2016-03-01
Browse files Browse the repository at this point in the history
  • Loading branch information
episod committed Mar 1, 2016
1 parent 6fb9ac4 commit b813d2d
Show file tree
Hide file tree
Showing 197 changed files with 4,013 additions and 524 deletions.
4 changes: 2 additions & 2 deletions events/channel_history_changed.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

{
"type": "channel_history_changed",
"latest": "1358877455.000010"
"latest": "1358877455.000010",
"ts": "1361482916.000003",
"event_ts": "1361482916.000004"
}

A `channel_history_changed` event is sent to all clients in a channel when
bulk changes have occured to that channel's history. When clients recieve this
bulk changes have occured to that channel's history. When clients receive this
message they should reload chat history for the channel if they have any
cached messages before `latest`.
2 changes: 1 addition & 1 deletion events/channel_joined.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@

The `channel_joined` event is sent to all connections for a user when that
user joins a channel. In addition to this message, all existing members of the
channel will recieve a [`channel_join` message event](/events/message/channel_join).
channel will receive a [`channel_join` message event](/events/message/channel_join).
2 changes: 1 addition & 1 deletion events/channel_left.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ leaves a channel. Clients should respond to this message by closing the
channel - this means that when a channel is left from client A, it will
automatically be closed in client B.

In addition to this message, all existing members of the channel will recieve a
In addition to this message, all existing members of the channel will receive a
[`channel_leave` message event](/events/message/channel_leave).
15 changes: 15 additions & 0 deletions events/dnd_updated.md
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.
13 changes: 13 additions & 0 deletions events/dnd_updated_user.md
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.
2 changes: 1 addition & 1 deletion events/emoji_changed.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
}

The `emoji_changed` event is sent to all connections for a team when that
team's custom emoji is updated. When they recieve this event, clients should
team's custom emoji is updated. When they receive this event, clients should
update their local cache of emoji by calling
[the emoji.list method](/methods/emoji.list) again.
11 changes: 5 additions & 6 deletions events/group_archive.md
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.
12 changes: 6 additions & 6 deletions events/group_close.md
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.
17 changes: 7 additions & 10 deletions events/group_history_changed.md
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`.
16 changes: 8 additions & 8 deletions events/group_joined.md
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).
19 changes: 9 additions & 10 deletions events/group_left.md
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).
12 changes: 6 additions & 6 deletions events/group_marked.md
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).
20 changes: 9 additions & 11 deletions events/group_rename.md
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.
11 changes: 5 additions & 6 deletions events/group_unarchive.md
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.
2 changes: 1 addition & 1 deletion events/im_history_changed.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
}

A `im_history_changed` event is sent to all clients in a DM channel when
bulk changes have occured to that DM channel's history. When clients recieve
bulk changes have occured to that DM channel's history. When clients receive
this message they should reload chat history for the channel if they have any
cached messages before `latest`.
2 changes: 1 addition & 1 deletion events/message/message_changed.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ A `message_changed` message is sent when a message in a channel is edited
using the [`chat.update` method](/methods/chat.update). The `message` property
contains the updated message object.

When clients recieve this message type, they should look for an existing
When clients receive this message type, they should look for an existing
message with the same `message.ts` in that `channel`. If they find one the
existing message should be replaced with the new one.
10 changes: 10 additions & 0 deletions events/mpim_close.md
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.
14 changes: 14 additions & 0 deletions events/mpim_history_changed.md
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`.
17 changes: 17 additions & 0 deletions events/mpim_joined.md
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.
10 changes: 10 additions & 0 deletions events/mpim_open.md
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.
41 changes: 34 additions & 7 deletions events/reaction_added.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,41 @@
"type": "reaction_added",
"user": "U024BE7LH",
"name": "thumbsup",
"item": {
}
"item": {
},
"event_ts": "1360782804.083113"
}

When a reaction is added to an item the `reaction_added` event is sent to all connected
clients for users who can see the content that was reacted to.
When a reaction is added to an item the `reaction_added` event is sent to all connected clients for users who can see the content that was reacted to.

### Embedded item objects

Embedded `item` nodes are more lightweight than the structures you'll find in [`reactions.list`](/methods/reactions.list).

Here are some examples:

#### Message:

"item": {
"type": "message",
"channel": "C0G9QF9GZ",
"ts": "1360782400.498405"
}

#### File:

"item": {
"type": "file",
"file": "F0HS27V1Z"
}


#### File Comment:

"item": {
"type": "file_comment",
"file_comment": "Fc0HS2KBEZ",
"file": "F0HS27V1Z"
}

See [the `reactions.list` method](/methods/reactions.list) for details of the
structure of the `item` property.
36 changes: 31 additions & 5 deletions events/reaction_removed.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,38 @@
"name": "thumbsup",
"item": {
}
},
"event_ts": "1360782804.083113"
}

When a reaction is removed from an item the `reaction_removed` event is sent to all connected
clients for users who can see the content that had the reaction.
When a reaction is removed from an item the `reaction_removed` event is sent to all connected clients for users who can see the content that had the reaction.

See [the `reactions.list` method](/methods/reactions.list) for details of the
structure of the `item` property.
### Embedded item objects

Embedded `item` nodes are more lightweight than the structures you'll find in [`reactions.list`](/methods/reactions.list).

Here are some examples:

#### Message:

"item": {
"type": "message",
"channel": "C0G9QF9GZ",
"ts": "1360782400.498405"
}

#### File:

"item": {
"type": "file",
"file": "F0HS27V1Z"
}


#### File Comment:

"item": {
"type": "file_comment",
"file_comment": "Fc0HS2KBEZ",
"file": "F0HS27V1Z"
}
7 changes: 7 additions & 0 deletions events/reconnect_url.md
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.
Loading

0 comments on commit b813d2d

Please sign in to comment.