Class Client

A client for Nakama server.

Hierarchy

Client

Index

Constructors

constructor

new Client(serverkey?: string, host?: string, port?: string, useSSL?: boolean, timeout?: number, autoRefreshSession?: boolean): Client
Parameters
- serverkey: string = DEFAULT_SERVER_KEY
- host: string = DEFAULT_HOST
- port: string = DEFAULT_PORT
- useSSL: boolean = false
- timeout: number = DEFAULT_TIMEOUT_MS
- autoRefreshSession: boolean = true
Returns Client
- Defined in nakama-js/client.ts:518

Properties

`Private` `Readonly` apiClient

apiClient: NakamaApi

The low level API client for Nakama server.

`Readonly` autoRefreshSession

autoRefreshSession: boolean = true

expiredTimespanMs

expiredTimespanMs: number = DEFAULT_EXPIRED_TIMESPAN_MS

The expired timespan used to check session lifetime.

`Readonly` host

host: string = DEFAULT_HOST

`Readonly` port

port: string = DEFAULT_PORT

`Readonly` serverkey

serverkey: string = DEFAULT_SERVER_KEY

`Readonly` timeout

timeout: number = DEFAULT_TIMEOUT_MS

`Readonly` useSSL

useSSL: boolean = false

Methods

addFriends

addFriends(session: Session, ids?: string[], usernames?: string[]): Promise<boolean>
Add friends by ID or username to a user's account.
Parameters
- session: Session
- Optional ids: string[]
- Optional usernames: string[]
Returns Promise<boolean>
- Defined in nakama-js/client.ts:545

addGroupUsers

addGroupUsers(session: Session, groupId: string, ids?: string[]): Promise<boolean>
Add users to a group, or accept their join requests.
Parameters
- session: Session
- groupId: string
- Optional ids: string[]
Returns Promise<boolean>
- Defined in nakama-js/client.ts:532

authenticateApple

authenticateApple(token: string, create?: boolean, username?: string, vars?: Record<string, string>, options?: any): Promise<Session>
Authenticate a user with an Apple ID against the server.
Parameters
- token: string
- Optional create: boolean
- Optional username: string
- vars: Record<string, string> = {}
- options: any = {}
Returns Promise<Session>
- Defined in nakama-js/client.ts:558

authenticateCustom

authenticateCustom(id: string, create?: boolean, username?: string, vars?: Record<string, string>, options?: any): Promise<Session>
Authenticate a user with a custom id against the server.
Parameters
- id: string
- Optional create: boolean
- Optional username: string
- vars: Record<string, string> = {}
- options: any = {}
Returns Promise<Session>
- Defined in nakama-js/client.ts:571

authenticateDevice

authenticateDevice(id: string, create?: boolean, username?: string, vars?: Record<string, string>): Promise<Session>
Authenticate a user with a device id against the server.
Parameters
- id: string
- Optional create: boolean
- Optional username: string
- Optional vars: Record<string, string>
Returns Promise<Session>
- Defined in nakama-js/client.ts:582

authenticateEmail

authenticateEmail(email: string, password: string, create?: boolean, username?: string, vars?: Record<string, string>): Promise<Session>
Authenticate a user with an email+password against the server.
Parameters
- email: string
- password: string
- Optional create: boolean
- Optional username: string
- Optional vars: Record<string, string>
Returns Promise<Session>
- Defined in nakama-js/client.ts:594

authenticateFacebook

authenticateFacebook(token: string, create?: boolean, username?: string, sync?: boolean, vars?: Record<string, string>, options?: any): Promise<Session>
Authenticate a user with a Facebook OAuth token against the server.
Parameters
- token: string
- Optional create: boolean
- Optional username: string
- Optional sync: boolean
- Optional vars: Record<string, string>
- options: any = {}
Returns Promise<Session>
- Defined in nakama-js/client.ts:620

authenticateFacebookInstantGame

authenticateFacebookInstantGame(signedPlayerInfo: string, create?: boolean, username?: string, vars?: Record<string, string>, options?: any): Promise<Session>
Authenticate a user with a Facebook Instant Game token against the server.
Parameters
- signedPlayerInfo: string
- Optional create: boolean
- Optional username: string
- Optional vars: Record<string, string>
- options: any = {}
Returns Promise<Session>
- Defined in nakama-js/client.ts:607

