Interface Socket

A socket connection to Nakama server.

Hierarchy

Socket

Implemented by

DefaultSocket

Methods

acceptPartyMember

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

- Defined in socket.ts:408
Parameters
- party_id: string
- presence: Presence
Returns Promise<void>

addMatchmaker

addMatchmaker(query: string, minCount: number, maxCount: number, stringProperties?: Record<string, string>, numericProperties?: Record<string, number>): Promise<MatchmakerTicket>

- Defined in socket.ts:411
Parameters
- query: string
- minCount: number
- maxCount: number
- Optional stringProperties: Record<string, string>
- Optional numericProperties: Record<string, number>
Returns Promise<MatchmakerTicket>

addMatchmakerParty

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

- Defined in socket.ts:416
Parameters
- party_id: string
- query: string
- min_count: number
- max_count: number
- Optional string_properties: Record<string, string>
- Optional numericProperties: Record<string, number>
Returns Promise<PartyMatchmakerTicket>

closeParty

closeParty(party_id: string): Promise<void>

- Defined in socket.ts:421
Parameters
- party_id: string
Returns Promise<void>

connect

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

- Defined in socket.ts:402
Parameters
- session: Session
- createStatus: boolean
Returns Promise<Session>

createMatch

createMatch(): Promise<Match>

- Defined in socket.ts:424
Returns Promise<Match>

createParty

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

- Defined in socket.ts:427
Parameters
- open: boolean
- max_size: number
Returns Promise<Party>

disconnect

disconnect(fireDisconnectEvent: boolean): void

- Defined in socket.ts:405
Parameters
- fireDisconnectEvent: boolean
Returns void

followUsers

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

- Defined in socket.ts:430
Parameters
- user_ids: string[]
Returns Promise<Status>

joinChat

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

- Defined in socket.ts:433
Parameters
- target: string
- type: number
- persistence: boolean
- hidden: boolean
Returns Promise<Channel>

joinMatch

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

- Defined in socket.ts:439
Parameters
- Optional match_id: string
- Optional token: string
- Optional metadata: {}
Returns Promise<Match>

joinParty

joinParty(party_id: string): Promise<void>

- Defined in socket.ts:436
Parameters
- party_id: string
Returns Promise<void>

leaveChat

leaveChat(channel_id: string): Promise<void>

- Defined in socket.ts:442
Parameters
- channel_id: string
Returns Promise<void>

leaveMatch

leaveMatch(matchId: string): Promise<void>

- Defined in socket.ts:445
Parameters
- matchId: string
Returns Promise<void>

leaveParty

leaveParty(party_id: string): Promise<void>

- Defined in socket.ts:448
Parameters
- party_id: string
Returns Promise<void>

listPartyJoinRequests

listPartyJoinRequests(party_id: string): Promise<PartyJoinRequest>

- Defined in socket.ts:451
Parameters
- party_id: string
Returns Promise<PartyJoinRequest>

onchannelmessage

onchannelmessage(channelMessage: ChannelMessage): void

- Defined in socket.ts:542
Parameters
- channelMessage: ChannelMessage
Returns void

onchannelpresence

onchannelpresence(channelPresence: ChannelPresenceEvent): void

- Defined in socket.ts:545
Parameters
- channelPresence: ChannelPresenceEvent
Returns void

ondisconnect

ondisconnect(evt: Event): void

- Defined in socket.ts:491
Parameters
- evt: Event
Returns void

onerror

onerror(evt: Event): void

- Defined in socket.ts:494
Parameters
- evt: Event
Returns void

onmatchdata

onmatchdata(matchData: MatchData): void

- Defined in socket.ts:500
Parameters
- matchData: MatchData
Returns void

onmatchmakermatched

onmatchmakermatched(matchmakerMatched: MatchmakerMatched): void

- Defined in socket.ts:509
Parameters
- matchmakerMatched: MatchmakerMatched
Returns void

onmatchmakerticket

onmatchmakerticket(matchmakerTicket: MatchmakerTicket): void

