Skip to content

Commit

Permalink
a few more corrections with respect to deleting users
Browse files Browse the repository at this point in the history
  • Loading branch information
or-else committed Dec 5, 2018
1 parent c13bb5e commit 7f18f88
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ Once the connection is opened, the client must issue a `{hi}` message to the ser

### gRPC

See definition of the gRPC API in the [proto file](../pbx/model.proto). gRPC API is nearly identical to HTTP API with an exception that it allows the `root` user to send messages on behalf of other users.
See definition of the gRPC API in the [proto file](../pbx/model.proto). gRPC API has slightly more functionality than the API described in this document: it allows the `root` user to send messages on behalf of other users as well as delete users.

### Websocket
### WebSocket

Messages are sent in text frames, one message per frame. Binary frames are reserved for future use. By default server allows connections with any value in the `Origin` header.

Expand Down Expand Up @@ -883,15 +883,15 @@ set: {

#### `{del}`

Delete messages or topic.
Delete messages, subscriptions, topics, users.

```js
del: {
id: "1a2b3", // string, client-provided message id, optional
topic: "grp1XUtEhjv6HND", // string, topic affected, required for "topic", "sub",
// "msg"
what: "msg", // string, one of "topic", "sub", "msg", "user"; what to delete - the
// entire topic, subscription, messages, user;
// entire topic, a subscription, some or all messages, a user;
// optional, default: "msg"
hard: false, // boolean, request to hard-delete vs mark as deleted; in case of
// what="msg" delete for all users vs current user only;
Expand Down

0 comments on commit 7f18f88

Please sign in to comment.