GS2-Chat Master Data Reference

Reference for the master data format and the models to be imported

Master Data Format

{
  "version": "2020-04-30",
  "categoryModels": [
    {
      "category": "[int]Category",
      "rejectAccessTokenPost": "[string (enum)?]Reject posts made using player access tokens"
    }
  ]
}
TypeConditionRequiredDefaultValue LimitsDescription
versionstring
2020-04-30Master data format version
categoryModelsList<CategoryModel>~ 1000 itemsMessage Category Model
A Message Category Model defines the categories used to classify messages posted in chat rooms.
Each category is identified by a numeric value, and you can configure whether posts using player access tokens are accepted or rejected per category.
This enables use cases such as system-only announcement categories where only the server can post messages.

Models

CategoryModel

Message Category Model

A Message Category Model defines the categories used to classify messages posted in chat rooms. Each category is identified by a numeric value, and you can configure whether posts using player access tokens are accepted or rejected per category. This enables use cases such as system-only announcement categories where only the server can post messages.

TypeConditionRequiredDefaultValue LimitsDescription
categoryModelIdstring
*
~ 1024 charsMessage Category Model GRN
* Set automatically by the server
categoryint
0 ~ 2147483645Category
A numeric identifier for the message category. Messages posted with this category number will follow the rules defined in this model, such as whether player posts are allowed or rejected.
rejectAccessTokenPoststring (enum)
enum {
  “Enabled”,
  “Disabled”
}
Reject posts made using player access tokens
When enabled, only server-side API calls specifying a user ID can post messages in this category. This is useful for system announcements or server-generated messages that should not be posted by players directly.
DefinitionDescription
“Enabled”Reject posts made using player access tokens
“Disabled”Allow posts made using player access tokens