Module nakama_rs::api

Structs

ApiAccount	A user with additional account details. Always the current user.
ApiAccountApple	Send a Apple Sign In token to the server. Used with authenticate/link/unlink.
ApiAccountCustom	Send a custom ID to the server. Used with authenticate/link/unlink.
ApiAccountDevice	Send a device to the server. Used with authenticate/link/unlink and user.
ApiAccountEmail	Send an email with password to the server. Used with authenticate/link/unlink.
ApiAccountFacebook	Send a Facebook token to the server. Used with authenticate/link/unlink.
ApiAccountFacebookInstantGame	Send a Facebook Instant Game token to the server. Used with authenticate/link/unlink.
ApiAccountGameCenter	Send Apple’s Game Center account credentials to the server. Used with authenticate/link/unlink.
ApiAccountGoogle	Send a Google token to the server. Used with authenticate/link/unlink.
ApiAccountSteam	Send a Steam token to the server. Used with authenticate/link/unlink.
ApiChannelMessage	A message sent on a channel.
ApiChannelMessageList	A list of channel messages, usually a result of a list operation.
ApiCreateGroupRequest	Create a group with the current user as owner.
ApiDeleteStorageObjectId	Storage objects to delete.
ApiDeleteStorageObjectsRequest	Batch delete storage objects.
ApiEvent	Represents an event to be passed through the server to registered event handlers.
ApiFriend	A friend of a user.
ApiFriendList	A collection of zero or more friends of the user.
ApiGroup	A group in the server.
ApiGroupList	One or more groups returned from a listing operation.
ApiGroupUserList	A list of users belonging to a group, along with their role.
ApiLeaderboardRecord	Represents a complete leaderboard record with all scores and associated metadata.
ApiLeaderboardRecordList	A set of leaderboard records, may be part of a leaderboard records page or a batch of individual records.
ApiLinkSteamRequest	Link Steam to the current user’s account.
ApiMatch	Represents a realtime match.
ApiMatchList	A list of realtime matches.
ApiNotification	A notification in the server.
ApiNotificationList	A collection of zero or more notifications.
ApiReadStorageObjectId	Storage objects to get.
ApiReadStorageObjectsRequest	Batch get storage objects.
ApiRpc	Execute an Lua function on the server.
ApiSession	A user’s session used to authenticate messages.
ApiSessionLogoutRequest	Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
ApiSessionRefreshRequest	Authenticate against the server with a refresh token.
ApiStorageObject	An object within the storage engine.
ApiStorageObjectAck	A storage acknowledgement.
ApiStorageObjectAcks	Batch of acknowledgements for the storage object write.
ApiStorageObjectList	List of storage objects.
ApiStorageObjects	Batch of storage objects.
ApiTournament	A tournament on the server.
ApiTournamentList	A list of tournaments.
ApiTournamentRecordList	A set of tournament records which may be part of a tournament records page or a batch of individual records.
ApiUpdateAccountRequest	Update a user’s account details.
ApiUpdateGroupRequest	Update fields in a given group.
ApiUser	A user in the server.
ApiUserGroupList	A list of groups belonging to a user, along with the user’s role in each group.
ApiUsers	A collection of zero or more users.
ApiWriteStorageObject	The object to store.
ApiWriteStorageObjectsRequest	Write objects to the storage engine.
GroupUserListGroupUser	A single user-role pair.
ProtobufAny
RestRequest
RpcStatus
UserGroupListUserGroup	A single group-role pair.
WriteLeaderboardRecordRequestLeaderboardRecordWrite	Record values to write.
WriteTournamentRecordRequestTournamentRecordWrite	Record values to write.

Enums

Authentication
Method

Functions

