Skip to content
This repository was archived by the owner on Jun 29, 2023. It is now read-only.

Fix few docs tickets #448

Closed
wants to merge 23 commits into from
Closed

Fix few docs tickets #448

Changes from 12 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
af217af
Document 'D' direct channel
tapaswenipathak May 26, 2019
516baf2
Document worksocket events
tapaswenipathak May 29, 2019
6c7ff25
few minor review comments
tapaswenipathak Jun 11, 2019
c325544
Direct channels line deletion
tapaswenipathak Jun 23, 2019
cef432f
Fix event names
tapaswenipathak Jun 23, 2019
232a6da
Use <seq_id> as val
tapaswenipathak Jun 25, 2019
899ed6e
Minor fixes
tapaswenipathak Jun 25, 2019
b8eb9ec
Few Payload fixes
tapaswenipathak Jul 2, 2019
8256c08
Fix omit_users field value
tapaswenipathak Jul 7, 2019
1ce9289
Add quotes
tapaswenipathak Jul 23, 2019
127f223
Minor ordering comment fix
tapaswenipathak Jul 23, 2019
b9760a4
Remove info field
tapaswenipathak Jul 23, 2019
8ea73c2
Minor review enhancements
tapaswenipathak Jul 24, 2019
be41ffd
Add comma
tapaswenipathak Jul 31, 2019
60749eb
Add comma
tapaswenipathak Jul 31, 2019
ab145be
Remote quotes around <seq_id>
tapaswenipathak Jul 31, 2019
88df837
Remove the quotes around seq_id
tapaswenipathak Jul 31, 2019
70a3d08
Remove delete for now
tapaswenipathak Jul 31, 2019
b3cfb33
Remove newline
tapaswenipathak Jul 31, 2019
1d188ad
Add user_id as value
tapaswenipathak Jul 31, 2019
bb454b9
missed comma
tapaswenipathak Jul 31, 2019
a665401
merge commit
tapaswenipathak Jul 31, 2019
ae49bdc
seq_id and comma issues
tapaswenipathak Jul 31, 2019
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
186 changes: 184 additions & 2 deletions v4/source/introduction.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,23 +214,205 @@ tags:

The list of Mattermost WebSocket events are:
- added_to_team
```
{
'event': 'added_to_team',
'seq': '<seq_id>'
'data': {
'team_id': '<team_id>',
'user_id': '<user_id>'
},
'broadcast': {
'omit_users': null,
'user_id': '<user_id>',
'channel_id': '<channel_id>',
'team_id': '<team_id>'
}
}
```
- authentication_challenge
- channel_converted
- channel_created
```
{
'event': 'channel_created',
'seq' : '<seq_id>',
'data' : {
'channel_id': '<channel_id>',
'team_id' : '<team_id>'
},
'broadcast': {
'omit_users': null,
'channel_id': '<channel_id>',
'team_id': '<team_id>',
'user_id': '<user_id>'
}
}
```
- channel_deleted
- channel_member_updated
```
{
'event': 'channel_deleted',
'seq': '<seq_id>'
'data': {
'channel_id': '<channel_id>'
},
'broadcast': {
'omit_users': null,
'user_id': '<user_id>',
'channel_id': '<channel_id>',
'team_id': '<team_id>'
},

```
- channel_updated
```
{
'event': 'channel_updated',
'seq': '<seq_id>'
'data': {
'channel': {
'id': '<channel_id>',
'create_at': '<timestamp>',
'update_at': '<timestamp>',
'delete_at': '<timestamp>',
'team_id': '<team_id>',
'type': 'O',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be 'P', 'D' or 'G' as well

'display_name':'<channel_id>',
'name': '<channel_name>',
'header': 'header',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be a blank string right?

'purpose': '',
'last_post_at': '<timestamp>',
'total_msg_count': '<total_msg_count>',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There shouldn't be quotes here as this is a number. Same with the timestamp fields

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a lot of other cases throughout the changes with this issue

'extra_update_at': '<timestamp>',
'creator_id': '<basic_user_id>'
},
'broadcast': {
'omit_users': null,
'user_id': '',
'channel_id': '<channel_id>',
'team_id': '<team_id>'
},
}
```
- channel_viewed
```
{
'event': 'channel_viewed',
'seq': '<seq_id>'
'data': {
'channel_id': '<channel_id>'
},
'broadcast': {
'omit_users': null,
'user_id': '<user_id>',
'channel_id': '<channel_id>',
'team_id': '<team_id>'
}
}
```
- config_changed
```
{
'event': 'config_changed',
'data': {
'config': {
'EnableCustomEmoji': '<true/false>',
'EnableLinkPreviews': '<true/false>'
}
}
}
```
- delete_team
```
{
'teamname': '<team_name>',
'teamid': '<team_id>',
'state': '<success/error>'
}
```
- direct_added
```
{
'event': '<direct_added>',
'seq': '<seq_id>'
'data': {
'teammate_id': '<teammate_id>'
},
'broadcast': {
'omit_users': null,
'user_id': '<user_id>',
'channel_id': '<channel.id>',
'team_id': '<team_id>'
}
}
```
- emoji_added
```
{
'event': 'emoji_added',
'seq': '<seq_id>'
'data': {
'emoji': {
'id': '<id>',
'create_at': '<timestamp>',
'update_at': '<timestamp>',
'delete_at': '<timestamp>',
'creator_id': '<creator_id>',
'name': 'name'
}
},
'broadcast': {
'omit_users': null,
'user_id': '',
'channel_id': '',
'team_id': ''
}
}
```
- ephemeral_message
```
{
'message': '<message>'
}
```
- group_added
- hello
```
{
'message': '<message>'
}
```
- leave_team
```
{
'event': 'leave_team',
'seq': '<seq_id>'
'data': {
'team_id': '<team_id>',
'user_id': '<user_id>'
},
'broadcast': {
'omit_users': null,
'user_id': '<user_id>',
'channel_id': '<channel_id>',
'team_id': '<team_id>'
}
}
```
- license_changed
```
{
'type': 'GeneralTypes.CLIENT_LICENSE_RECEIVED',
'data': 'msg.data.license'
}
```
- memberrole_updated
```
{
'type': 'TeamTypes.RECEIVED_MY_TEAM_MEMBER',
'data': 'msg.data.member',
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one should have a seq_id and broadcast right?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that required? https://github.com/mattermost/mattermost-redux/blob/master/src/actions/websocket.test.js#L390

```
- new_user
- plugin_disabled
- plugin_enabled
Expand Down