Heroic Labs · Schema

apiNotification

A notification in the server.

Game BackendMultiplayerReal-TimeWebSocketMatchmakingLeaderboardsSocial GamingOpen SourceLiveOpsgRPC

Properties

Name	Type	Description
id	string	ID of the Notification.
subject	string	Subject of the notification.
content	string	Content of the notification in JSON.
code	integer	Category code for this notification.
senderId	string	ID of the sender, if a user. Otherwise 'null'.
createTime	string	The UNIX time (for gRPC clients) or ISO string (for REST clients) when the notification was created.
persistent	boolean	True if this notification was persisted to the database.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/heroiclabs/json-schema/apiNotification.json",
  "title": "apiNotification",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the Notification."
    },
    "subject": {
      "type": "string",
      "description": "Subject of the notification."
    },
    "content": {
      "type": "string",
      "description": "Content of the notification in JSON."
    },
    "code": {
      "type": "integer",
      "format": "int32",
      "description": "Category code for this notification."
    },
    "senderId": {
      "type": "string",
      "description": "ID of the sender, if a user. Otherwise 'null'."
    },
    "createTime": {
      "type": "string",
      "format": "date-time",
      "description": "The UNIX time (for gRPC clients) or ISO string (for REST clients) when the notification was created."
    },
    "persistent": {
      "type": "boolean",
      "description": "True if this notification was persisted to the database."
    }
  },
  "description": "A notification in the server."
}