add_friends	Add friends by ID or username to a user’s account.
add_group_users	Add users to a group.
authenticate_apple	Authenticate a user with an Apple ID against the server.
authenticate_custom	Authenticate a user with a custom id against the server.
authenticate_device	Authenticate a user with a device id against the server.
authenticate_email	Authenticate a user with an email+password against the server.
authenticate_facebook	Authenticate a user with a Facebook OAuth token against the server.
authenticate_facebook_instant_game	Authenticate a user with a Facebook Instant Game token against the server.
authenticate_game_center	Authenticate a user with Apple’s GameCenter against the server.
authenticate_google	Authenticate a user with Google against the server.
authenticate_steam	Authenticate a user with Steam against the server.
ban_group_users	Ban a set of users from a group.
block_friends	Block one or more users by ID or username.
create_group	Create a new group with the current user as the owner.
delete_friends	Delete one or more users by ID or username.
delete_group	Delete a group by ID.
delete_leaderboard_record	Delete a leaderboard record.
delete_notifications	Delete one or more notifications for the current user.
delete_storage_objects	Delete one or more objects by ID or username.
demote_group_users	Demote a set of users in a group to the next role down.
event	Submit an event for processing in the server’s registered runtime custom events handler.
get_account	Fetch the current user’s account.
get_users	Fetch zero or more users by ID and/or username.
healthcheck	A healthcheck which load balancers can use to check the service.
import_facebook_friends	Import Facebook friends and add them to a user’s account.
import_steam_friends	Import Steam friends and add them to a user’s account.
join_group	Immediately join an open group, or request to join a closed one.
join_tournament	Attempt to join an open and running tournament.
kick_group_users	Kick a set of users from a group.
leave_group	Leave a group the user is a member of.
link_apple	Add an Apple ID to the social profiles on the current user’s account.
link_custom	Add a custom ID to the social profiles on the current user’s account.
link_device	Add a device ID to the social profiles on the current user’s account.
link_email	Add an email+password to the social profiles on the current user’s account.
link_facebook	Add Facebook to the social profiles on the current user’s account.
link_facebook_instant_game	Add Facebook Instant Game to the social profiles on the current user’s account.
link_game_center	Add Apple’s GameCenter to the social profiles on the current user’s account.
link_google	Add Google to the social profiles on the current user’s account.
link_steam	Add Steam to the social profiles on the current user’s account.
list_channel_messages	List a channel’s message history.
list_friends	List all friends for the current user.
list_group_users	List all users that are part of a group.
list_groups	List groups based on given filters.
list_leaderboard_records	List leaderboard records.
list_leaderboard_records_around_owner	List leaderboard records that belong to a user.
list_matches	Fetch list of running matches.
list_notifications	Fetch list of notifications.
list_storage_objects	List publicly readable storage objects in a given collection.
list_storage_objects_2	List publicly readable storage objects in a given collection.
list_tournament_records	List tournament records.
list_tournament_records_around_owner	List tournament records for a given owner.
list_tournaments	List current or upcoming tournaments.
list_user_groups	List groups the current user belongs to.
promote_group_users	Promote a set of users in a group to the next role up.
read_storage_objects	Get storage objects.
rpc_func	Execute a Lua function on the server.
rpc_func_2	Execute a Lua function on the server.
session_logout	Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
session_refresh	Refresh a user’s session using a refresh token retrieved from a previous authentication request.
unlink_apple	Remove the Apple ID from the social profiles on the current user’s account.
unlink_custom	Remove the custom ID from the social profiles on the current user’s account.
unlink_device	Remove the device ID from the social profiles on the current user’s account.
unlink_email	Remove the email+password from the social profiles on the current user’s account.
unlink_facebook	Remove Facebook from the social profiles on the current user’s account.
unlink_facebook_instant_game	Remove Facebook Instant Game profile from the social profiles on the current user’s account.
unlink_game_center	Remove Apple’s GameCenter from the social profiles on the current user’s account.
unlink_google	Remove Google from the social profiles on the current user’s account.
unlink_steam	Remove Steam from the social profiles on the current user’s account.
update_account	Update fields in the current user’s account.
update_group	Update fields in a given group.
write_leaderboard_record	Write a record to a leaderboard.
write_storage_objects	Write objects into the storage engine.
write_tournament_record	Write a record to a tournament.