authenticateGameCenter

authenticateGameCenter(bundleId: string, playerId: string, publicKeyUrl: string, salt: string, signature: string, timestamp: string, username?: string, create?: boolean, vars?: Record<string, string>, options?: any): Promise<Session>
Authenticate a user with GameCenter against the server.
Parameters
- bundleId: string
- playerId: string
- publicKeyUrl: string
- salt: string
- signature: string
- timestamp: string
- Optional username: string
- Optional create: boolean
- Optional vars: Record<string, string>
- options: any = {}
Returns Promise<Session>
- Defined in nakama-js/client.ts:661

authenticateGoogle

authenticateGoogle(token: string, create?: boolean, username?: string, vars?: Record<string, string>, options?: any): Promise<Session>
Authenticate a user with Google against the server.
Parameters
- token: string
- Optional create: boolean
- Optional username: string
- Optional vars: Record<string, string>
- options: any = {}
Returns Promise<Session>
- Defined in nakama-js/client.ts:632

authenticateSteam

authenticateSteam(token: string, create?: boolean, username?: string, sync?: boolean, vars?: Record<string, string>): Promise<Session>
Authenticate a user with Steam against the server.
Parameters
- token: string
- Optional create: boolean
- Optional username: string
- Optional sync: boolean
- Optional vars: Record<string, string>
Returns Promise<Session>
- Defined in nakama-js/client.ts:700

banGroupUsers

banGroupUsers(session: Session, groupId: string, ids?: string[]): Promise<boolean>
Ban users from a group.
Parameters
- session: Session
- groupId: string
- Optional ids: string[]
Returns Promise<boolean>
- Defined in nakama-js/client.ts:713

blockFriends

blockFriends(session: Session, ids?: string[], usernames?: string[]): Promise<boolean>
Block one or more users by ID or username.
Parameters
- session: Session
- Optional ids: string[]
- Optional usernames: string[]
Returns Promise<boolean>
- Defined in nakama-js/client.ts:725

createGroup

createGroup(session: Session, request: ApiCreateGroupRequest): Promise<Group>
Create a new group with the current user as the creator and superadmin.
Parameters
- session: Session
- request: ApiCreateGroupRequest
Returns Promise<Group>
- Defined in nakama-js/client.ts:737

createSocket

createSocket(useSSL?: boolean, verbose?: boolean, adapter?: WebSocketAdapter, sendTimeoutMs?: number): Socket
A socket created with the client's configuration.
Parameters
- useSSL: boolean = false
- verbose: boolean = false
- adapter: WebSocketAdapter = ...
- sendTimeoutMs: number = DefaultSocket.DefaultSendTimeoutMs
Returns Socket
- Defined in nakama-js/client.ts:762

deleteAccount

deleteAccount(session: Session): Promise<boolean>
Delete the current user's account.
Parameters
- session: Session
Returns Promise<boolean>
- Defined in nakama-js/client.ts:767

deleteFriends

deleteFriends(session: Session, ids?: string[], usernames?: string[]): Promise<boolean>
Delete one or more users by ID or username.
Parameters
- session: Session
- Optional ids: string[]
- Optional usernames: string[]
Returns Promise<boolean>
- Defined in nakama-js/client.ts:779

deleteGroup

deleteGroup(session: Session, groupId: string): Promise<boolean>
Delete a group the user is part of and has permissions to delete.
Parameters
- session: Session
- groupId: string
Returns Promise<boolean>
- Defined in nakama-js/client.ts:791

deleteNotifications

deleteNotifications(session: Session, ids?: string[]): Promise<boolean>
Delete one or more notifications
Parameters
- session: Session
- Optional ids: string[]
Returns Promise<boolean>
- Defined in nakama-js/client.ts:803

deleteStorageObjects

deleteStorageObjects(session: Session, request: ApiDeleteStorageObjectsRequest): Promise<boolean>
Delete one or more storage objects
Parameters
- session: Session
- request: ApiDeleteStorageObjectsRequest
Returns Promise<boolean>
- Defined in nakama-js/client.ts:815

