Class DefaultSocket

A socket connection to Nakama server implemented with the DOM's WebSocket API.

Hierarchy

DefaultSocket

Implements

Socket

Index

Constructors

constructor

Properties

_heartbeatTimeoutMs adapter cIds host nextCid port sendTimeoutMs useSSL verbose DefaultConnectTimeoutMs DefaultHeartbeatTimeoutMs DefaultSendTimeoutMs

Constructors

constructor

new DefaultSocket(host: string, port: string, useSSL?: boolean, verbose?: boolean, adapter?: WebSocketAdapter, sendTimeoutMs?: number): DefaultSocket
Parameters
- host: string
- port: string
- useSSL: boolean = false
- verbose: boolean = false
- adapter: WebSocketAdapter = ...
- sendTimeoutMs: number = DefaultSocket.DefaultSendTimeoutMs
Returns DefaultSocket
- Defined in nakama-js/socket.ts:733

Properties

`Private` _heartbeatTimeoutMs

_heartbeatTimeoutMs: number

`Readonly` adapter

adapter: WebSocketAdapter = ...

`Private` `Readonly` cIds

cIds: {
[key: string]: PromiseExecutor;
}

Type declaration

[key: string]: PromiseExecutor

`Readonly` host

host: string

`Private` nextCid

nextCid: number

`Readonly` port

port: string

`Readonly` sendTimeoutMs

sendTimeoutMs: number = DefaultSocket.DefaultSendTimeoutMs

`Readonly` useSSL

useSSL: boolean = false

verbose

verbose: boolean = false

`Static` `Readonly` DefaultConnectTimeoutMs

DefaultConnectTimeoutMs: 30000 = 30000

`Static` `Readonly` DefaultHeartbeatTimeoutMs

DefaultHeartbeatTimeoutMs: 10000 = 10000

`Static` `Readonly` DefaultSendTimeoutMs

DefaultSendTimeoutMs: 10000 = 10000

Methods

acceptPartyMember

acceptPartyMember(party_id: string, presence: Presence): Promise<void>
Accept a request to join.
Parameters
- party_id: string
- presence: Presence
Returns Promise<void>
Implementation of Socket.acceptPartyMember
- Defined in nakama-js/socket.ts:1052

addMatchmaker

addMatchmaker(query: string, min_count: number, max_count: number, string_properties?: Record<string, string>, numeric_properties?: Record<string, number>): Promise<MatchmakerTicket>
Join the matchmaker pool and search for opponents on the server.
Parameters
- query: string
- min_count: number
- max_count: number
- Optional string_properties: Record<string, string>
- Optional numeric_properties: Record<string, number>
Returns Promise<MatchmakerTicket>
Implementation of Socket.addMatchmaker
- Defined in nakama-js/socket.ts:1056

addMatchmakerParty

addMatchmakerParty(party_id: string, query: string, min_count: number, max_count: number, string_properties?: Record<string, string>, numeric_properties?: Record<string, number>): Promise<PartyMatchmakerTicket>
Begin matchmaking as a party.
Parameters
- party_id: string
- query: string
- min_count: number
- max_count: number
- Optional string_properties: Record<string, string>
- Optional numeric_properties: Record<string, number>
Returns Promise<PartyMatchmakerTicket>
Implementation of Socket.addMatchmakerParty
- Defined in nakama-js/socket.ts:1073

closeParty

closeParty(party_id: string): Promise<void>
End a party, kicking all party members and closing it.
Parameters
- party_id: string
Returns Promise<void>
Implementation of Socket.closeParty
- Defined in nakama-js/socket.ts:1088

connect

connect(session: Session, createStatus?: boolean, connectTimeoutMs?: number): Promise<Session>
Connect to the server.
Parameters
- session: Session
- createStatus: boolean = false
- connectTimeoutMs: number = DefaultSocket.DefaultConnectTimeoutMs
Returns Promise<Session>
Implementation of Socket.connect
- Defined in nakama-js/socket.ts:752

createMatch

createMatch(name?: string): Promise<Match>
Create a multiplayer match on the server.
Parameters
- Optional name: string
Returns Promise<Match>
Implementation of Socket.createMatch
- Defined in nakama-js/socket.ts:1092

