freechat/docs/content/rtc/events.md
2021-04-14 22:38:43 -07:00

1.5 KiB

title anchor weight
Events events 42

Pertinent Event Data Structures

This section describes the data you probably care about; the data behind <data-type>.

new-message

Each valid new-message is completely flat and contains the following fields:

  • id: u64 Public user id
  • time: i64

Unix time-stamp (generated on the server's end)

  • content: String

If the content type is text/plain then the content is all there is for that message. If the content type is another valid type then this field will contain null. A second /message/get?id=<id> is required. This is done to avoid forcing tons of file data across a network when you don't want it.

This also gives client devs the choice of putting that network hit behind a button(or some user action) or doing automatically.

  • content_type: String

For valid content-types refer to /message/send documentation

  • author_id: u64

Public Member id

  • channel_id: u64

Text channel id. It is safe to assume that this field will point to a valid text channel and not a misconfigured voice channel.

  • name: String

Public username for that given user

delete-channel

Contains only 1 field:

  • id: u64

The id of the deleted channel

create-channel

  • id: u64

The id of the new channel

  • name: String

Name of channel

  • description: String | null

Optional description of channel

  • kind: i32

Recall:

  • Voice channels := 1
  • Text channels : 2

update-nick

  • id: u64

Id of affected user

  • name: String

New nickname of user