All commands must use class: "chat".
Events
Many commands generate events that the client can subscribe to. See description for each command.
Use subclass user.
Use command create. Supported fields are
| Field | Desc |
|---|---|
login |
Login to use (email-like) |
name |
Name of the user |
surname |
Surname |
password |
Password |
The sever will return the newly created user_id.
Example:
{
class: "chat",
subclass: "user",
cmd: "create",
data: {
login: "[email protected]",
name: "Name",
surname: "Surname",
password: "1234"
},
tid: 1
}
-->
{
result: "ok",
data: {
user_id: "59c03l30ddlekvd93"
},
tid: 1
}It generates the following event:
| Field | Value |
|---|---|
| subclass | user |
| type | created |
| obj_id | The user's id |
Use command get and field user_id
Use command delete to remove and user. Must use the field user_id.
Event
| Field | Value |
|---|---|
| subclass | user |
| type | deleted |
| obj_id | The user's id |
Use command search to find users. The following fields are available:
| Field | Desc |
|---|---|
fields |
List of fields to include in the response. Use "_all" to get all fields |
filter |
Filter to apply to the response (for example, {field1:"value1", field2:"value2"} |
size |
Numer of objects to return |
from |
Position to start returning objects (starts at 0) |
sort_by |
List of fields to sort on |
sort_order |
Sort order ("asc" or "desc") |
Use subclass conversation
Use command create to create a new conversation. Supported fields are:
| Field | Desc |
|---|---|
name |
Short name for the conversation |
description |
Description |
user_ids |
initial list of users |
The sever will return the newly created conversation_id.
Event
| Field | Value |
|---|---|
| subclass | conversation |
| type | created |
| obj_id | The conversation's id |
Use command get and field conversation_id
Use command delete, and field conversation_id.
Event
| Field | Value |
|---|---|
| subclass | conversation |
| type | deleted |
| obj_id | The conversation's id |
Use command add_members to add users to a conversation. Must set the conversation_id field and the list of users in the field user_ids.
Event
| Field | Value |
|---|---|
| subclass | conversation |
| type | added_memebers |
| obj_id | The conversation's id |
| body | Includes field user_ids |
Use command remove_members to remove users from a conversation. Must set the conversation_id field and the list of users in the field user_ids.
Event
| Field | Value |
|---|---|
| subclass | conversation |
| type | removed_memebers |
| obj_id | The conversation's id |
| body | Includes field user_ids |
Use command get_members to get the list of users from a conversation. Must set the field conversation_id.
Use command search to find conversations. Use the same fields as for user search.
Use subclass message
Use command create to create a new message. Supported fields are:
| Field | Desc |
|---|---|
conversation_id |
Id of the conversation |
user_id |
User creating the message |
message |
Text of the message |
The sever will return the newly created message_id.
Event
| Field | Value |
|---|---|
| subclass | conversation |
| type | created_message |
| obj_id | The conversation's id |
| body | Includes field message_id |
Use command get and field message_id.
Use command delete, and fields conversation_id and message_id.
Event
| Field | Value |
|---|---|
| subclass | conversation |
| type | deleted_message |
| obj_id | The conversation's id |
| body | Includes field message_id |
Use command update, and fields conversation_id, message_id and message to update message's content.
Event
| Field | Value |
|---|---|
| subclass | conversation |
| type | updated_message |
| obj_id | The conversation's id |
| body | Includes field message_id |
Use command search to find messages. Use the same fields as for user search.