deleteTournamentRecord

deleteTournamentRecord(session: Session, tournamentId: string): Promise<any>
Delete a tournament record.
Parameters
- session: Session
- tournamentId: string
Returns Promise<any>
- Defined in nakama-js/client.ts:827

demoteGroupUsers

demoteGroupUsers(session: Session, groupId: string, ids: string[]): Promise<boolean>
Demote a set of users in a group to the next role down.
Parameters
- session: Session
- groupId: string
- ids: string[]
Returns Promise<boolean>
- Defined in nakama-js/client.ts:832

emitEvent

emitEvent(session: Session, request: ApiEvent): Promise<boolean>
Submit an event for processing in the server's registered runtime custom events handler.
Parameters
- session: Session
- request: ApiEvent
Returns Promise<boolean>
- Defined in nakama-js/client.ts:844

getAccount

getAccount(session: Session): Promise<ApiAccount>
Fetch the current user's account.
Parameters
- session: Session
Returns Promise<ApiAccount>
- Defined in nakama-js/client.ts:856

getSubscription

getSubscription(session: Session, productId: string): Promise<ApiValidatedSubscription>
Get subscription by product id.
Parameters
- session: Session
- productId: string
Returns Promise<ApiValidatedSubscription>
- Defined in nakama-js/client.ts:866

getUsers

getUsers(session: Session, ids?: string[], usernames?: string[], facebookIds?: string[]): Promise<Users>
Fetch zero or more users by ID and/or username.
Parameters
- session: Session
- Optional ids: string[]
- Optional usernames: string[]
- Optional facebookIds: string[]
Returns Promise<Users>
- Defined in nakama-js/client.ts:900

importFacebookFriends

importFacebookFriends(session: Session, request: ApiAccountFacebook): Promise<boolean>
Import Facebook friends and add them to a user's account.
Parameters
- session: Session
- request: ApiAccountFacebook
Returns Promise<boolean>
- Defined in nakama-js/client.ts:876

importSteamFriends

importSteamFriends(session: Session, request: ApiAccountSteam, reset: boolean): Promise<boolean>
Import Steam friends and add them to a user's account.
Parameters
- session: Session
- request: ApiAccountSteam
- reset: boolean
Returns Promise<boolean>
- Defined in nakama-js/client.ts:888

joinGroup

joinGroup(session: Session, groupId: string): Promise<boolean>
Join a group that's open, or send a request to join a group that is closed.
Parameters
- session: Session
- groupId: string
Returns Promise<boolean>
- Defined in nakama-js/client.ts:940

joinTournament

joinTournament(session: Session, tournamentId: string): Promise<boolean>
Parameters
- session: Session
- tournamentId: string
Returns Promise<boolean>
- Defined in nakama-js/client.ts:951

kickGroupUsers

kickGroupUsers(session: Session, groupId: string, ids?: string[]): Promise<boolean>
Kick users from a group, or decline their join requests.
Parameters
- session: Session
- groupId: string
- Optional ids: string[]
Returns Promise<boolean>
- Defined in nakama-js/client.ts:963

leaveGroup

leaveGroup(session: Session, groupId: string): Promise<boolean>
Leave a group the user is part of.
Parameters
- session: Session
- groupId: string
Returns Promise<boolean>
- Defined in nakama-js/client.ts:975

linkApple

linkApple(session: Session, request: ApiAccountApple): Promise<boolean>
Add an Apple ID to the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountApple
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1148

linkCustom

linkCustom(session: Session, request: ApiAccountCustom): Promise<boolean>
Add a custom ID to the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountCustom
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1160

linkDevice

linkDevice(session: Session, request: ApiAccountDevice): Promise<boolean>
Add a device ID to the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountDevice
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1172

linkEmail

linkEmail(session: Session, request: ApiAccountEmail): Promise<boolean>
Add an email+password to the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountEmail
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1184

linkFacebook

linkFacebook(session: Session, request: ApiAccountFacebook): Promise<boolean>
Add Facebook to the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountFacebook
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1196

linkFacebookInstantGame