- Defined in socket.ts:506
Parameters
- matchmakerTicket: MatchmakerTicket
Returns void

onmatchpresence

onmatchpresence(matchPresence: MatchPresenceEvent): void

- Defined in socket.ts:503
Parameters
- matchPresence: MatchPresenceEvent
Returns void

onnotification

onnotification(notification: Notification): void

- Defined in socket.ts:497
Parameters
- notification: Notification
Returns void

onparty

onparty(party: Party): void

- Defined in socket.ts:512
Parameters
- party: Party
Returns void

onpartyclose

onpartyclose(partyClose: PartyClose): void

- Defined in socket.ts:515
Parameters
- partyClose: PartyClose
Returns void

onpartydata

onpartydata(partyData: PartyData): void

- Defined in socket.ts:518
Parameters
- partyData: PartyData
Returns void

onpartyjoinrequest

onpartyjoinrequest(partyJoinRequest: PartyJoinRequest): void

- Defined in socket.ts:521
Parameters
- partyJoinRequest: PartyJoinRequest
Returns void

onpartyleader

onpartyleader(partyLeader: PartyLeader): void

- Defined in socket.ts:524
Parameters
- partyLeader: PartyLeader
Returns void

onpartymatchmakerticket

onpartymatchmakerticket(partyMatchmakerMatched: PartyMatchmakerTicket): void

- Defined in socket.ts:530
Parameters
- partyMatchmakerMatched: PartyMatchmakerTicket
Returns void

onpartypresence

onpartypresence(partyPresence: PartyPresenceEvent): void

- Defined in socket.ts:527
Parameters
- partyPresence: PartyPresenceEvent
Returns void

onstatuspresence

onstatuspresence(statusPresence: StatusPresenceEvent): void

- Defined in socket.ts:533
Parameters
- statusPresence: StatusPresenceEvent
Returns void

onstreamdata

onstreamdata(streamData: StreamData): void

- Defined in socket.ts:539
Parameters
- streamData: StreamData
Returns void

onstreampresence

onstreampresence(streamPresence: StreamPresenceEvent): void

- Defined in socket.ts:536
Parameters
- streamPresence: StreamPresenceEvent
Returns void

promotePartyMember

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

- Defined in socket.ts:454
Parameters
- party_id: string
- party_member: Presence
Returns Promise<PartyLeader>

removeChatMessage

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

- Defined in socket.ts:457
Parameters
- channel_id: string
- message_id: string
Returns Promise<ChannelMessageAck>

removeMatchmaker

removeMatchmaker(ticket: string): Promise<void>

- Defined in socket.ts:460
Parameters
- ticket: string
Returns Promise<void>

removeMatchmakerParty

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

- Defined in socket.ts:463
Parameters
- party_id: string
- ticket: string
Returns Promise<void>

removePartyMember

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

- Defined in socket.ts:466
Parameters
- party_id: string
- presence: Presence
Returns Promise<void>

rpc

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

- Defined in socket.ts:469
Parameters
- Optional id: string
- Optional payload: string
- Optional http_key: string
Returns Promise<ApiRpc>

sendMatchState

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

- Defined in socket.ts:473
Parameters
- matchId: string
- opCode: number
- data: any
- Optional presence: Presence[]
Returns Promise<void>

sendPartyData

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

- Defined in socket.ts:476
Parameters
- party_id: string
- opcode: number
- data: any
Returns Promise<void>

unfollowUsers

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

- Defined in socket.ts:479
Parameters
- user_ids: string[]
Returns Promise<void>

updateChatMessage

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

- Defined in socket.ts:482
Parameters
- channel_id: string
- message_id: string
- content: any
Returns Promise<ChannelMessageAck>

updateStatus

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

- Defined in socket.ts:485
Parameters
- Optional status: string
Returns Promise<void>

writeChatMessage

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

- Defined in socket.ts:488
Parameters
- channel_id: string
- content: any
Returns Promise<ChannelMessageAck>

Generated using TypeDoc