Skip to content

DataTransmission.md

Latest commit

 

History

History
88 lines (73 loc) · 5.71 KB

DataTransmission.md

File metadata and controls

88 lines (73 loc) · 5.71 KB

Format

In order to simplify sending and receiving data, the Tick Talk protocol, as of v6.0.0, is built on top of Requests. Requests features two different independent fields that are utilized in Tick Talk: name and data. A name is analagous to a function/method name in programming and data is analagous to a list of parameters or return values. The following section describes what names are valid and what data is valid along with them.

Names and their data formats

Server Stuff

displayServerMessage (1 way)

  • Purpose: To show a server message (can only be sent by a server)
  • Parameter: The server message, as a string, to display
  • Note(s): Server messages can be displayed as alert/dialogue boxes or something similar

User Accounts

login (2 way)

  • Purpose: Sent from a client to login a user
  • Parameter: A LoginObject
  • Return: The signed in user's UserData
  • Error: The error encountered as a string

getUserData (2 way)

  • Purpose: A request to get the UserData object of a user
  • Parameter: The username of a user
  • Return: The UserData object of the requested user, with blank strings populating the private fields
  • Error: The error encountered (typically user not found) as a string

updateUserData (1 way)

  • Purpose: To give a client an updated UserData object when something happens externally, like if they are removed from a group
  • Parameter: A UserData object

setMyPicture (2 way)

  • Purpose: To set the logged-in user's picture
  • Parameter: The base-64 representation of the contents of a PNG file
  • Return: The updated UserData object of the signed in user
  • Error: The error encountered as a string

setMyDisplayName (2 way)

  • Purpose: To set the logged-in user's display name
  • Parameter: The new display name
  • Return: The updated UserData object of the signed in user
  • Error: The error encountered as a string

Rooms

sendRoomMessage (1 way)

  • Purpose: To send a message to a room
  • Parameter: A RoomMessage object with all fields except for the id and timestamp fields populated
  • Notes: Room messages are unencrypted

showRoomMessage (1 way)

  • Purpose: To tell a client there is a RoomMessage that a client doesn't have (either because the message is new or because it was requested by the client)
  • Parameter: The RoomMessage object
  • Notes: THIS IS ONLY FROM A SERVER TO A CLIENT

getRoomMessageBlock (1 way)

  • Purpose: To get a block (a set) of ~1000 room messages from the server, for when a user exhausts the client's cache (if there is any at all)
  • Parameter: A MessageBlockRequest object

Group Chats (& PMs)

makeGroup (2 way)

  • Purpose: To create a new group chat
  • Parameter: A MakeGroup object
  • Return: An updated UserData object
  • Error: The error encountered as a string

changeGroupInfo (2 way)

  • Purpose: To change some data about a group, like its description or picture
  • Parameter: A ChangeGroupInfo object
  • Return: An updated UserData object
  • Error: The error encountered as a string

changeGroupUser (2 way)

  • Purpose: To add, remove, or change the nickname of a user in a group
  • Parameter: A ChangeGroupUser object
  • Return: An updated UserData object
  • Error: The error encountered as a string

sendGroupMessage (1 way)

  • Purpose: To send a message to a group
  • Parameter: A GroupMessage object with all fields except for the id and timestamp fields populated
  • Notes: Group messages are encrypted

showGroupMessage (1 way)

  • Purpose: To tell a client there is a GroupMessage that a client doesn't have (either because the message is new or because it was requested by the client)
  • Parameter: The GroupMessage object
  • Notes: THIS IS ONLY FROM A SERVER TO A CLIENT

getGroupMessageBlock (1 way)

  • Purpose: To get a block (a set) of ~1000 group messages from the server, for when a user exhausts the client's cache (if there is any at all)
  • Parameter: A MessageBlockRequest object