Class DefaultSocket

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

Hierarchy

DefaultSocket

Implements

Socket

Constructors

constructor

new DefaultSocket(host: string, port: string, useSSL?: boolean, verbose?: boolean, adapter?: WebSocketAdapter): DefaultSocket

- Defined in socket.ts:561
Parameters
- host: string
- port: string
- useSSL: boolean = false
- verbose: boolean = false
- adapter: WebSocketAdapter = ...
Returns DefaultSocket

Properties

Readonly adapter

adapter: WebSocketAdapter = ...

Private Readonly cIds

cIds: {}

Type declaration

[key: string]: PromiseExecutor

Readonly host

host: string

Private nextCid

nextCid: number

Readonly port

port: string

Readonly useSSL

useSSL: boolean = false

verbose

verbose: boolean = false

Methods

acceptPartyMember

acceptPartyMember(party_id: string, presence: Presence): Promise<void>

Implementation of Socket.acceptPartyMember
- Defined in socket.ts:849
Parameters
- party_id: string
- presence: Presence
Returns Promise<void>

addMatchmaker

addMatchmaker(query: string, min_count: number, max_count: number, string_properties?: Record<string, string>, numeric_properties?: Record<string, number>): Promise<MatchmakerTicket>

Implementation of Socket.addMatchmaker
- Defined in socket.ts:853
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

addMatchmakerParty(party_id: string, query: string, min_count: number, max_count: number, string_properties?: Record<string, string>, numeric_properties?: Record<string, number>): Promise<PartyMatchmakerTicket>

Implementation of Socket.addMatchmakerParty
- Defined in socket.ts:870
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

closeParty(party_id: string): Promise<void>

Implementation of Socket.closeParty
- Defined in socket.ts:885
Parameters
- party_id: string
Returns Promise<void>

connect

connect(session: Session, createStatus?: boolean): Promise<Session>

Implementation of Socket.connect
- Defined in socket.ts:578
Parameters
- session: Session
- createStatus: boolean = false
Returns Promise<Session>

createMatch

createMatch(): Promise<Match>

Implementation of Socket.createMatch
- Defined in socket.ts:889
Returns Promise<Match>

createParty

createParty(open: boolean, max_size: number): Promise<Party>

Implementation of Socket.createParty
- Defined in socket.ts:894
Parameters
- open: boolean
- max_size: number
Returns Promise<Party>

disconnect

disconnect(fireDisconnectEvent?: boolean): void

Implementation of Socket.disconnect
- Defined in socket.ts:680
Parameters
- fireDisconnectEvent: boolean = true
Returns void

followUsers

followUsers(userIds: string[]): Promise<Status>

Implementation of Socket.followUsers
- Defined in socket.ts:899
Parameters
- userIds: string[]
Returns Promise<Status>

generatecid

generatecid(): string

- Defined in socket.ts:572
Returns string

joinChat

joinChat(target: string, type: number, persistence: boolean, hidden: boolean): Promise<Channel>

Implementation of Socket.joinChat
- Defined in socket.ts:904
Parameters
- target: string
- type: number
- persistence: boolean
- hidden: boolean
Returns Promise<Channel>

joinMatch

joinMatch(match_id?: string, token?: string, metadata?: {}): Promise<Match>

Implementation of Socket.joinMatch
- Defined in socket.ts:919
Parameters
- Optional match_id: string
- Optional token: string
- Optional metadata: {}
Returns Promise<Match>

joinParty

joinParty(party_id: string): Promise<void>

Implementation of Socket.joinParty
- Defined in socket.ts:936
Parameters
- party_id: string
Returns Promise<void>

leaveChat

leaveChat(channel_id: string): Promise<void>

Implementation of Socket.leaveChat
- Defined in socket.ts:940
Parameters
- channel_id: string
Returns Promise<void>

leaveMatch

leaveMatch(matchId: string): Promise<void>

Implementation of Socket.leaveMatch
- Defined in socket.ts:944
Parameters
- matchId: string
Returns Promise<void>

leaveParty

leaveParty(party_id: string): Promise<void>

Implementation of Socket.leaveParty
- Defined in socket.ts:948
Parameters
- party_id: string
Returns Promise<void>

listPartyJoinRequests