createParty

createParty(open: boolean, max_size: number): Promise<Party>
Create a party.
Parameters
- open: boolean
- max_size: number
Returns Promise<Party>
Implementation of Socket.createParty
- Defined in nakama-js/socket.ts:1097

disconnect

disconnect(fireDisconnectEvent?: boolean): void
Disconnect from the server.
Parameters
- fireDisconnectEvent: boolean = true
Returns void
Implementation of Socket.disconnect
- Defined in nakama-js/socket.ts:860

followUsers

followUsers(userIds: string[]): Promise<Status>
Subscribe to one or more users for their status updates.
Parameters
- userIds: string[]
Returns Promise<Status>
Implementation of Socket.followUsers
- Defined in nakama-js/socket.ts:1102

generatecid

generatecid(): string
Returns string
- Defined in nakama-js/socket.ts:746

getHeartbeatTimeoutMs

getHeartbeatTimeoutMs(): number
Returns number
Implementation of Socket.getHeartbeatTimeoutMs
- Defined in nakama-js/socket.ts:873

joinChat

joinChat(target: string, type: number, persistence: boolean, hidden: boolean): Promise<Channel>
Join a chat channel on the server.
Parameters
- target: string
- type: number
- persistence: boolean
- hidden: boolean
Returns Promise<Channel>
Implementation of Socket.joinChat
- Defined in nakama-js/socket.ts:1107

joinMatch

joinMatch(match_id?: string, token?: string, metadata?: {}): Promise<Match>
Join a multiplayer match.
Parameters
- Optional match_id: string
- Optional token: string
- Optional metadata: {}
Returns Promise<Match>
Implementation of Socket.joinMatch
- Defined in nakama-js/socket.ts:1122

joinParty

joinParty(party_id: string): Promise<void>
Join a party.
Parameters
- party_id: string
Returns Promise<void>
Implementation of Socket.joinParty
- Defined in nakama-js/socket.ts:1139

leaveChat

leaveChat(channel_id: string): Promise<void>
Leave a chat channel on the server.
Parameters
- channel_id: string
Returns Promise<void>
Implementation of Socket.leaveChat
- Defined in nakama-js/socket.ts:1143

leaveMatch

leaveMatch(matchId: string): Promise<void>
Leave a multiplayer match on the server.
Parameters
- matchId: string
Returns Promise<void>
Implementation of Socket.leaveMatch
- Defined in nakama-js/socket.ts:1147

leaveParty

leaveParty(party_id: string): Promise<void>
Leave a party.
Parameters
- party_id: string
Returns Promise<void>
Implementation of Socket.leaveParty
- Defined in nakama-js/socket.ts:1151

listPartyJoinRequests

listPartyJoinRequests(party_id: string): Promise<PartyJoinRequest>
Request a list of pending join requests for a party.
Parameters
- party_id: string
Returns Promise<PartyJoinRequest>
Implementation of Socket.listPartyJoinRequests
- Defined in nakama-js/socket.ts:1155

onchannelmessage

onchannelmessage(channelMessage: ChannelMessage): void
Receive channel message.
Parameters
- channelMessage: ChannelMessage
Returns void
Implementation of Socket.onchannelmessage
- Defined in nakama-js/socket.ts:889

onchannelpresence

onchannelpresence(channelPresence: ChannelPresenceEvent): void
Receive channel presence updates.
Parameters
- channelPresence: ChannelPresenceEvent
Returns void
Implementation of Socket.onchannelpresence
- Defined in nakama-js/socket.ts:895

ondisconnect

ondisconnect(evt: Event): void
Handle disconnect events received from the socket.
Parameters
- evt: Event
Returns void
Implementation of Socket.ondisconnect
- Defined in nakama-js/socket.ts:877

onerror

onerror(evt: Event): void
Handle error events received from the socket.
Parameters
- evt: Event
Returns void
Implementation of Socket.onerror
- Defined in nakama-js/socket.ts:883

onheartbeattimeout

