Nakama.IClient Interface Reference

A client for the API in Nakama server. More...

Inheritance diagram for Nakama.IClient:

Public Member Functions
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.
Task	AddGroupUsersAsync (ISession session, string groupId, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Add one or more users to the group.
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.
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.
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.
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.
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.
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.
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.
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.
Task	BanGroupUsersAsync (ISession session, string groupId, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Ban a set of users from a group.
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.
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.
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.
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.
Task	DeleteGroupAsync (ISession session, string groupId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete a group by id.
Task	DeleteLeaderboardRecordAsync (ISession session, string leaderboardId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete a leaderboard record.
Task	DeleteNotificationsAsync (ISession session, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete one or more notifications by id.
Task	DeleteStorageObjectsAsync (ISession session, StorageObjectId[] ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete one or more storage objects.
Task	DeleteTournamentRecordAsync (ISession session, string tournamentId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Delete the user's tournament record.
Task	DemoteGroupUsersAsync (ISession session, string groupId, IEnumerable< string > userIds, 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.
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.
Task< IApiAccount >	GetAccountAsync (ISession session, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Fetch the user account owned by the session.
Task< IApiValidatedSubscription >	GetSubscriptionAsync (ISession session, string productId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Get the subscription represented by the provided product id.
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.
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.
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.
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.
Task	JoinTournamentAsync (ISession session, string tournamentId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Join a tournament by ID.
Task	KickGroupUsersAsync (ISession session, string groupId, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Kick one or more users from the group.
Task	LeaveGroupAsync (ISession session, string groupId, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Leave a group by ID.
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.
Task	LinkCustomAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a custom ID to the user account owned by the session.
Task	LinkDeviceAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a device ID to the user account owned by the session.
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.
Task	LinkFacebookAsync (ISession session, string token, bool? import=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a Facebook profile to a user account.
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.
Task	LinkGoogleAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a Google profile to a user account.
Task	LinkSteamAsync (ISession session, string token, bool import, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Link a Steam profile to a user account.
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.
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.
Task< IApiFriendList >	ListFriendsAsync (ISession session, int? state=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List of friends of the current user.
Task< IApiGroupUserList >	ListGroupUsersAsync (ISession session, string groupId, int? state=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List all users part of the group.
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.
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)
	List records from a leaderboard.
Task< IApiLeaderboardRecordList >	ListLeaderboardRecordsAroundOwnerAsync (ISession session, string leaderboardId, string ownerId, long? expiry=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List leaderboard records that belong to a user.
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.
Task< IApiNotificationList >	ListNotificationsAsync (ISession session, int limit=1, string cacheableCursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List notifications for the user with an optional cursor.
Task< IApiStorageObjectList >	ListStorageObjects (ISession session, string collection, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
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.
Task< IApiSubscriptionList >	ListSubscriptionsAsync (ISession session, int limit, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List the user's subscriptions.
Task< IApiTournamentRecordList >	ListTournamentRecordsAroundOwnerAsync (ISession session, string tournamentId, string ownerId, long? expiry=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List tournament records around the owner.
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)
	List records from a tournament.
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.
Task< IApiUserGroupList >	ListUserGroupsAsync (ISession session, int? state=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List of groups the current user is a member of.
Task< IApiUserGroupList >	ListUserGroupsAsync (ISession session, string userId, int? state=null, int limit=1, string cursor=null, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	List groups a user is a member of.
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.
Task	PromoteGroupUsersAsync (ISession session, string groupId, IEnumerable< string > ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Promote one or more users in the group.
Task< IApiStorageObjects >	ReadStorageObjectsAsync (ISession session, IApiReadStorageObjectId[] ids, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Read one or more objects from the storage engine.
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.
Task< IApiRpc >	RpcAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Execute a function on the server.
Task< IApiRpc >	RpcAsync (string httpKey, string id, string payload, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Execute a function on the server without a session.
Task< IApiRpc >	RpcAsync (string httpKey, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Execute a function on the server without a session.
Task	SessionLogoutAsync (ISession session, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Log out a session which invalidates the authorization and refresh token.
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.
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.
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.
Task	UnlinkCustomAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a custom ID from the user account owned by the session.
Task	UnlinkDeviceAsync (ISession session, string id, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a device ID from the user account owned by the session.
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.
Task	UnlinkFacebookAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a Facebook profile from the user account owned by the session.
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.
Task	UnlinkGoogleAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a Google profile from the user account owned by the session.
Task	UnlinkSteamAsync (ISession session, string token, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Unlink a Steam profile from the user account owned by the session.
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)
	Update the current user's account on the server.
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.
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.
Task< IApiValidatePurchaseResponse >	ValidatePurchaseFacebookInstantAsync (ISession session, string signedRequest, bool persist=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Validate a purchase receipt against Facebook Instant Games.
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.
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.
Task< IApiValidateSubscriptionResponse >	ValidateSubscriptionAppleAsync (ISession session, string receipt, bool persist=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Validate an Apple subscription receipt.
Task< IApiValidateSubscriptionResponse >	ValidateSubscriptionGoogleAsync (ISession session, string receipt, bool persist=true, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Validate a Google subscription receipt.
Task< IApiLeaderboardRecord >	WriteLeaderboardRecordAsync (ISession session, string leaderboardId, long score, long subScore=0L, string metadata=null, ApiOperator apiOperator=ApiOperator.NO_OVERRIDE, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Write a record to a leaderboard.
Task< IApiStorageObjectAcks >	WriteStorageObjectsAsync (ISession session, IApiWriteStorageObject[] objects, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Write objects to the storage engine.
Task< IApiLeaderboardRecord >	WriteTournamentRecordAsync (ISession session, string tournamentId, long score, long subScore=0L, string metadata=null, ApiOperator apiOperator=ApiOperator.NO_OVERRIDE, RetryConfiguration retryConfiguration=null, CancellationToken canceller=default)
	Write a record to a tournament.

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".
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.
ILogger	Logger [get, set]
	The logger to use with the client.

Detailed Description

A client for the API in Nakama server.

Member Function Documentation

AddFriendsAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

AddGroupUsersAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

AuthenticateAppleAsync()

Task< ISession > Nakama.IClient.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.

Implemented in Nakama.Client.

AuthenticateCustomAsync()

Task< ISession > Nakama.IClient.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.

Implemented in Nakama.Client.

AuthenticateDeviceAsync()

Task< ISession > Nakama.IClient.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.

Implemented in Nakama.Client.

AuthenticateEmailAsync()

Task< ISession > Nakama.IClient.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.

Implemented in Nakama.Client.

AuthenticateFacebookAsync()

Task< ISession > Nakama.IClient.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.

Implemented in Nakama.Client.

AuthenticateGameCenterAsync()

Task< ISession > Nakama.IClient.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.

Implemented in Nakama.Client.

AuthenticateGoogleAsync()

Task< ISession > Nakama.IClient.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.

Implemented in Nakama.Client.

AuthenticateSteamAsync()

Task< ISession > Nakama.IClient.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.

Implemented in Nakama.Client.

BanGroupUsersAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

BlockFriendsAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

CreateGroupAsync()

Task< IApiGroup > Nakama.IClient.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.

Implemented in Nakama.Client.

DeleteAccountAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

DeleteFriendsAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

DeleteGroupAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

DeleteLeaderboardRecordAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

DeleteNotificationsAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

DeleteStorageObjectsAsync()

Task Nakama.IClient.DeleteStorageObjectsAsync	(	ISession	session,
		StorageObjectId[]	ids,
		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.

Implemented in Nakama.Client.

DeleteTournamentRecordAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

DemoteGroupUsersAsync()

Task Nakama.IClient.DemoteGroupUsersAsync	(	ISession	session,
		string	groupId,
		IEnumerable< string >	userIds,
		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.

Returns

A task which represents the asynchronous operation.

Implemented in Nakama.Client.

EventAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

GetAccountAsync()

Task< IApiAccount > Nakama.IClient.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.

Implemented in Nakama.Client.

GetSubscriptionAsync()

Task< IApiValidatedSubscription > Nakama.IClient.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.

Implemented in Nakama.Client.

GetUsersAsync()

Task< IApiUsers > Nakama.IClient.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.

Implemented in Nakama.Client.

ImportFacebookFriendsAsync()

Task Nakama.IClient.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.

Parameters

session	The session of the user.
token	An OAuth access token from the Facebook SDK.
reset	If the Facebook friend import for the user should be reset.
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.

Implemented in Nakama.Client.

ImportSteamFriendsAsync()

Task Nakama.IClient.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.

Parameters

session	The session of the user.
token	An access token from Steam.
reset	If the Steam friend import for the user should be reset.
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.

Implemented in Nakama.Client.

JoinGroupAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

JoinTournamentAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

KickGroupUsersAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

LeaveGroupAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

LinkAppleAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

LinkCustomAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

LinkDeviceAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

LinkEmailAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

LinkFacebookAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

LinkGameCenterAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

LinkGoogleAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

LinkSteamAsync()

Task Nakama.IClient.LinkSteamAsync	(	ISession	session,
		string	token,
		bool	import,
		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.

Implemented in Nakama.Client.

ListChannelMessagesAsync() [1/2]

Task< IApiChannelMessageList > Nakama.IClient.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.

Implemented in Nakama.Client.

ListChannelMessagesAsync() [2/2]

Task< IApiChannelMessageList > Nakama.IClient.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.

Implemented in Nakama.Client.

ListFriendsAsync()

Task< IApiFriendList > Nakama.IClient.ListFriendsAsync	(	ISession	session,
		int?	state = null,
		int	limit = 1,
		string	cursor = null,
		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.

Implemented in Nakama.Client.

ListGroupsAsync()

Task< IApiGroupList > Nakama.IClient.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.

Implemented in Nakama.Client.

ListGroupUsersAsync()

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

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.

Implemented in Nakama.Client.

ListLeaderboardRecordsAroundOwnerAsync()

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

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.

Implemented in Nakama.Client.

ListLeaderboardRecordsAsync()

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

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.

Implemented in Nakama.Client.

ListMatchesAsync()

Task< IApiMatchList > Nakama.IClient.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.

Implemented in Nakama.Client.

ListNotificationsAsync()

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

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.

Implemented in Nakama.Client.

ListStorageObjects()

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

Implemented in Nakama.Client.

ListStorageObjectsAsync()

Task< IApiStorageObjectList > Nakama.IClient.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.

Implemented in Nakama.Client.

ListSubscriptionsAsync()

Task< IApiSubscriptionList > Nakama.IClient.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.

Implemented in Nakama.Client.

ListTournamentRecordsAroundOwnerAsync()

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

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.

Implemented in Nakama.Client.

ListTournamentRecordsAsync()

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

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.

Implemented in Nakama.Client.

ListTournamentsAsync()

Task< IApiTournamentList > Nakama.IClient.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.

Implemented in Nakama.Client.

ListUserGroupsAsync() [1/2]

Task< IApiUserGroupList > Nakama.IClient.ListUserGroupsAsync	(	ISession	session,
		int?	state = null,
		int	limit = 1,
		string	cursor = null,
		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.

Implemented in Nakama.Client.

ListUserGroupsAsync() [2/2]

Task< IApiUserGroupList > Nakama.IClient.ListUserGroupsAsync	(	ISession	session,
		string	userId,
		int?	state = null,
		int	limit = 1,
		string	cursor = null,
		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.

Implemented in Nakama.Client.

ListUsersStorageObjectsAsync()

Task< IApiStorageObjectList > Nakama.IClient.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.

Implemented in Nakama.Client.

PromoteGroupUsersAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

ReadStorageObjectsAsync()

Task< IApiStorageObjects > Nakama.IClient.ReadStorageObjectsAsync	(	ISession	session,
		IApiReadStorageObjectId[]	ids,
		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.

Implemented in Nakama.Client.

RpcAsync() [1/4]

Task< IApiRpc > Nakama.IClient.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.

Implemented in Nakama.Client.

RpcAsync() [2/4]

Task< IApiRpc > Nakama.IClient.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.

Implemented in Nakama.Client.

RpcAsync() [3/4]

Task< IApiRpc > Nakama.IClient.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.

Parameters

httpKey	The secure HTTP key used to authenticate.
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 to resolve an RPC response.

Implemented in Nakama.Client.

RpcAsync() [4/4]

Task< IApiRpc > Nakama.IClient.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.

Parameters

httpKey	The secure HTTP key used to authenticate.
id	The id of the function to execute on the server.
payload	A 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 to resolve an RPC response.

Implemented in Nakama.Client.

SessionLogoutAsync() [1/2]

Task Nakama.IClient.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.

Implemented in Nakama.Client.

SessionLogoutAsync() [2/2]

Task Nakama.IClient.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.

Implemented in Nakama.Client.

SessionRefreshAsync()

Task< ISession > Nakama.IClient.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.

Implemented in Nakama.Client.

UnlinkAppleAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

UnlinkCustomAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

UnlinkDeviceAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

UnlinkEmailAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

UnlinkFacebookAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

UnlinkGameCenterAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

UnlinkGoogleAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

UnlinkSteamAsync()

Task Nakama.IClient.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.

Implemented in Nakama.Client.

UpdateAccountAsync()

Task Nakama.IClient.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
	)

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.

Implemented in Nakama.Client.

UpdateGroupAsync()

Task Nakama.IClient.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.

Parameters

session	The session of the user.
groupId	The ID of the group to update.
name	A new name for the group.
open	If the group should have open membership.
description	A new description for the group.
avatarUrl	A new avatar url for the group.
langTag	A new language tag in BCP-47 format for 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.

Implemented in Nakama.Client.

ValidatePurchaseAppleAsync()

Task< IApiValidatePurchaseResponse > Nakama.IClient.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.

Implemented in Nakama.Client.

ValidatePurchaseFacebookInstantAsync()

Task< IApiValidatePurchaseResponse > Nakama.IClient.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.

Implemented in Nakama.Client.

ValidatePurchaseGoogleAsync()

Task< IApiValidatePurchaseResponse > Nakama.IClient.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.

Implemented in Nakama.Client.

ValidatePurchaseHuaweiAsync()

Task< IApiValidatePurchaseResponse > Nakama.IClient.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.

Implemented in Nakama.Client.

ValidateSubscriptionAppleAsync()

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

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.

Implemented in Nakama.Client.

ValidateSubscriptionGoogleAsync()

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

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.

Implemented in Nakama.Client.

WriteLeaderboardRecordAsync()

Task< IApiLeaderboardRecord > Nakama.IClient.WriteLeaderboardRecordAsync	(	ISession	session,
		string	leaderboardId,
		long	score,
		long	subScore = 0L,
		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.

Implemented in Nakama.Client.

WriteStorageObjectsAsync()

Task< IApiStorageObjectAcks > Nakama.IClient.WriteStorageObjectsAsync	(	ISession	session,
		IApiWriteStorageObject[]	objects,
		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.

Implemented in Nakama.Client.

WriteTournamentRecordAsync()

Task< IApiLeaderboardRecord > Nakama.IClient.WriteTournamentRecordAsync	(	ISession	session,
		string	tournamentId,
		long	score,
		long	subScore = 0L,
		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.

Implemented in Nakama.Client.

Property Documentation

AutoRefreshSession

bool Nakama.IClient.AutoRefreshSession

get

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

Implemented in Nakama.Client.

GlobalRetryConfiguration

RetryConfiguration Nakama.IClient.GlobalRetryConfiguration

getset

The global retry configuration. See RetryConfiguration.

Implemented in Nakama.Client.

Host

string Nakama.IClient.Host

get

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

Implemented in Nakama.Client.

Logger

ILogger Nakama.IClient.Logger

getset

The logger to use with the client.

Implemented in Nakama.Client.

Port

int Nakama.IClient.Port

get

The port number of the server. Defaults to 7350.

Implemented in Nakama.Client.

Scheme

string Nakama.IClient.Scheme

get

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

Implemented in Nakama.Client.

ServerKey

string Nakama.IClient.ServerKey

get

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

Implemented in Nakama.Client.

Timeout

int Nakama.IClient.Timeout

getset

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

Implemented in Nakama.Client.

---

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

• Nakama/IClient.cs