Help

Keep links up-to-date.

When moving, renaming .md files, or changing any title (e.g. command or broadcast name) try to search links on previous file/title in this file or any other and update them.

Describe all commands and broadcasts in the same manner

Before adding documentation on new command/broadcast or changing existing one, please refer to following templates

New commands template

command_name

Hub type: hub_types

Connection type: connection_type

Permissions: permissions

command_description

request:

Field Type Required Description
field_name field_type is_required field_description

response:

Field Type Required Description
field_name field_type is_required field_description

broadcasts:

Broadcast Description
broadcast_name broadcast_description

errors:

Code Message Data
error_code error_message error_data

Examples

example_title

example_description

request:

{
    "method": "`command_name`",
    "id": "_ID_",
    "params": {
        ...
    }
}

response:

{
    "error": null,
    "id": "_ID_",
    "result": {
        ...
    }
}

broadcasts: none


Command placeholders description:

Notes

Properly formatted commands:

Note: feel free to modify this list


New broadcasts template

broadcast_name

command_description

initiators:

result:

Field Type Required Description
field_name field_type is_required field_description
operationId string + Id of initiating command

Examples

example_title

example_descritption

{
    "id": "ui_broadcast",
    "msg_subclass": "`broadcast_name`",
    "result": {
        ...
    }
}

Broadcast template placeholders description:

Properly formatted broadcasts:

Note: feel free to modify this list