linkFacebookInstantGame(session: Session, request: ApiAccountFacebookInstantGame): Promise<boolean>
Add Facebook Instant to the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountFacebookInstantGame
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1208

linkGameCenter

linkGameCenter(session: Session, request: ApiAccountGameCenter): Promise<boolean>
Add GameCenter to the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountGameCenter
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1232

linkGoogle

linkGoogle(session: Session, request: ApiAccountGoogle): Promise<boolean>
Add Google to the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountGoogle
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1220

linkSteam

linkSteam(session: Session, request: ApiLinkSteamRequest): Promise<boolean>
Add Steam to the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiLinkSteamRequest
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1244

listChannelMessages

listChannelMessages(session: Session, channelId: string, limit?: number, forward?: boolean, cursor?: string): Promise<ChannelMessageList>
List a channel's message history.
Parameters
- session: Session
- channelId: string
- Optional limit: number
- Optional forward: boolean
- Optional cursor: string
Returns Promise<ChannelMessageList>
- Defined in nakama-js/client.ts:987

listFriends

listFriends(session: Session, state?: number, limit?: number, cursor?: string): Promise<Friends>
List all friends for the current user.
Parameters
- session: Session
- Optional state: number
- Optional limit: number
- Optional cursor: string
Returns Promise<Friends>
- Defined in nakama-js/client.ts:1256

listFriendsOfFriends

listFriendsOfFriends(session: Session, limit?: number, cursor?: string): Promise<FriendsOfFriends>
List friends of friends for the current user.
Parameters
- session: Session
- Optional limit: number
- Optional cursor: string
Returns Promise<FriendsOfFriends>
- Defined in nakama-js/client.ts:1302

listGroupUsers

listGroupUsers(session: Session, groupId: string, state?: number, limit?: number, cursor?: string): Promise<GroupUserList>
List a group's users.
Parameters
- session: Session
- groupId: string
- Optional state: number
- Optional limit: number
- Optional cursor: string
Returns Promise<GroupUserList>
- Defined in nakama-js/client.ts:1027

listGroups

listGroups(session: Session, name?: string, cursor?: string, limit?: number): Promise<GroupList>
List groups based on given filters.
Parameters
- session: Session
- Optional name: string
- Optional cursor: string
- Optional limit: number
Returns Promise<GroupList>
- Defined in nakama-js/client.ts:1111

listLeaderboardRecords

listLeaderboardRecords(session: Session, leaderboardId: string, ownerIds?: string[], limit?: number, cursor?: string, expiry?: string): Promise<LeaderboardRecordList>
List leaderboard records
Parameters
- session: Session
- leaderboardId: string
- Optional ownerIds: string[]
- Optional limit: number
- Optional cursor: string
- Optional expiry: string
Returns Promise<LeaderboardRecordList>
- Defined in nakama-js/client.ts:1349

listLeaderboardRecordsAroundOwner

listLeaderboardRecordsAroundOwner(session: Session, leaderboardId: string, ownerId: string, limit?: number, expiry?: string, cursor?: string): Promise<LeaderboardRecordList>
Parameters
- session: Session
- leaderboardId: string
- ownerId: string
- Optional limit: number
- Optional expiry: string
- Optional cursor: string
Returns Promise<LeaderboardRecordList>
- Defined in nakama-js/client.ts:1404

listMatches

listMatches(session: Session, limit?: number, authoritative?: boolean, label?: string, minSize?: number, maxSize?: number, query?: string): Promise<ApiMatchList>
Fetch list of running matches.
Parameters
- session: Session
- Optional limit: number
- Optional authoritative: boolean
- Optional label: string
- Optional minSize: number
- Optional maxSize: number
- Optional query: string
Returns Promise<ApiMatchList>
- Defined in nakama-js/client.ts:1460

listNotifications

listNotifications(session: Session, limit?: number, cacheableCursor?: string): Promise<NotificationList>
Fetch list of notifications.
Parameters
- session: Session
- Optional limit: number
- Optional cacheableCursor: string
Returns Promise<NotificationList>
- Defined in nakama-js/client.ts:1470

listStorageObjects

