Nakama.Client Class Reference

More...

Inheritance diagram for Nakama.Client:

Public Member Functions
	Client (string serverKey)
	Client (string serverKey, IHttpAdapter adapter)
	Client (string scheme, string host, int port, string serverKey)
	Client (string scheme, string host, int port, string serverKey, IHttpAdapter adapter, bool autoRefreshSession=true)
	Client (Uri uri, string serverKey)
	Client (Uri uri, string serverKey, IHttpAdapter adapter, bool autoRefreshSession=true)
async Task	AddFriendsAsync (ISession session, IEnumerable< string > ids, IEnumerable< string > usernames=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Add one or more friends by id or username. Parameters session The session of the user. ids The ids of the users to add or invite as friends. usernames The usernames of the users to add as friends. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	AddGroupUsersAsync (ISession session, string groupId, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Add one or more users to the group. Parameters session The session of the user. groupId The id of the group to add users into. ids The ids of the users to add or invite to the group. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task< ISession >	AuthenticateAppleAsync (string token, string username=null, bool create=true, Dictionary< string, string > vars=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Authenticate a user with an Apple ID against the server. Parameters username A username used to create the user. token The ID token received from Apple to validate. vars Extra information that will be bundled in the session token. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a session object.
async Task< ISession >	AuthenticateCustomAsync (string id, string username=null, bool create=true, Dictionary< string, string > vars=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Authenticate a user with a custom id. Parameters id A custom identifier usually obtained from an external authentication service. username A username used to create the user. May be null. create If the user should be created when authenticated. vars Extra information that will be bundled in the session token. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a session object.
async Task< ISession >	AuthenticateDeviceAsync (string id, string username=null, bool create=true, Dictionary< string, string > vars=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Authenticate a user with a device id. Parameters id A device identifier usually obtained from a platform API. username A username used to create the user. May be null. create If the user should be created when authenticated. vars Extra information that will be bundled in the session token. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a session object.
async Task< ISession >	AuthenticateEmailAsync (string email, string password, string username=null, bool create=true, Dictionary< string, string > vars=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Authenticate a user with an email and password. Parameters email The email address of the user. password The password for the user. username A username used to create the user. May be null. create If the user should be created when authenticated. vars Extra information that will be bundled in the session token. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a session object.
async Task< ISession >	AuthenticateFacebookAsync (string token, string username=null, bool create=true, bool import=true, Dictionary< string, string > vars=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Authenticate a user with a Facebook auth token. Parameters token An OAuth access token from the Facebook SDK. username A username used to create the user. May be null. create If the user should be created when authenticated. import If the Facebook friends should be imported. vars Extra information that will be bundled in the session token. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a session object.
async Task< ISession >	AuthenticateGameCenterAsync (string bundleId, string playerId, string publicKeyUrl, string salt, string signature, string timestamp, string username=null, bool create=true, Dictionary< string, string > vars=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Authenticate a user with Apple Game Center. Parameters bundleId The bundle id of the Game Center application. playerId The player id of the user in Game Center. publicKeyUrl The URL for the public encryption key. salt A random NSString used to compute the hash and keep it randomized. signature The verification signature data generated. timestamp The date and time that the signature was created. username A username used to create the user. May be null. create If the user should be created when authenticated. vars Extra information that will be bundled in the session token. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a session object.
async Task< ISession >	AuthenticateGoogleAsync (string token, string username=null, bool create=true, Dictionary< string, string > vars=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Authenticate a user with a Google auth token. Parameters token An OAuth access token from the Google SDK. username A username used to create the user. May be null. create If the user should be created when authenticated. vars Extra information that will be bundled in the session token. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a session object.
async Task< ISession >	AuthenticateSteamAsync (string token, string username=null, bool create=true, bool import=true, Dictionary< string, string > vars=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Authenticate a user with a Steam auth token. Parameters token An authentication token from the Steam network. username A username used to create the user. May be null. create If the user should be created when authenticated. vars Extra information that will be bundled in the session token. import If the Steam friends should be imported. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a session object.
async Task	BanGroupUsersAsync (ISession session, string groupId, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Ban a set of users from a group. Parameters session The session of the user. groupId The group to ban the users from. ids The ids of the users to ban. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	BlockFriendsAsync (ISession session, IEnumerable< string > ids, IEnumerable< string > usernames=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Block one or more friends by id or username. Parameters session The session of the user. ids The ids of the users to block. usernames The usernames of the users to block. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task< IApiGroup >	CreateGroupAsync (ISession session, string name, string description="", string avatarUrl=null, string langTag=null, bool open=true, int maxCount=100, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Create a group. Parameters session The session of the user. name The name for the group. description A description for the group. avatarUrl An avatar url for the group. langTag A language tag in BCP-47 format for the group. open If the group should have open membership. maxCount The maximum number of members allowed. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a new group object.
async Task	DeleteAccountAsync (ISession session, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete the current user's account. Note that this will invalidate your session, requiring you to reauthenticate. Parameters session The session of the user. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	DeleteFriendsAsync (ISession session, IEnumerable< string > ids, IEnumerable< string > usernames=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete one more or users by id or username from friends. Parameters session The session of the user. ids The user ids to remove as friends. usernames The usernames to remove as friends. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	DeleteGroupAsync (ISession session, string groupId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete a group by id. Parameters session The session of the user. groupId The group id to to remove. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	DeleteLeaderboardRecordAsync (ISession session, string leaderboardId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete a leaderboard record. Parameters session The session of the user. leaderboardId The id of the leaderboard with the record to be deleted. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	DeleteNotificationsAsync (ISession session, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete one or more notifications by id. Parameters session The session of the user. ids The notification ids to remove. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	DeleteStorageObjectsAsync (ISession session, StorageObjectId[] ids=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete one or more storage objects. Parameters session The session of the user. ids The ids of the objects to delete. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	DeleteTournamentRecordAsync (ISession session, string tournamentId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete the user's tournament record. Parameters session The session of the user. ids The id of the tournament to delete from. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	DemoteGroupUsersAsync (ISession session, string groupId, IEnumerable< string > usernames, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Demote a set of users in a group to the next role down. Parameters groupId The group to demote users in. userIds The users to demote. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Members who are already at the lowest rank will be skipped.
async Task	EventAsync (ISession session, string name, Dictionary< string, string > properties, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Submit an event for processing in the server's registered runtime custom events handler. Parameters session The session of the user. name The name of the event. properties The properties of the event. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task< IApiAccount >	GetAccountAsync (ISession session, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Fetch the user account owned by the session. Parameters session The session of the user. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the account object.
async Task< IApiValidatedSubscription >	GetSubscriptionAsync (ISession session, string productId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Get the subscription represented by the provided product id. Parameters session The session of the user. productId The product id. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the subscription.
async Task< IApiUsers >	GetUsersAsync (ISession session, IEnumerable< string > ids, IEnumerable< string > usernames=null, IEnumerable< string > facebookIds=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Fetch one or more users by id, usernames, and Facebook ids. Parameters session The session of the user. ids The IDs of the users to retrieve. usernames The usernames of the users to retrieve. facebookIds The facebook IDs of the users to retrieve. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a collection of user objects.
async Task	ImportFacebookFriendsAsync (ISession session, string token, bool? reset=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Import Facebook friends and add them to the user's account.The server will import friends when the user authenticates with Facebook. This function can be used to be explicit with the import operation.
async Task	ImportSteamFriendsAsync (ISession session, string token, bool? reset=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Import Steam friends and add them to the user's account.The server will import friends when the user authenticates with Steam. This function can be used to be explicit with the import operation.
async Task	JoinGroupAsync (ISession session, string groupId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Join a group if it has open membership or request to join it. Parameters session The session of the user. groupId The ID of the group to join. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	JoinTournamentAsync (ISession session, string tournamentId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Join a tournament by ID. Parameters session The session of the user. tournamentId The ID of the tournament to join. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	KickGroupUsersAsync (ISession session, string groupId, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Kick one or more users from the group. Parameters session The session of the user. groupId The ID of the group. ids The IDs of the users to kick. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	LeaveGroupAsync (ISession session, string groupId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Leave a group by ID. Parameters session The session of the user. groupId The ID of the group to leave. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	LinkAppleAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link an Apple ID to the social profiles on the current user's account. Parameters session The session of the user. token The ID token received from Apple to validate. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	LinkCustomAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a custom ID to the user account owned by the session. Parameters session The session of the user. id A custom identifier usually obtained from an external authentication service. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	LinkDeviceAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a device ID to the user account owned by the session. Parameters session The session of the user. id A device identifier usually obtained from a platform API. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	LinkEmailAsync (ISession session, string email, string password, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link an email with password to the user account owned by the session. Parameters session The session of the user. email The email address of the user. password The password for the user. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	LinkFacebookAsync (ISession session, string token, bool? import=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a Facebook profile to a user account. Parameters session The session of the user. token An OAuth access token from the Facebook SDK. import If the Facebook friends should be imported. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	LinkGameCenterAsync (ISession session, string bundleId, string playerId, string publicKeyUrl, string salt, string signature, string timestamp, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a Game Center profile to a user account. Parameters session The session of the user. bundleId The bundle ID of the Game Center application. playerId The player ID of the user in Game Center. publicKeyUrl The URL for the public encryption key. salt A random NSString used to compute the hash and keep it randomized. signature The verification signature data generated. timestamp The date and time that the signature was created. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	LinkGoogleAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a Google profile to a user account. Parameters session The session of the user. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. token An OAuth access token from the Google SDK. Returns A task which represents the asynchronous operation.
async Task	LinkSteamAsync (ISession session, string token, bool sync, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a Steam profile to a user account. Parameters session The session of the user. token An authentication token from the Steam network. import If the Steam friends should be imported. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
Task< IApiChannelMessageList >	ListChannelMessagesAsync (ISession session, IChannel channel, int limit=1, bool forward=true, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List messages from a chat channel. Parameters session The session of the user. channel The chat channel object. limit The number of chat messages to list. forward Fetch messages forward from the current cursor (or the start, RetryConfiguration retryConfiguration = null, CancellationToken canceller = default). cursor A cursor for the current position in the messages history to list. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the channel message list object.
async Task< IApiChannelMessageList >	ListChannelMessagesAsync (ISession session, string channelId, int limit=1, bool forward=true, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List messages from a chat channel. Parameters session The session of the user. channelId A channel identifier. limit The number of chat messages to list. forward Fetch messages forward from the current cursor (or the start, RetryConfiguration retryConfiguration = null, CancellationToken canceller = default). cursor A cursor for the current position in the messages history to list. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the channel message list object.
async Task< IApiFriendList >	ListFriendsAsync (ISession session, int? state, int limit, string cursor, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List of friends of the current user. Parameters session The session of the user. state Filter by friendship state. limit The number of friends to list. cursor A cursor for the current position in the friends list. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the friend objects.
async Task< IApiGroupUserList >	ListGroupUsersAsync (ISession session, string groupId, int? state, int limit, string cursor, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
async Task< IApiGroupList >	ListGroupsAsync (ISession session, string name=null, int limit=1, string cursor=null, string langTag=null, int? members=null, bool? open=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List groups on the server. Parameters session The session of the user. name The name filter to apply to the group list. limit The number of groups to list. cursor A cursor for the current position in the groups to list. langTag The language tag filter to apply to the group list. members The number of group members filter to apply to the group list. open The open/closed filter to apply to the group list. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task to resolve group objects.
async Task< IApiLeaderboardRecordList >	ListLeaderboardRecordsAsync (ISession session, string leaderboardId, IEnumerable< string > ownerIds=null, long? expiry=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
async Task< IApiLeaderboardRecordList >	ListLeaderboardRecordsAroundOwnerAsync (ISession session, string leaderboardId, string ownerId, long? expiry=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
async Task< IApiMatchList >	ListMatchesAsync (ISession session, int min, int max, int limit, bool authoritative, string label, string query, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Fetch a list of matches active on the server. Parameters session The session of the user. min The minimum number of match participants. max The maximum number of match participants. limit The number of matches to list. authoritative If authoritative matches should be included. label The label to filter the match list on. query A query for the matches to filter. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the match list object.
async Task< IApiNotificationList >	ListNotificationsAsync (ISession session, int limit=1, string cacheableCursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
Task< IApiStorageObjectList >	ListStorageObjects (ISession session, string collection, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
async Task< IApiStorageObjectList >	ListStorageObjectsAsync (ISession session, string collection, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List storage objects in a collection which have public read access. Parameters session The session of the user. collection The collection to list over. limit The number of objects to list. Maximum 100. cursor A cursor to paginate over the collection. May be null. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the storage object list.
async Task< IApiSubscriptionList >	ListSubscriptionsAsync (ISession session, int limit, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List the user's subscriptions. Parameters session The session of the user. limit The number of subscriptions to list. cursor An optional cursor for the next page of subscriptions. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the subscription list.
async Task< IApiTournamentRecordList >	ListTournamentRecordsAroundOwnerAsync (ISession session, string tournamentId, string ownerId, long? expiry=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
async Task< IApiTournamentRecordList >	ListTournamentRecordsAsync (ISession session, string tournamentId, IEnumerable< string > ownerIds=null, long? expiry=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
async Task< IApiTournamentList >	ListTournamentsAsync (ISession session, int categoryStart, int categoryEnd, int? startTime=null, int? endTime=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List current or upcoming tournaments. Parameters session The session of the user. categoryStart The start of the category of tournaments to include. categoryEnd The end of the category of tournaments to include. startTime The start time of the tournaments. (UNIX timestamp, RetryConfiguration retryConfiguration = null, CancellationToken canceller = default). If null, tournaments will not be filtered by start time. endTime The end time of the tournaments. (UNIX timestamp, RetryConfiguration retryConfiguration = null, CancellationToken canceller = default). If null, tournaments will not be filtered by end time. limit The number of tournaments to list. cursor An optional cursor for the next page of tournaments. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the list of tournament objects.
Task< IApiUserGroupList >	ListUserGroupsAsync (ISession session, int? state, int limit, string cursor, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List of groups the current user is a member of. Parameters session The session of the user. state Filter by group membership state. limit The number of records to list. cursor A cursor for the current position in the listing. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the group list object.
async Task< IApiUserGroupList >	ListUserGroupsAsync (ISession session, string userId, int? state, int limit, string cursor, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List groups a user is a member of. Parameters session The session of the user. userId The ID of the user whose groups to list. state Filter by group membership state. limit The number of records to list. cursor A cursor for the current position in the listing. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the group list object.
async Task< IApiStorageObjectList >	ListUsersStorageObjectsAsync (ISession session, string collection, string userId, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List storage objects in a collection which belong to a specific user and have public read access. Parameters session The session of the user. collection The collection to list over. userId The user ID of the user to list objects for. limit The number of objects to list. cursor A cursor to paginate over the collection. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the storage object list.
async Task	PromoteGroupUsersAsync (ISession session, string groupId, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Promote one or more users in the group. Parameters session The session of the user. groupId The ID of the group to promote users into. ids The IDs of the users to promote. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task< IApiStorageObjects >	ReadStorageObjectsAsync (ISession session, IApiReadStorageObjectId[] ids=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Read one or more objects from the storage engine. Parameters session The session of the user. ids The objects to read. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the storage batch object.
async Task< IApiRpc >	RpcAsync (ISession session, string id, string payload, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Execute a function with an input payload on the server. Parameters session The session of the user. id The ID of the function to execute on the server. payload The payload to send with the function call. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the RPC response.
async Task< IApiRpc >	RpcAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Execute a function on the server. Parameters session The session of the user. id The ID of the function to execute on the server. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the RPC response.
Task< IApiRpc >	RpcAsync (string httpkey, string id, string payload, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Execute a function on the server without a session.This function is usually used with server side code. DO NOT USE client side.
Task< IApiRpc >	RpcAsync (string httpkey, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Execute a function on the server without a session.This function is usually used with server side code. DO NOT USE client side.
Task	SessionLogoutAsync (ISession session, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Log out a session which invalidates the authorization and refresh token. Parameters session The session to logout. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
Task	SessionLogoutAsync (string authToken, string refreshToken, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Log out a session which optionally invalidates the authorization and/or refresh tokens. Parameters authToken The authorization token to invalidate, may be null. refreshToken The refresh token to invalidate, may be null. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task< ISession >	SessionRefreshAsync (ISession session, Dictionary< string, string > vars=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Refresh the session unless the current refresh token has expired. If vars are specified they will replace what is currently stored inside the session token. Parameters session The session of the user. vars Extra information which should be bundled inside the session token. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a new session object.
override string	ToString ()
async Task	UnlinkAppleAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Remove the Apple ID from the social profiles on the current user's account. Parameters session The session of the user. token The ID token received from Apple. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to a new session object.
async Task	UnlinkCustomAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a custom ID from the user account owned by the session. Parameters session The session of the user. id A custom identifier usually obtained from an external authentication service. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	UnlinkDeviceAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a device ID from the user account owned by the session. Parameters session The session of the user. id A device identifier usually obtained from a platform API. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	UnlinkEmailAsync (ISession session, string email, string password, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink an email with password from the user account owned by the session. Parameters session The session of the user. email The email address of the user. password The password for the user. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	UnlinkFacebookAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a Facebook profile from the user account owned by the session. Parameters session The session of the user. token An OAuth access token from the Facebook SDK. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	UnlinkGameCenterAsync (ISession session, string bundleId, string playerId, string publicKeyUrl, string salt, string signature, string timestamp, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a Game Center profile from the user account owned by the session. Parameters session The session of the user. bundleId The bundle ID of the Game Center application. playerId The player ID of the user in Game Center. publicKeyUrl The URL for the public encryption key. salt A random NSString used to compute the hash and keep it randomized. signature The verification signature data generated. timestamp The date and time that the signature was created. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	UnlinkGoogleAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a Google profile from the user account owned by the session. Parameters session The session of the user. token An OAuth access token from the Google SDK. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	UnlinkSteamAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a Steam profile from the user account owned by the session. Parameters session The session of the user. token An authentication token from the Steam network. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which represents the asynchronous operation.
async Task	UpdateAccountAsync (ISession session, string username, string displayName=null, string avatarUrl=null, string langTag=null, string location=null, string timezone=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
async Task	UpdateGroupAsync (ISession session, string groupId, string name, bool open, string description=null, string avatarUrl=null, string langTag=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Update a group.The user must have the correct access permissions for the group.
async Task< IApiValidatePurchaseResponse >	ValidatePurchaseAppleAsync (ISession session, string receipt, bool persist=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Validate a purchase receipt against the Apple App Store. Parameters session The session of the user. receipt The purchase receipt to be validated. persist Whether or not to track the receipt in the Nakama database. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the validated list of purchase receipts.
async Task< IApiValidatePurchaseResponse >	ValidatePurchaseFacebookInstantAsync (ISession session, string signedRequest, bool persist=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Validate a purchase receipt against Facebook Instant Games. Parameters session The session of the user. signedRequest Base64 encoded Facebook Instant receipt data payload. persist Whether or not to track the receipt in the Nakama database. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the validated list of purchase receipts.
async Task< IApiValidatePurchaseResponse >	ValidatePurchaseGoogleAsync (ISession session, string receipt, bool persist=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Validate a purchase receipt against the Google Play Store. Parameters session The session of the user. receipt The purchase receipt to be validated. persist Whether or not to track the receipt in the Nakama database. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the validated list of purchase receipts.
async Task< IApiValidatePurchaseResponse >	ValidatePurchaseHuaweiAsync (ISession session, string receipt, string signature, bool persist=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Validate a purchase receipt against the Huawei AppGallery. Parameters session The session of the user. receipt The purchase receipt to be validated. signature The signature of the purchase receipt. persist Whether or not to track the receipt in the Nakama database. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the validated list of purchase receipts.
async Task< IApiValidateSubscriptionResponse >	ValidateSubscriptionAppleAsync (ISession session, string receipt, bool persist=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Validate an Apple subscription receipt.
async Task< IApiValidateSubscriptionResponse >	ValidateSubscriptionGoogleAsync (ISession session, string receipt, bool persist=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Validate a Google subscription receipt.
async Task< IApiLeaderboardRecord >	WriteLeaderboardRecordAsync (ISession session, string leaderboardId, long score, long subScore=0, string metadata=null, ApiOperator apiOperator=ApiOperator.NO_OVERRIDE, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Write a record to a leaderboard. Parameters session The session for the user. leaderboardId The ID of the leaderboard to write. score The score for the leaderboard record. subScore The sub score for the leaderboard record. metadata The metadata for the leaderboard record. operator The operator for the record that can be used to override the one set in the leaderboard. Parameters retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the leaderboard record object written.
async Task< IApiStorageObjectAcks >	WriteStorageObjectsAsync (ISession session, IApiWriteStorageObject[] objects=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Write objects to the storage engine. Parameters session The session of the user. objects The objects to write. retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the storage write acknowledgements.
async Task< IApiLeaderboardRecord >	WriteTournamentRecordAsync (ISession session, string tournamentId, long score, long subScore=0, string metadata=null, ApiOperator apiOperator=ApiOperator.NO_OVERRIDE, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Write a record to a tournament. Parameters session The session of the user. tournamentId The ID of the tournament to write. score The score of the tournament record. subScore The sub score for the tournament record. metadata The metadata for the tournament record. operator The operator for the record that can be used to override the one set in the tournament. Parameters retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the tournament record object written.

Static Public Attributes
const string	DefaultHost = "127.0.0.1"
	The default host address of the server.
const string	DefaultScheme = "http"
	The default protocol scheme for the socket connection.
const int	DefaultPort = 7350
	The default port number of the server.
static TimeSpan	DefaultExpiredTimeSpan = TimeSpan.FromMinutes(5)
	The default expired timespan used to check session lifetime.

Properties
bool	AutoRefreshSession [get]
	True if the session should be refreshed with an active refresh token.
RetryConfiguration	GlobalRetryConfiguration [get, set]
	The global retry configuration. See RetryConfiguration.
string	Host [get]
	The host address of the server. Defaults to "127.0.0.1".
ILogger	Logger [get, set]
	The logger to use with the client.
int	Port [get]
	The port number of the server. Defaults to 7350.
string	Scheme [get]
	The protocol scheme used to connect with the server. Must be either "http" or "https".
string	ServerKey [get]
	The key used to authenticate with the server without a session. Defaults to "defaultkey".
int	Timeout [get, set]
	Set the timeout in seconds on requests sent to the server.
Properties inherited from Nakama.IClient

Detailed Description

Constructor & Destructor Documentation

Client() [1/6]

Nakama.Client.Client ( string  serverKey )

inline

There is a bug in Unity's WebGL implementation that prevents the proper invocation of constructors with more than four parameters. For this reason, avoid defining constructors that do this.

Client() [2/6]

Nakama.Client.Client ( string  serverKey, IHttpAdapter  adapter  )

inline

Client() [3/6]

Nakama.Client.Client ( string  scheme, string  host, int  port, string  serverKey  )

inline

Client() [4/6]

Nakama.Client.Client ( string  scheme, string  host, int  port, string  serverKey, IHttpAdapter  adapter, bool  autoRefreshSession = true  )

inline

Client() [5/6]

Nakama.Client.Client ( Uri  uri, string  serverKey  )

inline

Client() [6/6]

Nakama.Client.Client ( Uri  uri, string  serverKey, IHttpAdapter  adapter, bool  autoRefreshSession = true  )

inline

Member Function Documentation

AddFriendsAsync()

async Task Nakama.Client.AddFriendsAsync ( ISession  session, IEnumerable< string >  ids, IEnumerable< string >  usernames = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Add one or more friends by id or username.

Parameters

session	The session of the user.
ids	The ids of the users to add or invite as friends.
usernames	The usernames of the users to add as friends.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

AddGroupUsersAsync()

async Task Nakama.Client.AddGroupUsersAsync ( ISession  session, string  groupId, IEnumerable< string >  ids, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Add one or more users to the group.

Parameters

session	The session of the user.
groupId	The id of the group to add users into.
ids	The ids of the users to add or invite to the group.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

AuthenticateAppleAsync()

async Task< ISession > Nakama.Client.AuthenticateAppleAsync ( string  token, string  username = null, bool  create = true, Dictionary< string, string >  vars = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Authenticate a user with an Apple ID against the server.

Parameters

username	A username used to create the user.
token	The ID token received from Apple to validate.
vars	Extra information that will be bundled in the session token.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a session object.

Implements Nakama.IClient.

AuthenticateCustomAsync()

async Task< ISession > Nakama.Client.AuthenticateCustomAsync ( string  id, string  username = null, bool  create = true, Dictionary< string, string >  vars = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Authenticate a user with a custom id.

Parameters

id	A custom identifier usually obtained from an external authentication service.
username	A username used to create the user. May be null.
create	If the user should be created when authenticated.
vars	Extra information that will be bundled in the session token.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a session object.

Implements Nakama.IClient.

AuthenticateDeviceAsync()

async Task< ISession > Nakama.Client.AuthenticateDeviceAsync ( string  id, string  username = null, bool  create = true, Dictionary< string, string >  vars = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Authenticate a user with a device id.

Parameters

id	A device identifier usually obtained from a platform API.
username	A username used to create the user. May be null.
create	If the user should be created when authenticated.
vars	Extra information that will be bundled in the session token.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a session object.

Implements Nakama.IClient.

AuthenticateEmailAsync()

async Task< ISession > Nakama.Client.AuthenticateEmailAsync ( string  email, string  password, string  username = null, bool  create = true, Dictionary< string, string >  vars = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Authenticate a user with an email and password.

Parameters

email	The email address of the user.
password	The password for the user.
username	A username used to create the user. May be null.
create	If the user should be created when authenticated.
vars	Extra information that will be bundled in the session token.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a session object.

Implements Nakama.IClient.

AuthenticateFacebookAsync()

async Task< ISession > Nakama.Client.AuthenticateFacebookAsync ( string  token, string  username = null, bool  create = true, bool  import = true, Dictionary< string, string >  vars = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Authenticate a user with a Facebook auth token.

Parameters

token	An OAuth access token from the Facebook SDK.
username	A username used to create the user. May be null.
create	If the user should be created when authenticated.
import	If the Facebook friends should be imported.
vars	Extra information that will be bundled in the session token.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a session object.

Implements Nakama.IClient.

AuthenticateGameCenterAsync()

async Task< ISession > Nakama.Client.AuthenticateGameCenterAsync ( string  bundleId, string  playerId, string  publicKeyUrl, string  salt, string  signature, string  timestamp, string  username = null, bool  create = true, Dictionary< string, string >  vars = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Authenticate a user with Apple Game Center.

Parameters

bundleId	The bundle id of the Game Center application.
playerId	The player id of the user in Game Center.
publicKeyUrl	The URL for the public encryption key.
salt	A random NSString used to compute the hash and keep it randomized.
signature	The verification signature data generated.
timestamp	The date and time that the signature was created.
username	A username used to create the user. May be null.
create	If the user should be created when authenticated.
vars	Extra information that will be bundled in the session token.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a session object.

Implements Nakama.IClient.

AuthenticateGoogleAsync()

async Task< ISession > Nakama.Client.AuthenticateGoogleAsync ( string  token, string  username = null, bool  create = true, Dictionary< string, string >  vars = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Authenticate a user with a Google auth token.

Parameters

token	An OAuth access token from the Google SDK.
username	A username used to create the user. May be null.
create	If the user should be created when authenticated.
vars	Extra information that will be bundled in the session token.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a session object.

Implements Nakama.IClient.

AuthenticateSteamAsync()

async Task< ISession > Nakama.Client.AuthenticateSteamAsync ( string  token, string  username = null, bool  create = true, bool  import = true, Dictionary< string, string >  vars = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Authenticate a user with a Steam auth token.

Parameters

token	An authentication token from the Steam network.
username	A username used to create the user. May be null.
create	If the user should be created when authenticated.
vars	Extra information that will be bundled in the session token.
import	If the Steam friends should be imported.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a session object.

Implements Nakama.IClient.

BanGroupUsersAsync()

async Task Nakama.Client.BanGroupUsersAsync ( ISession  session, string  groupId, IEnumerable< string >  ids, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Ban a set of users from a group.

Parameters

session	The session of the user.
groupId	The group to ban the users from.
ids	The ids of the users to ban.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

BlockFriendsAsync()

async Task Nakama.Client.BlockFriendsAsync ( ISession  session, IEnumerable< string >  ids, IEnumerable< string >  usernames = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Block one or more friends by id or username.

Parameters

session	The session of the user.
ids	The ids of the users to block.
usernames	The usernames of the users to block.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

CreateGroupAsync()

async Task< IApiGroup > Nakama.Client.CreateGroupAsync ( ISession  session, string  name, string  description = "", string  avatarUrl = null, string  langTag = null, bool  open = true, int  maxCount = 100, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Create a group.

Parameters

session	The session of the user.
name	The name for the group.
description	A description for the group.
avatarUrl	An avatar url for the group.
langTag	A language tag in BCP-47 format for the group.
open	If the group should have open membership.
maxCount	The maximum number of members allowed.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a new group object.

Implements Nakama.IClient.

DeleteAccountAsync()

async Task Nakama.Client.DeleteAccountAsync ( ISession  session, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Delete the current user's account. Note that this will invalidate your session, requiring you to reauthenticate.

Parameters

session	The session of the user.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

DeleteFriendsAsync()

async Task Nakama.Client.DeleteFriendsAsync ( ISession  session, IEnumerable< string >  ids, IEnumerable< string >  usernames = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Delete one more or users by id or username from friends.

Parameters

session	The session of the user.
ids	The user ids to remove as friends.
usernames	The usernames to remove as friends.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

DeleteGroupAsync()

async Task Nakama.Client.DeleteGroupAsync ( ISession  session, string  groupId, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Delete a group by id.

Parameters

session	The session of the user.
groupId	The group id to to remove.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

DeleteLeaderboardRecordAsync()

async Task Nakama.Client.DeleteLeaderboardRecordAsync ( ISession  session, string  leaderboardId, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Delete a leaderboard record.

Parameters

session	The session of the user.
leaderboardId	The id of the leaderboard with the record to be deleted.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

DeleteNotificationsAsync()

async Task Nakama.Client.DeleteNotificationsAsync ( ISession  session, IEnumerable< string >  ids, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Delete one or more notifications by id.

Parameters

session	The session of the user.
ids	The notification ids to remove.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

DeleteStorageObjectsAsync()

async Task Nakama.Client.DeleteStorageObjectsAsync ( ISession  session, StorageObjectId[]  ids = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Delete one or more storage objects.

Parameters

session	The session of the user.
ids	The ids of the objects to delete.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

DeleteTournamentRecordAsync()

async Task Nakama.Client.DeleteTournamentRecordAsync ( ISession  session, string  tournamentId, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Delete the user's tournament record.

Parameters

session	The session of the user.
ids	The id of the tournament to delete from.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

DemoteGroupUsersAsync()

async Task Nakama.Client.DemoteGroupUsersAsync ( ISession  session, string  groupId, IEnumerable< string >  usernames, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Demote a set of users in a group to the next role down.

Parameters

groupId	The group to demote users in.
userIds	The users to demote.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Members who are already at the lowest rank will be skipped.

Implements Nakama.IClient.

EventAsync()

async Task Nakama.Client.EventAsync ( ISession  session, string  name, Dictionary< string, string >  properties, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Submit an event for processing in the server's registered runtime custom events handler.

Parameters

session	The session of the user.
name	The name of the event.
properties	The properties of the event.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

GetAccountAsync()

async Task< IApiAccount > Nakama.Client.GetAccountAsync ( ISession  session, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Fetch the user account owned by the session.

Parameters

session	The session of the user.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the account object.

Implements Nakama.IClient.

GetSubscriptionAsync()

async Task< IApiValidatedSubscription > Nakama.Client.GetSubscriptionAsync ( ISession  session, string  productId, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Get the subscription represented by the provided product id.

Parameters

session	The session of the user.
productId	The product id.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the subscription.

Implements Nakama.IClient.

GetUsersAsync()

async Task< IApiUsers > Nakama.Client.GetUsersAsync ( ISession  session, IEnumerable< string >  ids, IEnumerable< string >  usernames = null, IEnumerable< string >  facebookIds = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Fetch one or more users by id, usernames, and Facebook ids.

Parameters

session	The session of the user.
ids	The IDs of the users to retrieve.
usernames	The usernames of the users to retrieve.
facebookIds	The facebook IDs of the users to retrieve.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a collection of user objects.

Implements Nakama.IClient.

ImportFacebookFriendsAsync()

async Task Nakama.Client.ImportFacebookFriendsAsync ( ISession  session, string  token, bool?  reset = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Import Facebook friends and add them to the user's account.The server will import friends when the user authenticates with Facebook. This function can be used to be explicit with the import operation.

Implements Nakama.IClient.

ImportSteamFriendsAsync()

async Task Nakama.Client.ImportSteamFriendsAsync ( ISession  session, string  token, bool?  reset = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Import Steam friends and add them to the user's account.The server will import friends when the user authenticates with Steam. This function can be used to be explicit with the import operation.

Implements Nakama.IClient.

JoinGroupAsync()

async Task Nakama.Client.JoinGroupAsync ( ISession  session, string  groupId, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Join a group if it has open membership or request to join it.

Parameters

session	The session of the user.
groupId	The ID of the group to join.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

JoinTournamentAsync()

async Task Nakama.Client.JoinTournamentAsync ( ISession  session, string  tournamentId, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Join a tournament by ID.

Parameters

session	The session of the user.
tournamentId	The ID of the tournament to join.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

KickGroupUsersAsync()

async Task Nakama.Client.KickGroupUsersAsync ( ISession  session, string  groupId, IEnumerable< string >  ids, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Kick one or more users from the group.

Parameters

session	The session of the user.
groupId	The ID of the group.
ids	The IDs of the users to kick.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

LeaveGroupAsync()

async Task Nakama.Client.LeaveGroupAsync ( ISession  session, string  groupId, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Leave a group by ID.

Parameters

session	The session of the user.
groupId	The ID of the group to leave.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

LinkAppleAsync()

async Task Nakama.Client.LinkAppleAsync ( ISession  session, string  token, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Link an Apple ID to the social profiles on the current user's account.

Parameters

session	The session of the user.
token	The ID token received from Apple to validate.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

LinkCustomAsync()

async Task Nakama.Client.LinkCustomAsync ( ISession  session, string  id, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Link a custom ID to the user account owned by the session.

Parameters

session	The session of the user.
id	A custom identifier usually obtained from an external authentication service.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

LinkDeviceAsync()

async Task Nakama.Client.LinkDeviceAsync ( ISession  session, string  id, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Link a device ID to the user account owned by the session.

Parameters

session	The session of the user.
id	A device identifier usually obtained from a platform API.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

LinkEmailAsync()

async Task Nakama.Client.LinkEmailAsync ( ISession  session, string  email, string  password, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Link an email with password to the user account owned by the session.

Parameters

session	The session of the user.
email	The email address of the user.
password	The password for the user.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

LinkFacebookAsync()

async Task Nakama.Client.LinkFacebookAsync ( ISession  session, string  token, bool?  import = true, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Link a Facebook profile to a user account.

Parameters

session	The session of the user.
token	An OAuth access token from the Facebook SDK.
import	If the Facebook friends should be imported.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

LinkGameCenterAsync()

async Task Nakama.Client.LinkGameCenterAsync ( ISession  session, string  bundleId, string  playerId, string  publicKeyUrl, string  salt, string  signature, string  timestamp, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Link a Game Center profile to a user account.

Parameters

session	The session of the user.
bundleId	The bundle ID of the Game Center application.
playerId	The player ID of the user in Game Center.
publicKeyUrl	The URL for the public encryption key.
salt	A random NSString used to compute the hash and keep it randomized.
signature	The verification signature data generated.
timestamp	The date and time that the signature was created.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

LinkGoogleAsync()

async Task Nakama.Client.LinkGoogleAsync ( ISession  session, string  token, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Link a Google profile to a user account.

Parameters

session	The session of the user.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.
token	An OAuth access token from the Google SDK.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

LinkSteamAsync()

async Task Nakama.Client.LinkSteamAsync ( ISession  session, string  token, bool  sync, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Link a Steam profile to a user account.

Parameters

session	The session of the user.
token	An authentication token from the Steam network.
import	If the Steam friends should be imported.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

ListChannelMessagesAsync() [1/2]

Task< IApiChannelMessageList > Nakama.Client.ListChannelMessagesAsync	(	ISession	session,
		IChannel	channel,
		int	limit = 1,
		bool	forward = true,
		string	cursor = null,
		RetryConfiguration	retryConfiguration = null,
		CancellationToken	canceller = default
	)

List messages from a chat channel.

Parameters

session	The session of the user.
channel	The chat channel object.
limit	The number of chat messages to list.
forward	Fetch messages forward from the current cursor (or the start, RetryConfiguration retryConfiguration = null, CancellationToken canceller = default).
cursor	A cursor for the current position in the messages history to list.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the channel message list object.

Implements Nakama.IClient.

ListChannelMessagesAsync() [2/2]

async Task< IApiChannelMessageList > Nakama.Client.ListChannelMessagesAsync ( ISession  session, string  channelId, int  limit = 1, bool  forward = true, string  cursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List messages from a chat channel.

Parameters

session	The session of the user.
channelId	A channel identifier.
limit	The number of chat messages to list.
forward	Fetch messages forward from the current cursor (or the start, RetryConfiguration retryConfiguration = null, CancellationToken canceller = default).
cursor	A cursor for the current position in the messages history to list.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the channel message list object.

Implements Nakama.IClient.

ListFriendsAsync()

async Task< IApiFriendList > Nakama.Client.ListFriendsAsync ( ISession  session, int?  state, int  limit, string  cursor, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List of friends of the current user.

Parameters

session	The session of the user.
state	Filter by friendship state.
limit	The number of friends to list.
cursor	A cursor for the current position in the friends list.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the friend objects.

Implements Nakama.IClient.

ListGroupsAsync()

async Task< IApiGroupList > Nakama.Client.ListGroupsAsync ( ISession  session, string  name = null, int  limit = 1, string  cursor = null, string  langTag = null, int?  members = null, bool?  open = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List groups on the server.

Parameters

session	The session of the user.
name	The name filter to apply to the group list.
limit	The number of groups to list.
cursor	A cursor for the current position in the groups to list.
langTag	The language tag filter to apply to the group list.
members	The number of group members filter to apply to the group list.
open	The open/closed filter to apply to the group list.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task to resolve group objects.

Implements Nakama.IClient.

ListGroupUsersAsync()

async Task< IApiGroupUserList > Nakama.Client.ListGroupUsersAsync ( ISession  session, string  groupId, int?  state, int  limit, string  cursor, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List all users part of the group.

Parameters

session	The session of the user.
groupId	The ID of the group.
state	Filter by group membership state.
limit	The number of groups to list.
cursor	A cursor for the current position in the group listing.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the group user objects.

The returned IApiGroupUserList is automatically updated to reflect username changes for the current user.

Implements Nakama.IClient.

ListLeaderboardRecordsAroundOwnerAsync()

async Task< IApiLeaderboardRecordList > Nakama.Client.ListLeaderboardRecordsAroundOwnerAsync ( ISession  session, string  leaderboardId, string  ownerId, long?  expiry = null, int  limit = 1, string  cursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List leaderboard records that belong to a user.

Parameters

session	The session for the user.
leaderboardId	The ID of the leaderboard to list.
ownerId	The ID of the user to list around.
expiry	Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
limit	The limit of the listings.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the leaderboard record objects.

The returned IApiLeaderboardRecordList is automatically updated to reflect username changes for the current user.

Implements Nakama.IClient.

ListLeaderboardRecordsAsync()

async Task< IApiLeaderboardRecordList > Nakama.Client.ListLeaderboardRecordsAsync ( ISession  session, string  leaderboardId, IEnumerable< string >  ownerIds = null, long?  expiry = null, int  limit = 1, string  cursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List records from a leaderboard.

Parameters

session	The session of the user.
leaderboardId	The ID of the leaderboard to list.
ownerIds	Record owners to fetch with the list of records.
expiry	Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
limit	The number of records to list.
cursor	A cursor for the current position in the leaderboard records to list.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the leaderboard record objects.

The returned IApiLeaderboardRecordList is automatically updated to reflect username changes for the current user.

Implements Nakama.IClient.

ListMatchesAsync()

async Task< IApiMatchList > Nakama.Client.ListMatchesAsync ( ISession  session, int  min, int  max, int  limit, bool  authoritative, string  label, string  query, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Fetch a list of matches active on the server.

Parameters

session	The session of the user.
min	The minimum number of match participants.
max	The maximum number of match participants.
limit	The number of matches to list.
authoritative	If authoritative matches should be included.
label	The label to filter the match list on.
query	A query for the matches to filter.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the match list object.

Implements Nakama.IClient.

ListNotificationsAsync()

async Task< IApiNotificationList > Nakama.Client.ListNotificationsAsync ( ISession  session, int  limit = 1, string  cacheableCursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List notifications for the user with an optional cursor.

Parameters

session	The session of the user.
limit	The number of notifications to list.
cacheableCursor	A cursor for the current position in notifications to list.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task to resolve notifications objects.

The returned IApiNotificationList is automatically updated to reflect username changes for the current user.

Implements Nakama.IClient.

ListStorageObjects()

Task< IApiStorageObjectList > Nakama.Client.ListStorageObjects	(	ISession	session,
		string	collection,
		int	limit = 1,
		string	cursor = null,
		RetryConfiguration	retryConfiguration = null,
		CancellationToken	canceller = default
	)

Implements Nakama.IClient.

ListStorageObjectsAsync()

async Task< IApiStorageObjectList > Nakama.Client.ListStorageObjectsAsync ( ISession  session, string  collection, int  limit = 1, string  cursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List storage objects in a collection which have public read access.

Parameters

session	The session of the user.
collection	The collection to list over.
limit	The number of objects to list. Maximum 100.
cursor	A cursor to paginate over the collection. May be null.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the storage object list.

Implements Nakama.IClient.

ListSubscriptionsAsync()

async Task< IApiSubscriptionList > Nakama.Client.ListSubscriptionsAsync ( ISession  session, int  limit, string  cursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List the user's subscriptions.

Parameters

session	The session of the user.
limit	The number of subscriptions to list.
cursor	An optional cursor for the next page of subscriptions.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the subscription list.

Implements Nakama.IClient.

ListTournamentRecordsAroundOwnerAsync()

async Task< IApiTournamentRecordList > Nakama.Client.ListTournamentRecordsAroundOwnerAsync ( ISession  session, string  tournamentId, string  ownerId, long?  expiry = null, int  limit = 1, string  cursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List tournament records around the owner.

Parameters

session	The session of the user.
tournamentId	The ID of the tournament.
ownerId	The ID of the owner to pivot around.
expiry	Expiry in seconds (since epoch) to begin fetching records from.
limit	The number of records to list.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the tournament record list object.

The returned IApiTournamentRecordList is automatically updated to reflect username changes for the current user.

Implements Nakama.IClient.

ListTournamentRecordsAsync()

async Task< IApiTournamentRecordList > Nakama.Client.ListTournamentRecordsAsync ( ISession  session, string  tournamentId, IEnumerable< string >  ownerIds = null, long?  expiry = null, int  limit = 1, string  cursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List records from a tournament.

Parameters

session	The session of the user.
tournamentId	The ID of the tournament.
ownerIds	The IDs of the record owners to return in the result.
expiry	Expiry in seconds (since epoch) to begin fetching records from.
limit	The number of records to list.
cursor	An optional cursor for the next page of tournament records.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the list of tournament records.

The returned IApiTournamentRecordList is automatically updated to reflect username changes for the current user.

Implements Nakama.IClient.

ListTournamentsAsync()

async Task< IApiTournamentList > Nakama.Client.ListTournamentsAsync ( ISession  session, int  categoryStart, int  categoryEnd, int?  startTime = null, int?  endTime = null, int  limit = 1, string  cursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List current or upcoming tournaments.

Parameters

session	The session of the user.
categoryStart	The start of the category of tournaments to include.
categoryEnd	The end of the category of tournaments to include.
startTime	The start time of the tournaments. (UNIX timestamp, RetryConfiguration retryConfiguration = null, CancellationToken canceller = default). If null, tournaments will not be filtered by start time.
endTime	The end time of the tournaments. (UNIX timestamp, RetryConfiguration retryConfiguration = null, CancellationToken canceller = default). If null, tournaments will not be filtered by end time.
limit	The number of tournaments to list.
cursor	An optional cursor for the next page of tournaments.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the list of tournament objects.

Implements Nakama.IClient.

ListUserGroupsAsync() [1/2]

Task< IApiUserGroupList > Nakama.Client.ListUserGroupsAsync	(	ISession	session,
		int?	state,
		int	limit,
		string	cursor,
		RetryConfiguration	retryConfiguration = null,
		CancellationToken	canceller = default
	)

List of groups the current user is a member of.

Parameters

session	The session of the user.
state	Filter by group membership state.
limit	The number of records to list.
cursor	A cursor for the current position in the listing.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the group list object.

Implements Nakama.IClient.

ListUserGroupsAsync() [2/2]

async Task< IApiUserGroupList > Nakama.Client.ListUserGroupsAsync ( ISession  session, string  userId, int?  state, int  limit, string  cursor, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List groups a user is a member of.

Parameters

session	The session of the user.
userId	The ID of the user whose groups to list.
state	Filter by group membership state.
limit	The number of records to list.
cursor	A cursor for the current position in the listing.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the group list object.

Implements Nakama.IClient.

ListUsersStorageObjectsAsync()

async Task< IApiStorageObjectList > Nakama.Client.ListUsersStorageObjectsAsync ( ISession  session, string  collection, string  userId, int  limit = 1, string  cursor = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

List storage objects in a collection which belong to a specific user and have public read access.

Parameters

session	The session of the user.
collection	The collection to list over.
userId	The user ID of the user to list objects for.
limit	The number of objects to list.
cursor	A cursor to paginate over the collection.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the storage object list.

Implements Nakama.IClient.

PromoteGroupUsersAsync()

async Task Nakama.Client.PromoteGroupUsersAsync ( ISession  session, string  groupId, IEnumerable< string >  ids, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Promote one or more users in the group.

Parameters

session	The session of the user.
groupId	The ID of the group to promote users into.
ids	The IDs of the users to promote.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

ReadStorageObjectsAsync()

async Task< IApiStorageObjects > Nakama.Client.ReadStorageObjectsAsync ( ISession  session, IApiReadStorageObjectId[]  ids = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Read one or more objects from the storage engine.

Parameters

session	The session of the user.
ids	The objects to read.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the storage batch object.

Implements Nakama.IClient.

RpcAsync() [1/4]

async Task< IApiRpc > Nakama.Client.RpcAsync ( ISession  session, string  id, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Execute a function on the server.

Parameters

session	The session of the user.
id	The ID of the function to execute on the server.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the RPC response.

Implements Nakama.IClient.

RpcAsync() [2/4]

async Task< IApiRpc > Nakama.Client.RpcAsync ( ISession  session, string  id, string  payload, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Execute a function with an input payload on the server.

Parameters

session	The session of the user.
id	The ID of the function to execute on the server.
payload	The payload to send with the function call.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the RPC response.

Implements Nakama.IClient.

RpcAsync() [3/4]

Task< IApiRpc > Nakama.Client.RpcAsync	(	string	httpkey,
		string	id,
		RetryConfiguration	retryConfiguration = null,
		CancellationToken	canceller = default
	)

Execute a function on the server without a session.This function is usually used with server side code. DO NOT USE client side.

Implements Nakama.IClient.

RpcAsync() [4/4]

Task< IApiRpc > Nakama.Client.RpcAsync	(	string	httpkey,
		string	id,
		string	payload,
		RetryConfiguration	retryConfiguration = null,
		CancellationToken	canceller = default
	)

Execute a function on the server without a session.This function is usually used with server side code. DO NOT USE client side.

Implements Nakama.IClient.

SessionLogoutAsync() [1/2]

Task Nakama.Client.SessionLogoutAsync	(	ISession	session,
		RetryConfiguration	retryConfiguration = null,
		CancellationToken	canceller = default
	)

Log out a session which invalidates the authorization and refresh token.

Parameters

session	The session to logout.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

SessionLogoutAsync() [2/2]

Task Nakama.Client.SessionLogoutAsync	(	string	authToken,
		string	refreshToken,
		RetryConfiguration	retryConfiguration = null,
		CancellationToken	canceller = default
	)

Log out a session which optionally invalidates the authorization and/or refresh tokens.

Parameters

authToken	The authorization token to invalidate, may be null.
refreshToken	The refresh token to invalidate, may be null.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

SessionRefreshAsync()

async Task< ISession > Nakama.Client.SessionRefreshAsync ( ISession  session, Dictionary< string, string >  vars = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Refresh the session unless the current refresh token has expired. If vars are specified they will replace what is currently stored inside the session token.

Parameters

session	The session of the user.
vars	Extra information which should be bundled inside the session token.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a new session object.

Implements Nakama.IClient.

ToString()

override string Nakama.Client.ToString ( )

inline

UnlinkAppleAsync()

async Task Nakama.Client.UnlinkAppleAsync ( ISession  session, string  token, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Remove the Apple ID from the social profiles on the current user's account.

Parameters

session	The session of the user.
token	The ID token received from Apple.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to a new session object.

Implements Nakama.IClient.

UnlinkCustomAsync()

async Task Nakama.Client.UnlinkCustomAsync ( ISession  session, string  id, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Unlink a custom ID from the user account owned by the session.

Parameters

session	The session of the user.
id	A custom identifier usually obtained from an external authentication service.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

UnlinkDeviceAsync()

async Task Nakama.Client.UnlinkDeviceAsync ( ISession  session, string  id, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Unlink a device ID from the user account owned by the session.

Parameters

session	The session of the user.
id	A device identifier usually obtained from a platform API.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

UnlinkEmailAsync()

async Task Nakama.Client.UnlinkEmailAsync ( ISession  session, string  email, string  password, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Unlink an email with password from the user account owned by the session.

Parameters

session	The session of the user.
email	The email address of the user.
password	The password for the user.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

UnlinkFacebookAsync()

async Task Nakama.Client.UnlinkFacebookAsync ( ISession  session, string  token, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Unlink a Facebook profile from the user account owned by the session.

Parameters

session	The session of the user.
token	An OAuth access token from the Facebook SDK.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

UnlinkGameCenterAsync()

async Task Nakama.Client.UnlinkGameCenterAsync ( ISession  session, string  bundleId, string  playerId, string  publicKeyUrl, string  salt, string  signature, string  timestamp, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Unlink a Game Center profile from the user account owned by the session.

Parameters

session	The session of the user.
bundleId	The bundle ID of the Game Center application.
playerId	The player ID of the user in Game Center.
publicKeyUrl	The URL for the public encryption key.
salt	A random NSString used to compute the hash and keep it randomized.
signature	The verification signature data generated.
timestamp	The date and time that the signature was created.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

UnlinkGoogleAsync()

async Task Nakama.Client.UnlinkGoogleAsync ( ISession  session, string  token, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Unlink a Google profile from the user account owned by the session.

Parameters

session	The session of the user.
token	An OAuth access token from the Google SDK.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

UnlinkSteamAsync()

async Task Nakama.Client.UnlinkSteamAsync ( ISession  session, string  token, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Unlink a Steam profile from the user account owned by the session.

Parameters

session	The session of the user.
token	An authentication token from the Steam network.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

Implements Nakama.IClient.

UpdateAccountAsync()

async Task Nakama.Client.UpdateAccountAsync ( ISession  session, string  username, string  displayName = null, string  avatarUrl = null, string  langTag = null, string  location = null, string  timezone = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Update the current user's account on the server.

Parameters

session	The session for the user.
username	The new username for the user.
displayName	A new display name for the user.
avatarUrl	A new avatar url for the user.
langTag	A new language tag in BCP-47 format for the user.
location	A new location for the user.
timezone	New timezone information for the user.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which represents the asynchronous operation.

The current user's username will be automatically refreshed in their authorized ISession if the username field is updated to become different.

Implements Nakama.IClient.

UpdateGroupAsync()

async Task Nakama.Client.UpdateGroupAsync ( ISession  session, string  groupId, string  name, bool  open, string  description = null, string  avatarUrl = null, string  langTag = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Update a group.The user must have the correct access permissions for the group.

Implements Nakama.IClient.

ValidatePurchaseAppleAsync()

async Task< IApiValidatePurchaseResponse > Nakama.Client.ValidatePurchaseAppleAsync ( ISession  session, string  receipt, bool  persist = true, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Validate a purchase receipt against the Apple App Store.

Parameters

session	The session of the user.
receipt	The purchase receipt to be validated.
persist	Whether or not to track the receipt in the Nakama database.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the validated list of purchase receipts.

Implements Nakama.IClient.

ValidatePurchaseFacebookInstantAsync()

async Task< IApiValidatePurchaseResponse > Nakama.Client.ValidatePurchaseFacebookInstantAsync ( ISession  session, string  signedRequest, bool  persist = true, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Validate a purchase receipt against Facebook Instant Games.

Parameters

session	The session of the user.
signedRequest	Base64 encoded Facebook Instant receipt data payload.
persist	Whether or not to track the receipt in the Nakama database.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the validated list of purchase receipts.

Implements Nakama.IClient.

ValidatePurchaseGoogleAsync()

async Task< IApiValidatePurchaseResponse > Nakama.Client.ValidatePurchaseGoogleAsync ( ISession  session, string  receipt, bool  persist = true, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Validate a purchase receipt against the Google Play Store.

Parameters

session	The session of the user.
receipt	The purchase receipt to be validated.
persist	Whether or not to track the receipt in the Nakama database.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the validated list of purchase receipts.

Implements Nakama.IClient.

ValidatePurchaseHuaweiAsync()

async Task< IApiValidatePurchaseResponse > Nakama.Client.ValidatePurchaseHuaweiAsync ( ISession  session, string  receipt, string  signature, bool  persist = true, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Validate a purchase receipt against the Huawei AppGallery.

Parameters

session	The session of the user.
receipt	The purchase receipt to be validated.
signature	The signature of the purchase receipt.
persist	Whether or not to track the receipt in the Nakama database.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the validated list of purchase receipts.

Implements Nakama.IClient.

ValidateSubscriptionAppleAsync()

async Task< IApiValidateSubscriptionResponse > Nakama.Client.ValidateSubscriptionAppleAsync ( ISession  session, string  receipt, bool  persist = true, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Validate an Apple subscription receipt.

Parameters

session	The session of the user.
receipt	The receipt to validate.
persist	Whether or not to persist the receipt to Nakama's database.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the subscription validation response.

Implements Nakama.IClient.

ValidateSubscriptionGoogleAsync()

async Task< IApiValidateSubscriptionResponse > Nakama.Client.ValidateSubscriptionGoogleAsync ( ISession  session, string  receipt, bool  persist = true, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Validate a Google subscription receipt.

Parameters

session	The session of the user.
receipt	The receipt to validate.
persist	Whether or not to persist the receipt to Nakama's database.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the subscription validation response.

Implements Nakama.IClient.

WriteLeaderboardRecordAsync()

async Task< IApiLeaderboardRecord > Nakama.Client.WriteLeaderboardRecordAsync ( ISession  session, string  leaderboardId, long  score, long  subScore = 0, string  metadata = null, ApiOperator  apiOperator = ApiOperator::NO_OVERRIDE, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Write a record to a leaderboard.

Parameters

session	The session for the user.
leaderboardId	The ID of the leaderboard to write.
score	The score for the leaderboard record.
subScore	The sub score for the leaderboard record.
metadata	The metadata for the leaderboard record.
operator	The operator for the record that can be used to override the one set in the leaderboard. Parameters retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the leaderboard record object written.

Implements Nakama.IClient.

WriteStorageObjectsAsync()

async Task< IApiStorageObjectAcks > Nakama.Client.WriteStorageObjectsAsync ( ISession  session, IApiWriteStorageObject[]  objects = null, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Write objects to the storage engine.

Parameters

session	The session of the user.
objects	The objects to write.
retryConfiguration	The retry configuration. See RetryConfiguration
canceller	The CancellationToken that can be used to cancel the request while mid-flight.

Returns

A task which resolves to the storage write acknowledgements.

Implements Nakama.IClient.

WriteTournamentRecordAsync()

async Task< IApiLeaderboardRecord > Nakama.Client.WriteTournamentRecordAsync ( ISession  session, string  tournamentId, long  score, long  subScore = 0, string  metadata = null, ApiOperator  apiOperator = ApiOperator::NO_OVERRIDE, RetryConfiguration  retryConfiguration = null, CancellationToken  canceller = default  )

inline

Write a record to a tournament.

Parameters

session	The session of the user.
tournamentId	The ID of the tournament to write.
score	The score of the tournament record.
subScore	The sub score for the tournament record.
metadata	The metadata for the tournament record.
operator	The operator for the record that can be used to override the one set in the tournament. Parameters retryConfiguration The retry configuration. See RetryConfiguration canceller The CancellationToken that can be used to cancel the request while mid-flight. Returns A task which resolves to the tournament record object written.

Implements Nakama.IClient.

Member Data Documentation

DefaultExpiredTimeSpan

TimeSpan Nakama.Client.DefaultExpiredTimeSpan = TimeSpan.FromMinutes(5)

static

The default expired timespan used to check session lifetime.

DefaultHost

const string Nakama.Client.DefaultHost = "127.0.0.1"

static

The default host address of the server.

DefaultPort

const int Nakama.Client.DefaultPort = 7350

static

The default port number of the server.

DefaultScheme

const string Nakama.Client.DefaultScheme = "http"

static

The default protocol scheme for the socket connection.

Property Documentation

AutoRefreshSession

bool Nakama.Client.AutoRefreshSession

get

True if the session should be refreshed with an active refresh token.

Implements Nakama.IClient.

GlobalRetryConfiguration

RetryConfiguration Nakama.Client.GlobalRetryConfiguration

getset

Initial value:

= new RetryConfiguration(
            baseDelayMs: 500,
            jitter: RetryJitter.FullJitter,
            listener: null,
            maxRetries: 4)

The global retry configuration. See RetryConfiguration.

Implements Nakama.IClient.

Host

string Nakama.Client.Host

get

The host address of the server. Defaults to "127.0.0.1".

Implements Nakama.IClient.

Logger

ILogger Nakama.Client.Logger

getset

The logger to use with the client.

Implements Nakama.IClient.

Port

int Nakama.Client.Port

get

The port number of the server. Defaults to 7350.

Implements Nakama.IClient.

Scheme

string Nakama.Client.Scheme

get

The protocol scheme used to connect with the server. Must be either "http" or "https".

Implements Nakama.IClient.

ServerKey

string Nakama.Client.ServerKey

get

The key used to authenticate with the server without a session. Defaults to "defaultkey".

Implements Nakama.IClient.

Timeout

int Nakama.Client.Timeout

getset

Set the timeout in seconds on requests sent to the server.

Implements Nakama.IClient.

---

The documentation for this class was generated from the following file:

• Nakama/Client.cs