Heroic Labs · Schema

apiChannelMessage

A message sent on a channel.

Game BackendMultiplayerReal-TimeWebSocketMatchmakingLeaderboardsSocial GamingOpen SourceLiveOpsgRPC

Properties

Name	Type	Description
channelId	string	The channel this message belongs to.
messageId	string	The unique ID of this message.
code	integer	The code representing a message type or category.
senderId	string	Message sender, usually a user ID.
username	string	The username of the message sender, if any.
content	string	The content payload.
createTime	string	The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
updateTime	string	The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated.
persistent	boolean	True if the message was persisted to the channel's history, false otherwise.
roomName	string	The name of the chat room, or an empty string if this message was not sent through a chat room.
groupId	string	The ID of the group, or an empty string if this message was not sent through a group channel.
userIdOne	string	The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
userIdTwo	string	The ID of the second DM user, or an empty string if this message was not sent through a DM chat.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/heroiclabs/json-schema/apiChannelMessage.json",
  "title": "apiChannelMessage",
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string",
      "description": "The channel this message belongs to."
    },
    "messageId": {
      "type": "string",
      "description": "The unique ID of this message."
    },
    "code": {
      "type": "integer",
      "format": "int32",
      "description": "The code representing a message type or category."
    },
    "senderId": {
      "type": "string",
      "description": "Message sender, usually a user ID."
    },
    "username": {
      "type": "string",
      "description": "The username of the message sender, if any."
    },
    "content": {
      "type": "string",
      "description": "The content payload."
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created."
    },
    "updateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated."
    },
    "persistent": {
      "type": "boolean",
      "description": "True if the message was persisted to the channel's history, false otherwise."
    },
    "roomName": {
      "type": "string",
      "description": "The name of the chat room, or an empty string if this message was not sent through a chat room."
    },
    "groupId": {
      "type": "string",
      "description": "The ID of the group, or an empty string if this message was not sent through a group channel."
    },
    "userIdOne": {
      "type": "string",
      "description": "The ID of the first DM user, or an empty string if this message was not sent through a DM chat."
    },
    "userIdTwo": {
      "type": "string",
      "description": "The ID of the second DM user, or an empty string if this message was not sent through a DM chat."
    }
  },
  "description": "A message sent on a channel."
}