listStorageObjects(session: Session, collection: string, userId?: string, limit?: number, cursor?: string): Promise<StorageObjectList>
List storage objects.
Parameters
- session: Session
- collection: string
- Optional userId: string
- Optional limit: number
- Optional cursor: string
Returns Promise<StorageObjectList>
- Defined in nakama-js/client.ts:1502

listSubscriptions

listSubscriptions(session: Session, cursor?: string, limit?: number): Promise<SubscriptionList>
List user subscriptions.
Parameters
- session: Session
- Optional cursor: string
- Optional limit: number
Returns Promise<SubscriptionList>
- Defined in nakama-js/client.ts:1578

listTournamentRecords

listTournamentRecords(session: Session, tournamentId: string, ownerIds?: string[], limit?: number, cursor?: string, expiry?: string): Promise<TournamentRecordList>
List tournament records from a given tournament.
Parameters
- session: Session
- tournamentId: string
- Optional ownerIds: string[]
- Optional limit: number
- Optional cursor: string
- Optional expiry: string
Returns Promise<TournamentRecordList>
- Defined in nakama-js/client.ts:1591

listTournamentRecordsAroundOwner

listTournamentRecordsAroundOwner(session: Session, tournamentId: string, ownerId: string, limit?: number, expiry?: string, cursor?: string): Promise<TournamentRecordList>
List tournament records from a given tournament around the owner.
Parameters
- session: Session
- tournamentId: string
- ownerId: string
- Optional limit: number
- Optional expiry: string
- Optional cursor: string
Returns Promise<TournamentRecordList>
- Defined in nakama-js/client.ts:1646

listTournaments

listTournaments(session: Session, categoryStart?: number, categoryEnd?: number, startTime?: number, endTime?: number, limit?: number, cursor?: string): Promise<TournamentList>
List current or upcoming tournaments.
Parameters
- session: Session
- Optional categoryStart: number
- Optional categoryEnd: number
- Optional startTime: number
- Optional endTime: number
- Optional limit: number
- Optional cursor: string
Returns Promise<TournamentList>
- Defined in nakama-js/client.ts:1536

listUserGroups

listUserGroups(session: Session, userId: string, state?: number, limit?: number, cursor?: string): Promise<UserGroupList>
List a user's groups.
Parameters
- session: Session
- userId: string
- Optional state: number
- Optional limit: number
- Optional cursor: string
Returns Promise<UserGroupList>
- Defined in nakama-js/client.ts:1071

promoteGroupUsers

promoteGroupUsers(session: Session, groupId: string, ids?: string[]): Promise<boolean>
Promote users in a group to the next role up.
Parameters
- session: Session
- groupId: string
- Optional ids: string[]
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1701

readStorageObjects

readStorageObjects(session: Session, request: ApiReadStorageObjectsRequest): Promise<StorageObjects>
Fetch storage objects.
Parameters
- session: Session
- request: ApiReadStorageObjectsRequest
Returns Promise<StorageObjects>
- Defined in nakama-js/client.ts:1711

rpc

rpc(session: Session, id: string, input: object): Promise<RpcResponse>
Execute an RPC function on the server.
Parameters
- session: Session
- id: string
- input: object
Returns Promise<RpcResponse>
- Defined in nakama-js/client.ts:1742

rpcHttpKey

rpcHttpKey(httpKey: string, id: string, input?: object): Promise<RpcResponse>
Execute an RPC function on the server.
Parameters
- httpKey: string
- id: string
- Optional input: object
Returns Promise<RpcResponse>
- Defined in nakama-js/client.ts:1757

sessionLogout

sessionLogout(session: Session, token: string, refreshToken: string): Promise<boolean>
Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
Parameters
- session: Session
- token: string
- refreshToken: string
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1770

sessionRefresh

sessionRefresh(session: Session, vars?: Record<string, string>): Promise<Session>
Refresh a user's session using a refresh token retrieved from a previous authentication request.
Parameters
- session: Session
- vars: Record<string, string> = {}
Returns Promise<Session>
- Defined in nakama-js/client.ts:1782

unlinkApple

unlinkApple(session: Session, request: ApiAccountApple): Promise<boolean>
Remove the Apple ID from the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountApple
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1803