onheartbeattimeout(): void
An application-level heartbeat timeout that fires after the client does not receive a pong from the server after the heartbeat interval. Most browsers maintain an internal heartbeat, in which case its unlikely you'll need to use this callback. However, Chrome does not implement an internal heartbeat. We fire this separately from onclose because heartbeats fail when there's no connectivity, and many browsers don't fire onclose until the closing handshake either succeeds or fails. In any case, be aware that onclose will still fire if there is a heartbeat timeout in a potentially delayed manner.

Returns void
Implementation of Socket.onheartbeattimeout
- Defined in nakama-js/socket.ts:992

onmatchdata

onmatchdata(matchData: MatchData): void
Receive match data updates.
Parameters
- matchData: MatchData
Returns void
Implementation of Socket.onmatchdata
- Defined in nakama-js/socket.ts:907

onmatchmakermatched

onmatchmakermatched(matchmakerMatched: MatchmakerMatched): void
Receive matchmaking results.
Parameters
- matchmakerMatched: MatchmakerMatched
Returns void
Implementation of Socket.onmatchmakermatched
- Defined in nakama-js/socket.ts:925

onmatchmakerticket

onmatchmakerticket(matchmakerTicket: MatchmakerTicket): void
Receive a matchmaker ticket.
Parameters
- matchmakerTicket: MatchmakerTicket
Returns void
Implementation of Socket.onmatchmakerticket
- Defined in nakama-js/socket.ts:919

onmatchpresence

onmatchpresence(matchPresence: MatchPresenceEvent): void
Receive match presence updates.
Parameters
- matchPresence: MatchPresenceEvent
Returns void
Implementation of Socket.onmatchpresence
- Defined in nakama-js/socket.ts:913

onnotification

onnotification(notification: Notification): void
Receive notifications from the socket.
Parameters
- notification: Notification
Returns void
Implementation of Socket.onnotification
- Defined in nakama-js/socket.ts:901

onparty

onparty(party: Party): void
Receive party events.
Parameters
- party: Party
Returns void
Implementation of Socket.onparty
- Defined in nakama-js/socket.ts:931

onpartyclose

onpartyclose(close: PartyClose): void
Receive party close events.
Parameters
- close: PartyClose
Returns void
Implementation of Socket.onpartyclose
- Defined in nakama-js/socket.ts:937

onpartydata

onpartydata(partyData: PartyData): void
Receive party data updates.
Parameters
- partyData: PartyData
Returns void
Implementation of Socket.onpartydata
- Defined in nakama-js/socket.ts:949

onpartyjoinrequest

onpartyjoinrequest(partyJoinRequest: PartyJoinRequest): void
Receive party join requests, if party leader.
Parameters
- partyJoinRequest: PartyJoinRequest
Returns void
Implementation of Socket.onpartyjoinrequest
- Defined in nakama-js/socket.ts:943

onpartyleader

onpartyleader(partyLeader: PartyLeader): void
Receive announcements of a new party leader.
Parameters
- partyLeader: PartyLeader
Returns void
Implementation of Socket.onpartyleader
- Defined in nakama-js/socket.ts:955

onpartymatchmakerticket

onpartymatchmakerticket(partyMatched: PartyMatchmakerTicket): void
Receive matchmaking results.
Parameters
- partyMatched: PartyMatchmakerTicket
Returns void
Implementation of Socket.onpartymatchmakerticket
- Defined in nakama-js/socket.ts:961

onpartypresence

onpartypresence(partyPresence: PartyPresenceEvent): void
Receive a presence update for a party.
Parameters
- partyPresence: PartyPresenceEvent
Returns void
Implementation of Socket.onpartypresence
- Defined in nakama-js/socket.ts:968

onstatuspresence

onstatuspresence(statusPresence: StatusPresenceEvent): void
Receive status presence updates.
Parameters
- statusPresence: StatusPresenceEvent
Returns void
Implementation of Socket.onstatuspresence
- Defined in nakama-js/socket.ts:974

onstreamdata

onstreamdata(streamData: StreamData): void
Receive stream data.
Parameters
- streamData: StreamData
Returns void
Implementation of Socket.onstreamdata
- Defined in nakama-js/socket.ts:986

onstreampresence

