# Constants
The current user has blocked this user.
The user is a friend of the current user.
The current user has received an invite from this user.
The current user has sent an invite to the user.
The user is an admin with additional privileges.
The user has requested to join the group.
The user is a regular member.
The user is a superadmin with full control of the group.
Override the leaderboard operator with BEST.
Override the leaderboard operator with DECREMENT.
Override the leaderboard operator with INCREMENT.
Do not override the leaderboard operator.
Override the leaderboard operator with SET.
The user is an admin with additional privileges.
The user has requested to join the group.
The user is a regular member.
The user is a superadmin with full control of the group.
Apple App Store.
Google Play Store.
Huawei App Gallery.
Production environment.
Sandbox/test environment.
Unknown environment.
# Variables
No description provided by the author
Enum value maps for Friend_State.
Enum value maps for Friend_State.
Enum value maps for GroupUserList_GroupUser_State.
Enum value maps for GroupUserList_GroupUser_State.
Enum value maps for Operator.
Enum value maps for Operator.
Enum value maps for UserGroupList_UserGroup_State.
Enum value maps for UserGroupList_UserGroup_State.
Enum value maps for ValidatedPurchase_Environment.
Enum value maps for ValidatedPurchase_Environment.
Enum value maps for ValidatedPurchase_Store.
Enum value maps for ValidatedPurchase_Store.
# Structs
A user with additional account details.
Send a Apple Sign In token to the server.
Send a custom ID to the server.
Send a device to the server.
Send an email with password to the server.
Send a Facebook token to the server.
Send a Facebook Instant Game token to the server.
Send Apple's Game Center account credentials to the server.
Send a Google token to the server.
Obtain a new authentication token using a refresh token.
Send a Steam token to the server.
Add one or more friends to the current user.
Add users to a group.
Authenticate against the server with Apple Sign In.
Authenticate against the server with a custom ID.
Authenticate against the server with a device ID.
Authenticate against the server with email+password.
Authenticate against the server with Facebook Instant Game token.
Authenticate against the server with Facebook.
Authenticate against the server with Apple's Game Center.
Authenticate against the server with Google.
Authenticate against the server with Steam.
Ban users from a group.
Block one or more friends for the current user.
A message sent on a channel.
A list of channel messages, usually a result of a list operation.
Meta Charater clouth.
Create a group with the current user as owner.
Delete one or more friends for the current user.
Delete a group the user has access to.
Delete a leaderboard record.
Delete one or more notifications for the current user.
Storage objects to delete.
Batch delete storage objects.
Demote a set of users in a group to the next role down.
Represents an event to be passed through the server to registered event handlers.
A friend of a user.
A collection of zero or more friends of the user.
Fetch a batch of zero or more users from the server.
A group in the server.
One or more groups returned from a listing operation.
A list of users belonging to a group, along with their role.
A single user-role pair.
Import Facebook friends into the current user's account.
Import Facebook friends into the current user's account.
Immediately join an open group, or request to join a closed one.
The request to join a tournament.
Kick a set of users from a group.
A leaderboard on the server.
A list of leaderboards.
Represents a complete leaderboard record with all scores and associated metadata.
A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records.
Leave a group.
Link Facebook to the current user's account.
Link Steam to the current user's account.
List a channel's message history.
List friends for a user.
List groups based on given filters.
List all users that are part of a group.
List leaerboard records from a given leaderboard around the owner.
List leaderboard records from a given leaderboard.
List realtime matches.
Get a list of unexpired notifications.
List publicly readable storage objects in a given collection.
List tournament records from a given tournament around the owner.
List tournament records from a given tournament.
List active/upcoming tournaments based on given filters.
List the groups a user is part of, and their relationship to each.
Represents a realtime match.
A list of realtime matches.
A notification in the server.
A collection of zero or more notifications.
Promote a set of users in a group to the next role up.
A list of validated purchases stored by Nakama.
Storage objects to get.
Batch get storage objects.
Execute an Lua function on the server.
A user's session used to authenticate messages.
Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
Authenticate against the server with a refresh token.
An object within the storage engine.
A storage acknowledgement.
Batch of acknowledgements for the storage object write.
List of storage objects.
Batch of storage objects.
A tournament on the server.
A list of tournaments.
A set of tournament records which may be part of a tournament records page or a batch of individual records.
Update a user's account details.
Update fields in a given group.
A user in the server.
A list of groups belonging to a user, along with the user's role in each group.
A single group-role pair.
A collection of zero or more users.
Validated Purchase stored by Nakama.
Apple IAP Purchases validation request.
Google IAP Purchase validation request.
Huawei IAP Purchase validation request.
Validate IAP response.
A request to submit a score to a leaderboard.
Record values to write.
The object to store.
Write objects to the storage engine.
A request to submit a score to a tournament.
Record values to write.
# Type aliases
The friendship status.
The group role status.
Operator that can be used to override the one set in the leaderboard.
The group role status.
Environment where the purchase took place.
Validation Provider.