unlinkCustom

unlinkCustom(session: Session, request: ApiAccountCustom): Promise<boolean>
Remove custom ID from the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountCustom
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1816

unlinkDevice

unlinkDevice(session: Session, request: ApiAccountDevice): Promise<boolean>
Remove a device ID from the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountDevice
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1828

unlinkEmail

unlinkEmail(session: Session, request: ApiAccountEmail): Promise<boolean>
Remove an email+password from the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountEmail
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1840

unlinkFacebook

unlinkFacebook(session: Session, request: ApiAccountFacebook): Promise<boolean>
Remove Facebook from the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountFacebook
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1852

unlinkFacebookInstantGame

unlinkFacebookInstantGame(session: Session, request: ApiAccountFacebookInstantGame): Promise<boolean>
Remove Facebook Instant social profiles from the current user's account.
Parameters
- session: Session
- request: ApiAccountFacebookInstantGame
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1864

unlinkGameCenter

unlinkGameCenter(session: Session, request: ApiAccountGameCenter): Promise<boolean>
Remove GameCenter from the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountGameCenter
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1888

unlinkGoogle

unlinkGoogle(session: Session, request: ApiAccountGoogle): Promise<boolean>
Remove Google from the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountGoogle
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1876

unlinkSteam

unlinkSteam(session: Session, request: ApiAccountSteam): Promise<boolean>
Remove Steam from the social profiles on the current user's account.
Parameters
- session: Session
- request: ApiAccountSteam
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1900

updateAccount

updateAccount(session: Session, request: ApiUpdateAccountRequest): Promise<boolean>
Update fields in the current user's account.
Parameters
- session: Session
- request: ApiUpdateAccountRequest
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1911

updateGroup

updateGroup(session: Session, groupId: string, request: ApiUpdateGroupRequest): Promise<boolean>
Update a group the user is part of and has permissions to update.
Parameters
- session: Session
- groupId: string
- request: ApiUpdateGroupRequest
Returns Promise<boolean>
- Defined in nakama-js/client.ts:1923

validatePurchaseApple

validatePurchaseApple(session: Session, receipt?: string, persist?: boolean): Promise<ApiValidatePurchaseResponse>
Validate an Apple IAP receipt.
Parameters
- session: Session
- Optional receipt: string
- persist: boolean = true
Returns Promise<ApiValidatePurchaseResponse>
- Defined in nakama-js/client.ts:1935

validatePurchaseFacebookInstant

validatePurchaseFacebookInstant(session: Session, signedRequest?: string, persist?: boolean): Promise<ApiValidatePurchaseResponse>
Validate a FB Instant IAP receipt.
Parameters
- session: Session
- Optional signedRequest: string
- persist: boolean = true
Returns Promise<ApiValidatePurchaseResponse>
- Defined in nakama-js/client.ts:1945

validatePurchaseGoogle

validatePurchaseGoogle(session: Session, purchase?: string, persist?: boolean): Promise<ApiValidatePurchaseResponse>
Validate a Google IAP receipt.
Parameters
- session: Session
- Optional purchase: string
- persist: boolean = true
Returns Promise<ApiValidatePurchaseResponse>
- Defined in nakama-js/client.ts:1955

validatePurchaseHuawei

validatePurchaseHuawei(session: Session, purchase?: string, signature?: string, persist?: boolean): Promise<ApiValidatePurchaseResponse>
Validate a Huawei IAP receipt.
Parameters
- session: Session
- Optional purchase: string
- Optional signature: string
- persist: boolean = true
Returns Promise<ApiValidatePurchaseResponse>
- Defined in nakama-js/client.ts:1965

validateSubscriptionApple

validateSubscriptionApple(session: Session, receipt: string, persist?: boolean): Promise<ApiValidateSubscriptionResponse>
Validate Apple Subscription Receipt
Parameters
- session: Session
- receipt: string
- persist: boolean = true
Returns Promise<ApiValidateSubscriptionResponse>
- Defined in nakama-js/client.ts:1975

validateSubscriptionGoogle

