| Class | Description |
|---|---|
| Account |
A user with additional account details.
|
| Account.Builder |
A user with additional account details.
|
| AccountApple |
Send a Apple Sign In token to the server.
|
| AccountApple.Builder |
Send a Apple Sign In token to the server.
|
| AccountCustom |
Send a custom ID to the server.
|
| AccountCustom.Builder |
Send a custom ID to the server.
|
| AccountDevice |
Send a device to the server.
|
| AccountDevice.Builder |
Send a device to the server.
|
| AccountEmail |
Send an email with password to the server.
|
| AccountEmail.Builder |
Send an email with password to the server.
|
| AccountFacebook |
Send a Facebook token to the server.
|
| AccountFacebook.Builder |
Send a Facebook token to the server.
|
| AccountFacebookInstantGame |
Send a Facebook Instant Game token to the server.
|
| AccountFacebookInstantGame.Builder |
Send a Facebook Instant Game token to the server.
|
| AccountGameCenter |
Send Apple's Game Center account credentials to the server.
|
| AccountGameCenter.Builder |
Send Apple's Game Center account credentials to the server.
|
| AccountGoogle |
Send a Google token to the server.
|
| AccountGoogle.Builder |
Send a Google token to the server.
|
| AccountRefresh |
Obtain a new authentication token using a refresh token.
|
| AccountRefresh.Builder |
Obtain a new authentication token using a refresh token.
|
| AccountSteam |
Send a Steam token to the server.
|
| AccountSteam.Builder |
Send a Steam token to the server.
|
| AddFriendsRequest |
Add one or more friends to the current user.
|
| AddFriendsRequest.Builder |
Add one or more friends to the current user.
|
| AddGroupUsersRequest |
Add users to a group.
|
| AddGroupUsersRequest.Builder |
Add users to a group.
|
| ApigrpcProto | |
| ApiProto | |
| AuthenticateAppleRequest |
Authenticate against the server with Apple Sign In.
|
| AuthenticateAppleRequest.Builder |
Authenticate against the server with Apple Sign In.
|
| AuthenticateCustomRequest |
Authenticate against the server with a custom ID.
|
| AuthenticateCustomRequest.Builder |
Authenticate against the server with a custom ID.
|
| AuthenticateDeviceRequest |
Authenticate against the server with a device ID.
|
| AuthenticateDeviceRequest.Builder |
Authenticate against the server with a device ID.
|
| AuthenticateEmailRequest |
Authenticate against the server with email+password.
|
| AuthenticateEmailRequest.Builder |
Authenticate against the server with email+password.
|
| AuthenticateFacebookInstantGameRequest |
Authenticate against the server with Facebook Instant Game token.
|
| AuthenticateFacebookInstantGameRequest.Builder |
Authenticate against the server with Facebook Instant Game token.
|
| AuthenticateFacebookRequest |
Authenticate against the server with Facebook.
|
| AuthenticateFacebookRequest.Builder |
Authenticate against the server with Facebook.
|
| AuthenticateGameCenterRequest |
Authenticate against the server with Apple's Game Center.
|
| AuthenticateGameCenterRequest.Builder |
Authenticate against the server with Apple's Game Center.
|
| AuthenticateGoogleRequest |
Authenticate against the server with Google.
|
| AuthenticateGoogleRequest.Builder |
Authenticate against the server with Google.
|
| AuthenticateSteamRequest |
Authenticate against the server with Steam.
|
| AuthenticateSteamRequest.Builder |
Authenticate against the server with Steam.
|
| BanGroupUsersRequest |
Ban users from a group.
|
| BanGroupUsersRequest.Builder |
Ban users from a group.
|
| BlockFriendsRequest |
Block one or more friends for the current user.
|
| BlockFriendsRequest.Builder |
Block one or more friends for the current user.
|
| ChannelMessage |
A message sent on a channel.
|
| ChannelMessage.Builder |
A message sent on a channel.
|
| ChannelMessageList |
A list of channel messages, usually a result of a list operation.
|
| ChannelMessageList.Builder |
A list of channel messages, usually a result of a list operation.
|
| CreateGroupRequest |
Create a group with the current user as owner.
|
| CreateGroupRequest.Builder |
Create a group with the current user as owner.
|
| DeleteFriendsRequest |
Delete one or more friends for the current user.
|
| DeleteFriendsRequest.Builder |
Delete one or more friends for the current user.
|
| DeleteGroupRequest |
Delete a group the user has access to.
|
| DeleteGroupRequest.Builder |
Delete a group the user has access to.
|
| DeleteLeaderboardRecordRequest |
Delete a leaderboard record.
|
| DeleteLeaderboardRecordRequest.Builder |
Delete a leaderboard record.
|
| DeleteNotificationsRequest |
Delete one or more notifications for the current user.
|
| DeleteNotificationsRequest.Builder |
Delete one or more notifications for the current user.
|
| DeleteStorageObjectId |
Storage objects to delete.
|
| DeleteStorageObjectId.Builder |
Storage objects to delete.
|
| DeleteStorageObjectsRequest |
Batch delete storage objects.
|
| DeleteStorageObjectsRequest.Builder |
Batch delete storage objects.
|
| DeleteTournamentRecordRequest |
Delete a leaderboard record.
|
| DeleteTournamentRecordRequest.Builder |
Delete a leaderboard record.
|
| DemoteGroupUsersRequest |
Demote a set of users in a group to the next role down.
|
| DemoteGroupUsersRequest.Builder |
Demote a set of users in a group to the next role down.
|
| Event |
Represents an event to be passed through the server to registered event handlers.
|
| Event.Builder |
Represents an event to be passed through the server to registered event handlers.
|
| Friend |
A friend of a user.
|
| Friend.Builder |
A friend of a user.
|
| FriendList |
A collection of zero or more friends of the user.
|
| FriendList.Builder |
A collection of zero or more friends of the user.
|
| FriendsOfFriendsList |
A List of friends of friends
|
| FriendsOfFriendsList.Builder |
A List of friends of friends
|
| FriendsOfFriendsList.FriendOfFriend |
A friend of a friend.
|
| FriendsOfFriendsList.FriendOfFriend.Builder |
A friend of a friend.
|
| GetSubscriptionRequest |
Fetch a subscription by product id.
|
| GetSubscriptionRequest.Builder |
Fetch a subscription by product id.
|
| GetUsersRequest |
Fetch a batch of zero or more users from the server.
|
| GetUsersRequest.Builder |
Fetch a batch of zero or more users from the server.
|
| Group |
A group in the server.
|
| Group.Builder |
A group in the server.
|
| GroupList |
One or more groups returned from a listing operation.
|
| GroupList.Builder |
One or more groups returned from a listing operation.
|
| GroupUserList |
A list of users belonging to a group, along with their role.
|
| GroupUserList.Builder |
A list of users belonging to a group, along with their role.
|
| GroupUserList.GroupUser |
A single user-role pair.
|
| GroupUserList.GroupUser.Builder |
A single user-role pair.
|
| ImportFacebookFriendsRequest |
Import Facebook friends into the current user's account.
|
| ImportFacebookFriendsRequest.Builder |
Import Facebook friends into the current user's account.
|
| ImportSteamFriendsRequest |
Import Facebook friends into the current user's account.
|
| ImportSteamFriendsRequest.Builder |
Import Facebook friends into the current user's account.
|
| JoinGroupRequest |
Immediately join an open group, or request to join a closed one.
|
| JoinGroupRequest.Builder |
Immediately join an open group, or request to join a closed one.
|
| JoinTournamentRequest |
The request to join a tournament.
|
| JoinTournamentRequest.Builder |
The request to join a tournament.
|
| KickGroupUsersRequest |
Kick a set of users from a group.
|
| KickGroupUsersRequest.Builder |
Kick a set of users from a group.
|
| Leaderboard |
A leaderboard on the server.
|
| Leaderboard.Builder |
A leaderboard on the server.
|
| LeaderboardList |
A list of leaderboards
|
| LeaderboardList.Builder |
A list of leaderboards
|
| LeaderboardRecord |
Represents a complete leaderboard record with all scores and associated metadata.
|
| LeaderboardRecord.Builder |
Represents a complete leaderboard record with all scores and associated metadata.
|
| LeaderboardRecordList |
A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records.
|
| LeaderboardRecordList.Builder |
A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records.
|
| LeaveGroupRequest |
Leave a group.
|
| LeaveGroupRequest.Builder |
Leave a group.
|
| LinkFacebookRequest |
Link Facebook to the current user's account.
|
| LinkFacebookRequest.Builder |
Link Facebook to the current user's account.
|
| LinkSteamRequest |
Link Steam to the current user's account.
|
| LinkSteamRequest.Builder |
Link Steam to the current user's account.
|
| ListChannelMessagesRequest |
List a channel's message history.
|
| ListChannelMessagesRequest.Builder |
List a channel's message history.
|
| ListFriendsOfFriendsRequest |
Protobuf type
nakama.api.ListFriendsOfFriendsRequest |
| ListFriendsOfFriendsRequest.Builder |
Protobuf type
nakama.api.ListFriendsOfFriendsRequest |
| ListFriendsRequest |
List friends for a user.
|
| ListFriendsRequest.Builder |
List friends for a user.
|
| ListGroupsRequest |
List groups based on given filters.
|
| ListGroupsRequest.Builder |
List groups based on given filters.
|
| ListGroupUsersRequest |
List all users that are part of a group.
|
| ListGroupUsersRequest.Builder |
List all users that are part of a group.
|
| ListLeaderboardRecordsAroundOwnerRequest |
List leaerboard records from a given leaderboard around the owner.
|
| ListLeaderboardRecordsAroundOwnerRequest.Builder |
List leaerboard records from a given leaderboard around the owner.
|
| ListLeaderboardRecordsRequest |
List leaderboard records from a given leaderboard.
|
| ListLeaderboardRecordsRequest.Builder |
List leaderboard records from a given leaderboard.
|
| ListMatchesRequest |
List realtime matches.
|
| ListMatchesRequest.Builder |
List realtime matches.
|
| ListNotificationsRequest |
Get a list of unexpired notifications.
|
| ListNotificationsRequest.Builder |
Get a list of unexpired notifications.
|
| ListStorageObjectsRequest |
List publicly readable storage objects in a given collection.
|
| ListStorageObjectsRequest.Builder |
List publicly readable storage objects in a given collection.
|
| ListSubscriptionsRequest |
List user subscriptions.
|
| ListSubscriptionsRequest.Builder |
List user subscriptions.
|
| ListTournamentRecordsAroundOwnerRequest |
List tournament records from a given tournament around the owner.
|
| ListTournamentRecordsAroundOwnerRequest.Builder |
List tournament records from a given tournament around the owner.
|
| ListTournamentRecordsRequest |
List tournament records from a given tournament.
|
| ListTournamentRecordsRequest.Builder |
List tournament records from a given tournament.
|
| ListTournamentsRequest |
List active/upcoming tournaments based on given filters.
|
| ListTournamentsRequest.Builder |
List active/upcoming tournaments based on given filters.
|
| ListUserGroupsRequest |
List the groups a user is part of, and their relationship to each.
|
| ListUserGroupsRequest.Builder |
List the groups a user is part of, and their relationship to each.
|
| Match |
Represents a realtime match.
|
| Match.Builder |
Represents a realtime match.
|
| MatchList |
A list of realtime matches.
|
| MatchList.Builder |
A list of realtime matches.
|
| MatchmakerCompletionStats |
Matchmaker ticket completion stats
|
| MatchmakerCompletionStats.Builder |
Matchmaker ticket completion stats
|
| MatchmakerStats |
Matchmaker stats
|
| MatchmakerStats.Builder |
Matchmaker stats
|
| NakamaGrpc |
The Nakama RPC protocol service built with GRPC.
|
| NakamaGrpc.NakamaBlockingStub |
A stub to allow clients to do synchronous rpc calls to service Nakama.
|
| NakamaGrpc.NakamaFutureStub |
A stub to allow clients to do ListenableFuture-style rpc calls to service Nakama.
|
| NakamaGrpc.NakamaImplBase |
Base class for the server implementation of the service Nakama.
|
| NakamaGrpc.NakamaStub |
A stub to allow clients to do asynchronous rpc calls to service Nakama.
|
| Notification |
A notification in the server.
|
| Notification.Builder |
A notification in the server.
|
| NotificationList |
A collection of zero or more notifications.
|
| NotificationList.Builder |
A collection of zero or more notifications.
|
| PromoteGroupUsersRequest |
Promote a set of users in a group to the next role up.
|
| PromoteGroupUsersRequest.Builder |
Promote a set of users in a group to the next role up.
|
| PurchaseList |
A list of validated purchases stored by Nakama.
|
| PurchaseList.Builder |
A list of validated purchases stored by Nakama.
|
| ReadStorageObjectId |
Storage objects to get.
|
| ReadStorageObjectId.Builder |
Storage objects to get.
|
| ReadStorageObjectsRequest |
Batch get storage objects.
|
| ReadStorageObjectsRequest.Builder |
Batch get storage objects.
|
| Rpc |
Execute an Lua function on the server.
|
| Rpc.Builder |
Execute an Lua function on the server.
|
| Session |
A user's session used to authenticate messages.
|
| Session.Builder |
A user's session used to authenticate messages.
|
| SessionLogoutRequest |
Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
|
| SessionLogoutRequest.Builder |
Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
|
| SessionRefreshRequest |
Authenticate against the server with a refresh token.
|
| SessionRefreshRequest.Builder |
Authenticate against the server with a refresh token.
|
| StorageObject |
An object within the storage engine.
|
| StorageObject.Builder |
An object within the storage engine.
|
| StorageObjectAck |
A storage acknowledgement.
|
| StorageObjectAck.Builder |
A storage acknowledgement.
|
| StorageObjectAcks |
Batch of acknowledgements for the storage object write.
|
| StorageObjectAcks.Builder |
Batch of acknowledgements for the storage object write.
|
| StorageObjectList |
List of storage objects.
|
| StorageObjectList.Builder |
List of storage objects.
|
| StorageObjects |
Batch of storage objects.
|
| StorageObjects.Builder |
Batch of storage objects.
|
| SubscriptionList |
A list of validated subscriptions stored by Nakama.
|
| SubscriptionList.Builder |
A list of validated subscriptions stored by Nakama.
|
| Tournament |
A tournament on the server.
|
| Tournament.Builder |
A tournament on the server.
|
| TournamentList |
A list of tournaments.
|
| TournamentList.Builder |
A list of tournaments.
|
| TournamentRecordList |
A set of tournament records which may be part of a tournament records page or a batch of individual records.
|
| TournamentRecordList.Builder |
A set of tournament records which may be part of a tournament records page or a batch of individual records.
|
| UpdateAccountRequest |
Update a user's account details.
|
| UpdateAccountRequest.Builder |
Update a user's account details.
|
| UpdateGroupRequest |
Update fields in a given group.
|
| UpdateGroupRequest.Builder |
Update fields in a given group.
|
| User |
A user in the server.
|
| User.Builder |
A user in the server.
|
| UserGroupList |
A list of groups belonging to a user, along with the user's role in each group.
|
| UserGroupList.Builder |
A list of groups belonging to a user, along with the user's role in each group.
|
| UserGroupList.UserGroup |
A single group-role pair.
|
| UserGroupList.UserGroup.Builder |
A single group-role pair.
|
| Users |
A collection of zero or more users.
|
| Users.Builder |
A collection of zero or more users.
|
| ValidatedPurchase |
Validated Purchase stored by Nakama.
|
| ValidatedPurchase.Builder |
Validated Purchase stored by Nakama.
|
| ValidatedSubscription |
Protobuf type
nakama.api.ValidatedSubscription |
| ValidatedSubscription.Builder |
Protobuf type
nakama.api.ValidatedSubscription |
| ValidatePurchaseAppleRequest |
Apple IAP Purchases validation request
|
| ValidatePurchaseAppleRequest.Builder |
Apple IAP Purchases validation request
|
| ValidatePurchaseFacebookInstantRequest |
Facebook Instant IAP Purchase validation request
|
| ValidatePurchaseFacebookInstantRequest.Builder |
Facebook Instant IAP Purchase validation request
|
| ValidatePurchaseGoogleRequest |
Google IAP Purchase validation request
|
| ValidatePurchaseGoogleRequest.Builder |
Google IAP Purchase validation request
|
| ValidatePurchaseHuaweiRequest |
Huawei IAP Purchase validation request
|
| ValidatePurchaseHuaweiRequest.Builder |
Huawei IAP Purchase validation request
|
| ValidatePurchaseResponse |
Validate IAP response.
|
| ValidatePurchaseResponse.Builder |
Validate IAP response.
|
| ValidateSubscriptionAppleRequest |
Apple Subscription validation request
|
| ValidateSubscriptionAppleRequest.Builder |
Apple Subscription validation request
|
| ValidateSubscriptionGoogleRequest |
Google Subscription validation request
|
| ValidateSubscriptionGoogleRequest.Builder |
Google Subscription validation request
|
| ValidateSubscriptionResponse |
Validate Subscription response.
|
| ValidateSubscriptionResponse.Builder |
Validate Subscription response.
|
| WriteLeaderboardRecordRequest |
A request to submit a score to a leaderboard.
|
| WriteLeaderboardRecordRequest.Builder |
A request to submit a score to a leaderboard.
|
| WriteLeaderboardRecordRequest.LeaderboardRecordWrite |
Record values to write.
|
| WriteLeaderboardRecordRequest.LeaderboardRecordWrite.Builder |
Record values to write.
|
| WriteStorageObject |
The object to store.
|
| WriteStorageObject.Builder |
The object to store.
|
| WriteStorageObjectsRequest |
Write objects to the storage engine.
|
| WriteStorageObjectsRequest.Builder |
Write objects to the storage engine.
|
| WriteTournamentRecordRequest |
A request to submit a score to a tournament.
|
| WriteTournamentRecordRequest.Builder |
A request to submit a score to a tournament.
|
| WriteTournamentRecordRequest.TournamentRecordWrite |
Record values to write.
|
| WriteTournamentRecordRequest.TournamentRecordWrite.Builder |
Record values to write.
|
| Enum | Description |
|---|---|
| Friend.State |
The friendship status.
|
| GroupUserList.GroupUser.State |
The group role status.
|
| Operator |
Operator that can be used to override the one set in the leaderboard.
|
| StoreEnvironment |
Environment where a purchase/subscription took place,
|
| StoreProvider |
Validation Provider,
|
| UserGroupList.UserGroup.State |
The group role status.
|