mirror of
https://github.com/tinode/chat.git
synced 2026-05-07 20:12:42 +00:00
docs updated
This commit is contained in:
+8
-2
@@ -628,7 +628,7 @@ Every client to server message contains the main payload described in the sectio
|
||||
}
|
||||
```
|
||||
The `attachments` array lists URLs of files uploaded out of band. Such listing increments use counter of these files. Once the use counter drops to 0, the files will be automatically deleted.
|
||||
The `obo` can be set by the `root` user. If the `obo` is set, the server will treat the message as if it came from the sepcified user as opposite to the actual sender.
|
||||
The `obo` (On Behalf Of) can be set by the `root` user. If the `obo` is set, the server will treat the message as if it came from the specified user as opposite to the actual sender.
|
||||
The `authlevel` is supplementary to the `obo` and permits setting custom authentication level for the user. A an `"auth"` level is used if the field is unset.
|
||||
|
||||
#### `{hi}`
|
||||
@@ -668,7 +668,12 @@ acc: {
|
||||
// default: current user, optional
|
||||
token: "XMgS...8+BO0=", // string, authentication token to use for the request if the
|
||||
// session is not authenticated, optional
|
||||
// Temporary authentication parameters for one-off actions, like password reset.
|
||||
tmpscheme: "code", // name of the temp wuth scheme
|
||||
tmpsecret: "XMgS...8+BO0=", // temp auth secret
|
||||
status: "ok", // change user's status; no default value, optional.
|
||||
authlevel: "auth", // authentication level of the user when UserID is set and not equal
|
||||
// to the current user; Either "", "auth" or "anon"; default: ""
|
||||
scheme: "basic", // authentication scheme for this account, required;
|
||||
// "basic" and "anon" are currently supported for account creation.
|
||||
secret: base64encode("username:password"), // string, base64 encoded secret for the chosen
|
||||
@@ -888,8 +893,9 @@ The following values are currently defined for the `head` field:
|
||||
* `"started"`: call has been initiated and being established
|
||||
* `"accepted"`: call has been accepted and established
|
||||
* `"finished"`: previously successfully established call has been ended
|
||||
* `"missed"`: call was hung up by the caller or timed out before getting established
|
||||
* `"missed"`: call timed out before getting established
|
||||
* `"declined"`: call was hung up by the callee before getting established
|
||||
* `"busy"`: the call was declined due to the callee being in another call.
|
||||
* `"disconnected"`: call was terminated by the server for other reasons (e.g. due to an error)
|
||||
* `webrtc-duration`: a number representing a video call duration (in milliseconds).
|
||||
|
||||
|
||||
+2
-1
@@ -312,8 +312,9 @@ Video call `data` contains current state of the call and its duration:
|
||||
* `duration`: call duration in milliseconds.
|
||||
* `state`: surrent call state; supported states:
|
||||
* `accepted`: a call is established (ongoing).
|
||||
* `busy`: a call cannot be established because the callee is already in another call.
|
||||
* `finished`: a previously establied call has successfully finished.
|
||||
* `disconnected`: the call is dropped for example because of an error.
|
||||
* `disconnected`: the call is dropped, for example because of an error.
|
||||
* `missed`: the call is missed, i.e. the callee didn't pick up the phone.
|
||||
* `declined`: the call is declined, i.e. the callee hung up before picking up.
|
||||
* `incoming`: true if the call is incoming, otherwise the call is outgoing.
|
||||
|
||||
+4
-2
@@ -18,7 +18,7 @@ Alternatively, you can instruct the docker container to save the logs to a direc
|
||||
### Q: What are the options for enabling push notifications?<br/>
|
||||
**A**: You can use Tinode Push Gateway (TNPG) or you can use Google FCM:
|
||||
* _Tinode Push Gateway_ requires minimum configuration changes by sending pushes on behalf of Tinode.
|
||||
* _Google FCM_ does not rely on Tinode infrastructure for pushes but requires you to recompile mobile apps (iOS and Android).
|
||||
* _Google FCM_ does not rely on Tinode infrastructure for pushes but requires you to build your own mobile apps (iOS and Android).
|
||||
|
||||
|
||||
### Q: How to setup push notifications with Tinode Push Gateway?<br/>
|
||||
@@ -29,7 +29,9 @@ See detailed instructions [here](../server/push/tnpg/).
|
||||
|
||||
|
||||
### Q: How to setup push notifications with Google FCM?<br/>
|
||||
**A**: Enabling FCM push notifications requires the following steps:
|
||||
**A**: This option requires you to build and release your own mobile apps. If you do not want to do it, the the TNPG option above.
|
||||
|
||||
Enabling FCM push notifications requires the following steps:
|
||||
* enable push sending from the server
|
||||
* enable receiving pushes in the clients
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ TNPG solves this problem by allowing you to send push notifications on behalf of
|
||||
### Obtain TNPG token
|
||||
|
||||
1. Register at https://console.tinode.co and create an organization.
|
||||
2. Get the TPNG token from the _Self hosting_ section by following the instructions there.
|
||||
2. Get the TPNG token from the _Self hosting_ → _Push Gateway_ section by following the instructions there.
|
||||
|
||||
### Configure the server
|
||||
Update the server config [`tinode.conf`](../../tinode.conf#L413), section `"push"` -> `"name": "tnpg"`:
|
||||
|
||||
Reference in New Issue
Block a user