GS2-Matchmaking Transaction Actions

Specification of verify/consume/acquire transaction actions
Tags:

Verify Action

Gs2Matchmaking:VerifyIncludeParticipantByUserId

Verify if persistent gathering includes user ID by specifying a user ID

Verifies whether the specified user is or is not a participant of the season gathering.

Supports quantity specification: NO

Type Condition Required Default Value Limits Description
namespaceName string
✓
 ~ 128 chars Namespace name
Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
seasonName string
✓
 ~ 128 chars Season Model name
Season Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
season long
✓
 0 ~ 9223372036854775805 Season
tier long
✓
 0 ~ 9223372036854775805 Tier
The tier level used to group players of similar rank together.
Determined by the player’s rank in the GS2-Experience model specified in the SeasonModel.
Players are only matched with others in the same tier, ensuring fair competition.
seasonGatheringName string
✓
 UUID ~ 128 chars Season Gathering Name
Season Gathering-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId string
✓
 ~ 128 chars User ID
Specify #{userId} to substitute the currently logged-in user’s ID.
verifyType string (enum)
enum {
  “include”,
  “notInclude”
}
✓
 Type of verification
DefinitionDescription
“include”Specified user is included in the Season Gathering
“notInclude”Specified user is not included in the Season Gathering
timeOffsetToken string ~ 1024 chars Time offset token 
{
    "action": "Gs2Matchmaking:VerifyIncludeParticipantByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "seasonName": "[string]Season Model name",
        "season": "[long]Season",
        "tier": "[long]Tier",
        "seasonGatheringName": "[string]Season Gathering Name",
        "userId": "[string]User ID",
        "verifyType": "[string]Type of verification",
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2Matchmaking:VerifyIncludeParticipantByUserId
request:
  namespaceName: "[string]Namespace name"
  seasonName: "[string]Season Model name"
  season: "[long]Season"
  tier: "[long]Tier"
  seasonGatheringName: "[string]Season Gathering Name"
  userId: "[string]User ID"
  verifyType: "[string]Type of verification"
  timeOffsetToken: "[string]Time offset token"
transaction.service("matchmaking").verify.verify_include_participant_by_user_id({
    namespaceName="[string]Namespace name",
    seasonName="[string]Season Model name",
    season="[long]Season",
    tier="[long]Tier",
    seasonGatheringName="[string]Season Gathering Name",
    userId="[string]User ID",
    verifyType="[string]Type of verification",
    timeOffsetToken="[string]Time offset token",
})