Updated documentation

This commit is contained in:
ChronosX88 2018-05-16 14:46:59 +03:00
parent 945beac311
commit a2d82beedd

View File

@ -1,4 +1,4 @@
# Общая документация
# Общая документация мессенджера HyperboriaIM
## Структура мессенджера
@ -22,8 +22,8 @@ API - ядро мессенджера. Достаточно подключить
```json
{
 "action":"handshake",
 "peerID":"*IPv6 контакта*"
"action":"handshake",
"peerID":"*IPv6 контакта*"
}
```
@ -31,9 +31,9 @@ API - ядро мессенджера. Достаточно подключить
```json
{  
 "action":"handshakeSuccess",
 "peerID":"*IPv6*",
 "status": true
"action":"handshakeSuccess",
"peerID":"*IPv6*",
"status": true
}
```
@ -60,9 +60,9 @@ API - ядро мессенджера. Достаточно подключить
```json
{  
"action":"sendSuccess",
 "peerSender":"*IPv6 отправителя, т.е. кому доставили сообщение*",
"peerSender":"*IPv6 отправителя, т.е. кому доставили сообщение*",
"peerReceiver":"*IPv6 получателя, т.е. кто отправил сообщение*",
 "chatID":"*Идентификатор чата, у обоих он одинаковый*",
"chatID":"*Идентификатор чата, у обоих он одинаковый*",
"msgID":"*ID сообщения, которое доставлено, в чате*",
"status": true
}
@ -78,8 +78,8 @@ API - ядро мессенджера. Достаточно подключить
```json
{
 "action":"ping",
 "peerID":"*IPv6*"
"action":"ping",
"peerID":"*IPv6*"
}
```
@ -87,8 +87,8 @@ API - ядро мессенджера. Достаточно подключить
```json
{
 "action":"pong",
 "peerID":"*IPv6*"
"action":"pong",
"peerID":"*IPv6*"
}
```
@ -106,8 +106,8 @@ API - ядро мессенджера. Достаточно подключить
```json
{
 "action":"historySuccess",
 "status":[true,true,true,false,true]
"action":"historySuccess",
"status":[true,true,true,false,true]
}
```