cadmium-im/cadmium-docs-legacy
1
0
Fork 0
mirror of https://github.com/cadmium-im/cadmium-docs-legacy.git synced 2024-11-09 12:11:03 +00:00
Code Issues Projects Releases Wiki Activity

Slightly restructure message entity in CPE4

Browse Source
This commit is contained in:
ChronosX88 2020-12-26 23:22:47 +04:00
parent 5c4b922986
commit 8a83844dfc
Signed by: ChronosXYZ
GPG Key ID: 085A69A82C8C511A
1 changed files with 20 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
CPEs/proposed/CPE4 - Basic chats.md
View File

@ -257,19 +257,22 @@ This extension is intended for organizing chats between some entities.
- Client sends typing notification message every second when he is typing. If there is no notifications about typing more than one second then consider that user is stopped the typing. - Client sends typing notification message every second when he is typing. If there is no notifications about typing more than one second then consider that user is stopped the typing.
### 7.2. Message/Media ID ### 7.2. Message/Media ID
- This is typically Federated Entity ID of message/media (as described and reserved in core specs) which was stored in server's database/content service storage. - This is typically Federated Entity ID of message/media (as described and reserved in core specs) which was stored in server's database/content service storage.
## 8. JSON Schema ## 8. JSON Schema
### Send message (`urn:cadmium:chats:message`) ### Message (`urn:cadmium:chats:message`)
**Request**: **Request**:
```typescript ```typescript
interface SendMessagePayload { interface MessagePayload {
messageID?: EntityID; // the message id (stored in chat timeline) - not required when sending
type: string; // the type of message type: string; // the type of message
reply?: string; // message id on which this message is replying replyTo?: EntityID; // message id to which this message is replying
originServerTimestamp?: number; // unix timestamp of received message on the origin server (not required when sending)
forwardedFrom?: EntityID | string; // entity from which this message was forwarded (may be hidden, so instead client need to show the display name of entity)
content: Content // the payload of message (depends on type) content: Content // the payload of message (depends on type)
} }
``` ```
@ -278,8 +281,8 @@ interface SendMessagePayload {
```typescript ```typescript
interface SendMessageResponsePayload { interface SendMessageResponsePayload {
messageID: string; // the message id (stored in chat timeline) messageID: EntityID; // the message id (stored in chat timeline)
originServerTimestamp: number // unix timestamp of sent message on the origin server originServerTimestamp: number; // unix timestamp of sent message on the origin server
} }
``` ```
@ -290,13 +293,14 @@ interface SendMessageResponsePayload {
```typescript ```typescript
interface GeneralMessageContent { interface GeneralMessageContent {
text: string; // the text (body) of message text: string; // the text (body) of message
mentioned?: boolean; // is current entity was mentioned in this message
media?: Media[]; // media content media?: Media[]; // media content
} }
interface Media { interface Media {
id: string; // media ID id: string; // media ID
type: string; // type of media type: string; // type of media
size: int; // size of media in bytes size: number; // size of media in bytes
fileName?: string; // filename of media (with optional extension by dot) fileName?: string; // filename of media (with optional extension by dot)
attrs: MediaAttrs; // media payload (additional attributes) attrs: MediaAttrs; // media payload (additional attributes)
} }
@ -308,7 +312,7 @@ interface SendMessageResponsePayload {
// urn:cadmium:chats:media:audio // urn:cadmium:chats:media:audio
interface AudioAttrs : MediaAttrs { interface AudioAttrs : MediaAttrs {
voice: bool; // whether it is voice message voice: bool; // whether it is voice message
duration: int; // duration of audio duration: number; // duration of audio
title?: string; // audio title title?: string; // audio title
artist?: string; // audio artist artist?: string; // audio artist
voiceWaveForm?: []byte; // voice wave form voiceWaveForm?: []byte; // voice wave form
@ -324,15 +328,15 @@ interface SendMessageResponsePayload {
// urn:cadmium:chats:media:video // urn:cadmium:chats:media:video
interface VideoAttrs : MediaAttrs { interface VideoAttrs : MediaAttrs {
isVideoMessage: bool; // is this a rounded video message isVideoMessage: bool; // is this a rounded video message
duration: int; // duration of video duration: number; // duration of video
width: int; // width of video width: number; // width of video
height: int; // height of video height: number; // height of video
} }
// urn:cadmium:chats:media:photo // urn:cadmium:chats:media:photo
interface PhotoAttrs : MeditAttrs { interface PhotoAttrs : MeditAttrs {
width: int; // width of photo width: number; // width of photo
height: int; // height of photo height: number; // height of photo
} }
``` ```
@ -345,36 +349,10 @@ interface SendMessageResponsePayload {
} }
``` ```
### Receive message (`urn:cadmium:chats:message`) ### Read message notification (`urn:cadmium:chats:read`)
```typescript ```typescript
interface ReceiveMessagePayload { interface ReadMessageNotifPayload {
messageID: string; // the id of received message messageID: EntityID; // the message id of read message
originServerTimestamp: number; // unix timestamp of received message on the origin server
type: string; // the type of message
reply?: string; // message id on which this message is replying
content: Content; // the payload of message (depends on type)
}
```
### Read message (`urn:cadmium:chats:read`)
**Request**:
```typescript
interface ReadMessagePayload {
messageID: string; // the message id of read message
}
```
**Response**:
None.
### Receive read message notification (`urn:cadmium:chats:read`)
```typescript
interface ReceiveReadMessageNotifPayload {
messageID: string; // the message id of read message
} }
``` ```