onstreampresence(streamPresence: StreamPresenceEvent): void
Receive stream presence updates.
Parameters
- streamPresence: StreamPresenceEvent
Returns void
Implementation of Socket.onstreampresence
- Defined in nakama-js/socket.ts:980

`Private` pingPong

pingPong(): Promise<void>
Returns Promise<void>
- Defined in nakama-js/socket.ts:1247

promotePartyMember

promotePartyMember(party_id: string, party_member: Presence): Promise<PartyLeader>
Promote a new party leader.
Parameters
- party_id: string
- party_member: Presence
Returns Promise<PartyLeader>
Implementation of Socket.promotePartyMember
- Defined in nakama-js/socket.ts:1160

removeChatMessage

removeChatMessage(channel_id: string, message_id: string): Promise<ChannelMessageAck>
Remove a chat message from a chat channel on the server.
Parameters
- channel_id: string
- message_id: string
Returns Promise<ChannelMessageAck>
Implementation of Socket.removeChatMessage
- Defined in nakama-js/socket.ts:1165

removeMatchmaker

removeMatchmaker(ticket: string): Promise<void>
Leave the matchmaker pool with the provided ticket.
Parameters
- ticket: string
Returns Promise<void>
Implementation of Socket.removeMatchmaker
- Defined in nakama-js/socket.ts:1178

removeMatchmakerParty

removeMatchmakerParty(party_id: string, ticket: string): Promise<void>
Cancel a party matchmaking process using a ticket.
Parameters
- party_id: string
- ticket: string
Returns Promise<void>
Implementation of Socket.removeMatchmakerParty
- Defined in nakama-js/socket.ts:1182

removePartyMember

removePartyMember(party_id: string, member: Presence): Promise<void>
Kick a party member, or decline a request to join.
Parameters
- party_id: string
- member: Presence
Returns Promise<void>
Implementation of Socket.removePartyMember
- Defined in nakama-js/socket.ts:1192

rpc

rpc(id?: string, payload?: string, http_key?: string): Promise<ApiRpc>
Execute an RPC function to the server.
Parameters
- Optional id: string
- Optional payload: string
- Optional http_key: string
Returns Promise<ApiRpc>
Implementation of Socket.rpc
- Defined in nakama-js/socket.ts:1199

send

send(message: ChannelJoin | ChannelLeave | ChannelMessageSend | ChannelMessageUpdate | ChannelMessageRemove | MatchmakerAdd | MatchmakerRemove | CreateMatch | JoinMatch | LeaveMatch | MatchDataSend | PartyCreate | PartyJoin | PartyLeave | PartyPromote | PartyAccept | PartyClose | PartyDataSend | PartyJoinRequestList | PartyMatchmakerAdd | PartyMatchmakerRemove | PartyRemove | Rpc | Ping | StatusFollow | StatusUnfollow | StatusUpdate, sendTimeout?: number): Promise<any>
Parameters
- message: ChannelJoin | ChannelLeave | ChannelMessageSend | ChannelMessageUpdate | ChannelMessageRemove | MatchmakerAdd | MatchmakerRemove | CreateMatch | JoinMatch | LeaveMatch | MatchDataSend | PartyCreate | PartyJoin | PartyLeave | PartyPromote | PartyAccept | PartyClose | PartyDataSend | PartyJoinRequestList | PartyMatchmakerAdd | PartyMatchmakerRemove | PartyRemove | Rpc | Ping | StatusFollow | StatusUnfollow | StatusUpdate
- sendTimeout: number = DefaultSocket.DefaultSendTimeoutMs
Returns Promise<any>
- Defined in nakama-js/socket.ts:998

sendMatchState

sendMatchState(matchId: string, opCode: number, data: string | Uint8Array, presences?: Presence[], reliable?: boolean): Promise<void>
When no presences are supplied the new match state will be sent to all presences.
Parameters
- matchId: string
- opCode: number
- data: string | Uint8Array
- Optional presences: Presence[]
- Optional reliable: boolean
Returns Promise<void>
Implementation of Socket.sendMatchState
- Defined in nakama-js/socket.ts:1212

sendPartyData

