Master Data Reference of GS2-Guild
{
"version": "2024-04-25",
"guildModels": [
{
"name": "[string]Guild Model Name",
"metadata": "[string?]metadata",
"defaultMaximumMemberCount": "[int]Maximum number of guild members that will be applied when creating a guild",
"maximumMemberCount": "[int]Maximum number of guild members that can be applied",
"inactivityPeriodDays": "[int]Number of days of inactivity of the guild master to select a new guild master from the guild members",
"roles": [
{
"name": "[string]Role Model Name",
"metadata": "[string?]metadata",
"policyDocument": "[string]Policy document for permissions to apply to roles"
}
],
"guildMasterRole": "[string]Role that guild masters have",
"guildMemberDefaultRole": "[string]Role that guild members have in the initial state",
"rejoinCoolTimeMinutes": "[int]Cool time until you can join again after leaving the guild (minutes)",
"maxConcurrentJoinGuilds": "[int?]Maximum number of guilds that can be joined at the same time",
"maxConcurrentGuildMasterCount": "[int?]Maximum number of guild masters that can exist at the same time"
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2024-04-25 | Format version of master data | |||
guildModels | List<GuildModel> | ~ 100 items | Guild Model Master |
GuildModel
Guild Model Master
A guild model is an entity that sets the maximum number of people who can join the guild and the permission settings for each position within the guild.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
guildModelId | string | ✓ | ~ 1024 chars | Guild Model GRN | ||
name | string | ✓ | ~ 128 chars | Guild Model Name | ||
metadata | string | ~ 2048 chars | metadata | |||
defaultMaximumMemberCount | int | ✓ | 1 ~ 2147483646 | Maximum number of guild members that will be applied when creating a guild | ||
maximumMemberCount | int | ✓ | 1 ~ 2147483646 | Maximum number of guild members that can be applied | ||
inactivityPeriodDays | int | ✓ | 7 | 1 ~ 365 | Number of days of inactivity of the guild master to select a new guild master from the guild members | |
roles | List<RoleModel> | ✓ | 1 ~ 10 items | List of permission settings for each position in the guild | ||
guildMasterRole | string | ✓ | ~ 128 chars | Role that guild masters have | ||
guildMemberDefaultRole | string | ✓ | ~ 128 chars | Role that guild members have in the initial state | ||
rejoinCoolTimeMinutes | int | ✓ | 0 | ~ 2147483646 | Cool time until you can join again after leaving the guild (minutes) | |
maxConcurrentJoinGuilds | int | 1 ~ 10 | Maximum number of guilds that can be joined at the same time | |||
maxConcurrentGuildMasterCount | int | 1 ~ 100 | Maximum number of guild masters that can exist at the same time |
RoleModel
Role Model
The role model defines the role within the guild and sets the permissions for each role.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Role Model Name | ||
metadata | string | ~ 2048 chars | metadata | |||
policyDocument | string | ✓ | ~ 10240 chars | Policy document for permissions to apply to roles |
Member
Guild
An entity that manages a list of guild members
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
userId | string | ✓ | ~ 128 chars | User Id | ||
roleName | string | ✓ | ~ 128 chars | Role Model Name | ||
joinedAt | long | ✓ | Now | Join date (Unix time unit:milliseconds) |
VerifyActionResult
Verify action execution result
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the verify task | ||
verifyRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
statusCode | int | ~ 999 | Status code | |||
verifyResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
Enumerator String Definition | Description |
---|
ConsumeActionResult
Consume action execution result
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the consume action | ||
consumeRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
statusCode | int | ~ 999 | Status code | |||
consumeResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
Enumerator String Definition | Description |
---|
AcquireActionResult
Acquire action execution result
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum { } | ✓ | ~ 128 chars | Types of actions to be performed in the acquire action | ||
acquireRequest | string | ✓ | ~ 1048576 chars | JSON of request | ||
statusCode | int | ~ 999 | Status code | |||
acquireResult | string | ~ 1048576 chars | Result payload |
Enumeration type definition to specify as action
Enumerator String Definition | Description |
---|
TransactionResult
Transaction execution results
Transaction execution results executed using server-side transaction auto-execution functionality
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
transactionId | string | ✓ | 36 ~ 36 chars | Transaction ID | ||
verifyResults | List<VerifyActionResult> | ~ 10 items | List of verify action execution results | |||
consumeResults | List<ConsumeActionResult> | ~ 10 items | List of consume action execution results | |||
acquireResults | List<AcquireActionResult> | ~ 100 items | List of acquire action execution results |