Skip to content

data-structures.md

Latest commit

 

History

History
52 lines (39 loc) · 1.03 KB

data-structures.md

File metadata and controls

52 lines (39 loc) · 1.03 KB

Data Structures

In this document we define data structures and definitions used in the chat api

Invite

Invite is an encrypted payload used in wc_chatInvite which will be tracked by the json-rpc id to index on the client-side with the following params.

{
  "message": string,
  "account": string,
  "publicKey": string,
  "signature": string, // optional
}

Media

Media is an optional parameter used in wc_chatMessage to append a media file reference sent together with the plaintext message.

{
  "type": string,
  "data": string,
}

Message

An array of Messages is returned on getMessages(params: {topic: string;})

{
  "message" : string,
  "authorAccount": string, // to distinguish who sent it. Could also be a flag
  "timestamp": Int64,
  "media": Media // optional
}

Thread

A map of type Map<string, Thread> is returned on getThreads(params: {account: string;}. Topic is the key of the map.

{
  "topic": string,
  "selfAccount": string,
  "peerAccount": string
}