sendPartyData(party_id: string, op_code: number, data: string | Uint8Array): Promise<void>
Send data to a party.
Parameters
- party_id: string
- op_code: number
- data: string | Uint8Array
Returns Promise<void>
Implementation of Socket.sendPartyData
- Defined in nakama-js/socket.ts:1225

setHeartbeatTimeoutMs

setHeartbeatTimeoutMs(ms: number): void
Parameters
- ms: number
Returns void
Implementation of Socket.setHeartbeatTimeoutMs
- Defined in nakama-js/socket.ts:869

unfollowUsers

unfollowUsers(user_ids: string[]): Promise<void>
Unfollow one or more users from their status updates.
Parameters
- user_ids: string[]
Returns Promise<void>
Implementation of Socket.unfollowUsers
- Defined in nakama-js/socket.ts:1229

updateChatMessage

updateChatMessage(channel_id: string, message_id: string, content: any): Promise<ChannelMessageAck>
Update a chat message on a chat channel in the server.
Parameters
- channel_id: string
- message_id: string
- content: any
Returns Promise<ChannelMessageAck>
Implementation of Socket.updateChatMessage
- Defined in nakama-js/socket.ts:1233

updateStatus

updateStatus(status?: string): Promise<void>
Update the status for the current user online.
Parameters
- Optional status: string
Returns Promise<void>
Implementation of Socket.updateStatus
- Defined in nakama-js/socket.ts:1238

writeChatMessage

writeChatMessage(channel_id: string, content: any): Promise<ChannelMessageAck>
Send a chat message to a chat channel on the server.
Parameters
- channel_id: string
- content: any
Returns Promise<ChannelMessageAck>
Implementation of Socket.writeChatMessage
- Defined in nakama-js/socket.ts:1242

Class DefaultSocket

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

host: string

port: string

useSSL: boolean = false

verbose: boolean = false

adapter: WebSocketAdapter = ...

sendTimeoutMs: number = DefaultSocket.DefaultSendTimeoutMs

Returns DefaultSocket

Properties

Private _heartbeatTimeoutMs

Readonly adapter

Private Readonly cIds

Type declaration

[key: string]: PromiseExecutor

Readonly host

Private nextCid

Readonly port

Readonly sendTimeoutMs

Readonly useSSL

verbose

Static Readonly DefaultConnectTimeoutMs

Static Readonly DefaultHeartbeatTimeoutMs

Static Readonly DefaultSendTimeoutMs

Methods

acceptPartyMember

Parameters

party_id: string

presence: Presence

Returns Promise<void>

addMatchmaker

Parameters

query: string

min_count: number

max_count: number

Optional string_properties: Record<string, string>

Optional numeric_properties: Record<string, number>

Returns Promise<MatchmakerTicket>

addMatchmakerParty

Parameters

party_id: string

query: string

min_count: number

max_count: number

Optional string_properties: Record<string, string>

Optional numeric_properties: Record<string, number>

Returns Promise<PartyMatchmakerTicket>

closeParty

Parameters

party_id: string

Returns Promise<void>

connect

Parameters

session: Session

createStatus: boolean = false

connectTimeoutMs: number = DefaultSocket.DefaultConnectTimeoutMs

Returns Promise<Session>

createMatch

Parameters

Optional name: string

Returns Promise<Match>

createParty

Parameters

open: boolean

max_size: number

Returns Promise<Party>

disconnect

Parameters

fireDisconnectEvent: boolean = true

Returns void

followUsers

Parameters

`Private` _heartbeatTimeoutMs

`Readonly` adapter

`Private` `Readonly` cIds

`Readonly` host

`Private` nextCid

`Readonly` port

`Readonly` sendTimeoutMs

`Readonly` useSSL

`Static` `Readonly` DefaultConnectTimeoutMs

`Static` `Readonly` DefaultHeartbeatTimeoutMs

`Static` `Readonly` DefaultSendTimeoutMs

`Optional` string_properties: Record<string, string>

`Optional` numeric_properties: Record<string, number>

`Optional` string_properties: Record<string, string>

`Optional` numeric_properties: Record<string, number>

`Optional` name: string

`Optional` match_id: string

`Optional` token: string

`Optional` metadata: {}