listPartyJoinRequests(party_id: string): Promise<PartyJoinRequest>

Implementation of Socket.listPartyJoinRequests
- Defined in socket.ts:952
Parameters
- party_id: string
Returns Promise<PartyJoinRequest>

onchannelmessage

onchannelmessage(channelMessage: ChannelMessage): void

Implementation of Socket.onchannelmessage
- Defined in socket.ts:701
Parameters
- channelMessage: ChannelMessage
Returns void

onchannelpresence

onchannelpresence(channelPresence: ChannelPresenceEvent): void

Implementation of Socket.onchannelpresence
- Defined in socket.ts:707
Parameters
- channelPresence: ChannelPresenceEvent
Returns void

ondisconnect

ondisconnect(evt: Event): void

Implementation of Socket.ondisconnect
- Defined in socket.ts:689
Parameters
- evt: Event
Returns void

onerror

onerror(evt: Event): void

Implementation of Socket.onerror
- Defined in socket.ts:695
Parameters
- evt: Event
Returns void

onmatchdata

onmatchdata(matchData: MatchData): void

Implementation of Socket.onmatchdata
- Defined in socket.ts:719
Parameters
- matchData: MatchData
Returns void

onmatchmakermatched

onmatchmakermatched(matchmakerMatched: MatchmakerMatched): void

Implementation of Socket.onmatchmakermatched
- Defined in socket.ts:737
Parameters
- matchmakerMatched: MatchmakerMatched
Returns void

onmatchmakerticket

onmatchmakerticket(matchmakerTicket: MatchmakerTicket): void

Implementation of Socket.onmatchmakerticket
- Defined in socket.ts:731
Parameters
- matchmakerTicket: MatchmakerTicket
Returns void

onmatchpresence

onmatchpresence(matchPresence: MatchPresenceEvent): void

Implementation of Socket.onmatchpresence
- Defined in socket.ts:725
Parameters
- matchPresence: MatchPresenceEvent
Returns void

onnotification

onnotification(notification: Notification): void

Implementation of Socket.onnotification
- Defined in socket.ts:713
Parameters
- notification: Notification
Returns void

onparty

onparty(party: Party): void

Implementation of Socket.onparty
- Defined in socket.ts:743
Parameters
- party: Party
Returns void

onpartyclose

onpartyclose(): void

Implementation of Socket.onpartyclose
- Defined in socket.ts:749
Returns void

onpartydata

onpartydata(partyData: PartyData): void

Implementation of Socket.onpartydata
- Defined in socket.ts:761
Parameters
- partyData: PartyData
Returns void

onpartyjoinrequest

onpartyjoinrequest(partyJoinRequest: PartyJoinRequest): void

Implementation of Socket.onpartyjoinrequest
- Defined in socket.ts:755
Parameters
- partyJoinRequest: PartyJoinRequest
Returns void

onpartyleader

onpartyleader(partyLeader: PartyLeader): void

Implementation of Socket.onpartyleader
- Defined in socket.ts:767
Parameters
- partyLeader: PartyLeader
Returns void

onpartymatchmakerticket

onpartymatchmakerticket(partyMatched: PartyMatchmakerTicket): void

Implementation of Socket.onpartymatchmakerticket
- Defined in socket.ts:773
Parameters
- partyMatched: PartyMatchmakerTicket
Returns void

onpartypresence

onpartypresence(partyPresence: PartyPresenceEvent): void

Implementation of Socket.onpartypresence
- Defined in socket.ts:780
Parameters
- partyPresence: PartyPresenceEvent
Returns void

onstatuspresence

onstatuspresence(statusPresence: StatusPresenceEvent): void

Implementation of Socket.onstatuspresence
- Defined in socket.ts:786
Parameters
- statusPresence: StatusPresenceEvent
Returns void

onstreamdata

onstreamdata(streamData: StreamData): void

Implementation of Socket.onstreamdata
- Defined in socket.ts:798
Parameters
- streamData: StreamData
Returns void

onstreampresence

onstreampresence(streamPresence: StreamPresenceEvent): void

Implementation of Socket.onstreampresence
- Defined in socket.ts:792
Parameters
- streamPresence: StreamPresenceEvent
Returns void

promotePartyMember

promotePartyMember(party_id: string, party_member: Presence): Promise<PartyLeader>