validateSubscriptionGoogle(session: Session, receipt: string, persist?: boolean): Promise<ApiValidateSubscriptionResponse>
Validate Google Subscription Receipt
Parameters
- session: Session
- receipt: string
- persist: boolean = true
Returns Promise<ApiValidateSubscriptionResponse>
- Defined in nakama-js/client.ts:1985

writeLeaderboardRecord

writeLeaderboardRecord(session: Session, leaderboardId: string, request: WriteLeaderboardRecord): Promise<LeaderboardRecord>
Write a record to a leaderboard.
Parameters
- session: Session
- leaderboardId: string
- request: WriteLeaderboardRecord
Returns Promise<LeaderboardRecord>
- Defined in nakama-js/client.ts:1995

writeStorageObjects

writeStorageObjects(session: Session, objects: WriteStorageObject[]): Promise<ApiStorageObjectAcks>
Write storage objects.
Parameters
- session: Session
- objects: WriteStorageObject[]
Returns Promise<ApiStorageObjectAcks>
- Defined in nakama-js/client.ts:2023

writeTournamentRecord

writeTournamentRecord(session: Session, tournamentId: string, request: WriteTournamentRecord): Promise<LeaderboardRecord>
Write a record to a tournament.
Parameters
- session: Session
- tournamentId: string
- request: WriteTournamentRecord
Returns Promise<LeaderboardRecord>
- Defined in nakama-js/client.ts:2045

Class Client

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

serverkey: string = DEFAULT_SERVER_KEY

host: string = DEFAULT_HOST

port: string = DEFAULT_PORT

useSSL: boolean = false

timeout: number = DEFAULT_TIMEOUT_MS

autoRefreshSession: boolean = true

Returns Client

Properties

Private Readonly apiClient

Readonly autoRefreshSession

expiredTimespanMs

Readonly host

Readonly port

Readonly serverkey

Readonly timeout

Readonly useSSL

Methods

addFriends

Parameters

session: Session

Optional ids: string[]

Optional usernames: string[]

Returns Promise<boolean>

addGroupUsers

Parameters

session: Session

groupId: string

Optional ids: string[]

Returns Promise<boolean>

authenticateApple

Parameters

token: string

Optional create: boolean

Optional username: string

vars: Record<string, string> = {}

options: any = {}

Returns Promise<Session>

authenticateCustom

Parameters

id: string

Optional create: boolean

Optional username: string

vars: Record<string, string> = {}

options: any = {}

Returns Promise<Session>

authenticateDevice

Parameters

id: string

Optional create: boolean

Optional username: string

Optional vars: Record<string, string>

Returns Promise<Session>

authenticateEmail

Parameters

email: string

password: string

Optional create: boolean

Optional username: string

Optional vars: Record<string, string>

Returns Promise<Session>

authenticateFacebook

Parameters

token: string

Optional create: boolean

Optional username: string

Optional sync: boolean

Optional vars: Record<string, string>

options: any = {}

Returns Promise<Session>

authenticateFacebookInstantGame

Parameters

`Private` `Readonly` apiClient

`Readonly` autoRefreshSession

`Readonly` host

`Readonly` port

`Readonly` serverkey

`Readonly` timeout

`Readonly` useSSL

`Optional` ids: string[]

`Optional` usernames: string[]

`Optional` ids: string[]

`Optional` create: boolean

`Optional` username: string

`Optional` create: boolean

`Optional` username: string

`Optional` create: boolean

`Optional` username: string

`Optional` vars: Record<string, string>

`Optional` create: boolean

`Optional` username: string

`Optional` vars: Record<string, string>

`Optional` create: boolean

`Optional` username: string

`Optional` sync: boolean

`Optional` vars: Record<string, string>

`Optional` create: boolean

`Optional` username: string

`Optional` vars: Record<string, string>

`Optional` username: string

`Optional` create: boolean

`Optional` vars: Record<string, string>

`Optional` create: boolean

`Optional` username: string

`Optional` vars: Record<string, string>

`Optional` create: boolean

`Optional` username: string

`Optional` sync: boolean

`Optional` vars: Record<string, string>

`Optional` ids: string[]

`Optional` ids: string[]

`Optional` usernames: string[]

`Optional` ids: string[]

`Optional` usernames: string[]