Type

Struct

Representation

{
   key : value
}

Free type of json object struct.

TransitFrame

Representation

{
  "i": int64,
  "c": enum(FrameClass),
  "n": enum(MessageName),
  "d": { object(Message) },
  "t": int64,
  "m": string
}

Fields

Fields	Description
i	int64 Transit ID
c	enum (FrameClass) Frame Class
n	enum (MessageName) Message type name
d	object (Message) Message object
t	int64 Unix nano timestamp
m	string Message id

FrameClass

Class of frame

Enums	Description
ClassRequest	string ClassRequest frame is request class.
ClassResponse	string ClassResponse frame is response class.
ClassNotification	string ClassNotification frame is notification class.
ClassError	string ClassError frame is error class.

MessageName

Name of message

Enums	Description
JoinChannel	string JoinChannel The message is JoinChannel type, means someone join this channel.
LeaveChannel	string LeaveChannel The message is LeaveChannel type, means someone leave this channel.
ChannelMessage	string ChannelMessage The message is ChannelMessage type.
ChannelOwnerMessage	string ChannelOwnerMessage The message is ChannelOwnerMessage type, which can only send from owner.
SetChannelMeta	string SetChannelMeta The message is SetChannelMeta type, means owner set channel meta.
GetChannelMeta	string GetChannelMeta The message is GetChannelMeta type, means owner set channel meta and broadcast to session in this channel.
CloseChannel	string CloseChannel The message is CloseChannel type, means this channel has been closed.

ChannelRole

Role of channel

Enums	Description
owner	string owner The owner of channel.
participator	string participator The participator of channel.

Skill

Channel & Message Skill

Fields	Description
tg	STagging Tagging Option tagging option, include dictionary word tagging.

STagging

Channel & Message Skill Tagging

Fields	Description
d	STDictionary Dictionary Option dictionary setting

STDictionary

Channel & Message Skill Tagging Dictionary list

Fields	Description
i	[]string dictionary id list Applied dictionary id list

Message

Message.JoinChannel

Representation

{
  "o": int64,
  "ch": string,
  "r": enum(ChannelRole),
  "s": string,
  "sm": { object(Struct} },
  "sub": string,
  "sn": string
}

Fields

Fields	Description
o	int64 offset unix nano time from channel created to this message generated.
ch	string Channel id
r	enum (ChannelRole) Channel Role
s	string Join session id
sm	object (Struct) Metadata of join session
sub	string Subject of join session
sn	string Subject name of join session

Message.LeaveChannel

Representation

{
  "o": int64,
  "ch": string,
  "s": string
}

Fields

Fields	Description
o	int64 offset unix nano time from channel created to this message generated.
ch	string Channel id
s	string Leave session id

Message.ChannelMessage

Representation

{
  "o": int64,
  "ch": string,
  "fs": string,
  "m": string,
  "mta": { object(Struct} },
  "sk": { object(Skill) },
  "sub": string,
  "sn": string
}

Fields

Fields	Description
o	int64 offset unix nano time from channel created to this message generated.
ch	string Channel id
fs	string Session id
m	string message
mta	object (Struct) Metadata of message
sk	object (Skill) Skill notification
sub	string Subject of session
sn	string Subject name of session

Message.ChannelOwnerMessage

Representation

{
  "o": int64,
  "ch": string,
  "fs": string,
  "m": string,
  "mta": { object(Struct} },
  "sk": { object(Skill) },
  "sub": string,
  "sn": string
}

Fields

Fields	Description
o	int64 offset unix nano time from channel created to this message generated.
ch	string Channel id
fs	string Session id
m	string message
mta	object (Struct) Metadata of message
sk	object (Skill) Skill notification
sub	string Subject of session
sn	string Subject name of session

Message.SetChannelMeta

Representation

{
  "o": int64,
  "ch": string,
  "n": string,
  "d": { object(Struct} }
}

Fields

Fields	Description
o	int64 offset unix nano time from channel created to this message generated.
ch	string Channel id
n	string Optional. Channel name
d	object (Struct) Optional. Metadata of channel

Message.GetChannelMeta

Representation

{
  "o": int64,
  "ch": string,
  "n": string,
  "d": { object(Struct} },
  "ca": int64
}

Fields

Fields	Description
o	int64 offset unix nano time from channel created to this message generated.
ch	string Channel id
n	string Optional. Channel name
d	object (Struct) Metadata of channel
ca	int64 Unix nano time of channel created.

Message.CloseChannel

Representation

{
  "o": int64,
  "ch": string
}

Fields

Fields	Description
o	int64 offset unix nano time from channel created to this message generated.
ch	string Channel id