Implementation of Socket.promotePartyMember
- Defined in socket.ts:957
Parameters
- party_id: string
- party_member: Presence
Returns Promise<PartyLeader>

removeChatMessage

removeChatMessage(channel_id: string, message_id: string): Promise<ChannelMessageAck>

Implementation of Socket.removeChatMessage
- Defined in socket.ts:962
Parameters
- channel_id: string
- message_id: string
Returns Promise<ChannelMessageAck>

removeMatchmaker

removeMatchmaker(ticket: string): Promise<void>

Implementation of Socket.removeMatchmaker
- Defined in socket.ts:975
Parameters
- ticket: string
Returns Promise<void>

removeMatchmakerParty

removeMatchmakerParty(party_id: string, ticket: string): Promise<void>

Implementation of Socket.removeMatchmakerParty
- Defined in socket.ts:979
Parameters
- party_id: string
- ticket: string
Returns Promise<void>

removePartyMember

removePartyMember(party_id: string, member: Presence): Promise<void>

Implementation of Socket.removePartyMember
- Defined in socket.ts:989
Parameters
- party_id: string
- member: Presence
Returns Promise<void>

rpc

rpc(id?: string, payload?: string, http_key?: string): Promise<ApiRpc>

Implementation of Socket.rpc
- Defined in socket.ts:996
Parameters
- Optional id: string
- Optional payload: string
- Optional http_key: string
Returns Promise<ApiRpc>

send

send(message: PartyCreate | PartyJoinRequestList | PartyClose | ChannelJoin | ChannelLeave | ChannelMessageSend | ChannelMessageUpdate | ChannelMessageRemove | CreateMatch | JoinMatch | LeaveMatch | MatchDataSend | MatchmakerAdd | MatchmakerRemove | PartyAccept | PartyDataSend | PartyJoin | PartyLeave | PartyMatchmakerAdd | PartyMatchmakerRemove | PartyPromote | PartyRemove | Rpc | StatusFollow | StatusUnfollow | StatusUpdate): Promise<any>

- Defined in socket.ts:804
Parameters
- message: PartyCreate | PartyJoinRequestList | PartyClose | ChannelJoin | ChannelLeave | ChannelMessageSend | ChannelMessageUpdate | ChannelMessageRemove | CreateMatch | JoinMatch | LeaveMatch | MatchDataSend | MatchmakerAdd | MatchmakerRemove | PartyAccept | PartyDataSend | PartyJoin | PartyLeave | PartyMatchmakerAdd | PartyMatchmakerRemove | PartyPromote | PartyRemove | Rpc | StatusFollow | StatusUnfollow | StatusUpdate
Returns Promise<any>

sendMatchState

sendMatchState(matchId: string, opCode: number, data: any, presences?: Presence[]): Promise<void>

Implementation of Socket.sendMatchState
- Defined in socket.ts:1009
Parameters
- matchId: string
- opCode: number
- data: any
- Optional presences: Presence[]
Returns Promise<void>

sendPartyData

sendPartyData(party_id: string, op_code: number, data: any): Promise<void>

Implementation of Socket.sendPartyData
- Defined in socket.ts:1021
Parameters
- party_id: string
- op_code: number
- data: any
Returns Promise<void>

unfollowUsers

unfollowUsers(user_ids: string[]): Promise<void>

Implementation of Socket.unfollowUsers
- Defined in socket.ts:1025
Parameters
- user_ids: string[]
Returns Promise<void>

updateChatMessage

updateChatMessage(channel_id: string, message_id: string, content: any): Promise<ChannelMessageAck>

Implementation of Socket.updateChatMessage
- Defined in socket.ts:1029
Parameters
- channel_id: string
- message_id: string
- content: any
Returns Promise<ChannelMessageAck>

updateStatus

updateStatus(status?: string): Promise<void>

Implementation of Socket.updateStatus
- Defined in socket.ts:1034
Parameters
- Optional status: string
Returns Promise<void>

writeChatMessage

writeChatMessage(channel_id: string, content: any): Promise<ChannelMessageAck>

Implementation of Socket.writeChatMessage
- Defined in socket.ts:1038
Parameters
- channel_id: string
- content: any
Returns Promise<ChannelMessageAck>

Generated using TypeDoc