A socket to interact with Nakama server. More...

Inheritance diagram for Nakama.ISocket:

Public Member Functions
Task	AcceptPartyMemberAsync (string partyId, IUserPresence presence)
	Accept a party member's request to join the party.
Task< IMatchmakerTicket >	AddMatchmakerAsync (string query="*", int minCount=2, int maxCount=8, Dictionary< string, string > stringProperties=null, Dictionary< string, double > numericProperties=null, int? countMultiple=null)
	Join the matchmaker pool and search for opponents on the server.
Task< IPartyMatchmakerTicket >	AddMatchmakerPartyAsync (string partyId, string query, int minCount, int maxCount, Dictionary< string, string > stringProperties=null, Dictionary< string, double > numericProperties=null, int? countMultiple=null)
	Begin matchmaking as a party.
Task	ClosePartyAsync (string partyId)
	End a party, kicking all party members and closing it.
Task	CloseAsync ()
	Close the socket connection to the server.
Task	ConnectAsync (ISession session, bool appearOnline=false, int connectTimeout=Socket.DefaultConnectTimeout, string langTag="en")
	Connect to the server.
Task< IMatch >	CreateMatchAsync (string matchName=null)
	Create a multiplayer match on the server.
Task< IParty >	CreatePartyAsync (bool open, bool hidden, int maxSize, string label=null)
	Create a party.
Task< IStatus >	FollowUsersAsync (IEnumerable< IApiUser > users)
	Subscribe to one or more users for their status updates.
Task< IStatus >	FollowUsersAsync (IEnumerable< string > userIDs, IEnumerable< string > usernames=null)
	Subscribe to one or more users for their status updates.
Task< IChannel >	JoinChatAsync (string target, ChannelType type, bool persistence=false, bool hidden=false)
	Join a chat channel on the server.
Task	JoinPartyAsync (string partyId)
	Join a party.
Task< IMatch >	JoinMatchAsync (IMatchmakerMatched matched)
	Join a multiplayer match with the matchmaker matched object.
Task< IMatch >	JoinMatchAsync (string matchId, IDictionary< string, string > metadata=null)
	Join a multiplayer match by ID.
Task	LeaveChatAsync (IChannel channel)
	Leave a chat channel on the server.
Task	LeaveChatAsync (string channelId)
	Leave a chat channel on the server.
Task	LeaveMatchAsync (IMatch match)
	Leave a multiplayer match on the server.
Task	LeaveMatchAsync (string matchId)
	Leave a multiplayer match on the server.
Task	LeavePartyAsync (string partyId)
	Leave the party.
Task< IPartyJoinRequest >	ListPartyJoinRequestsAsync (string partyId)
	Request a list of pending join requests for a party.
Task	PromotePartyMemberAsync (string partyId, IUserPresence partyMember)
	Promote a new party leader.
Task< IChannelMessageAck >	RemoveChatMessageAsync (IChannel channel, string messageId)
	Remove a chat message from a chat channel on the server.
Task< IChannelMessageAck >	RemoveChatMessageAsync (string channelId, string messageId)
	Remove a chat message from a chat channel on the server.
Task	RemoveMatchmakerAsync (IMatchmakerTicket ticket)
	Leave the matchmaker pool with the ticket.
Task	RemoveMatchmakerAsync (string ticket)
	Leave the matchmaker pool with the ticket contents.
Task	RemoveMatchmakerPartyAsync (string partyId, string ticket)
	Cancel a party matchmaking process using a ticket.
Task	RemovePartyMemberAsync (string partyId, IUserPresence presence)
	Kick a party member, or decline a request to join.
Task< IApiRpc >	RpcAsync (string funcId, string payload=null)
	Execute an RPC function to the server.
Task< IApiRpc >	RpcAsync (string funcId, ArraySegment< byte > payload)
	Execute an RPC function to the server.
Task	SendMatchStateAsync (string matchId, long opCode, string state, IEnumerable< IUserPresence > presences=null)
	Send input to a multiplayer match on the server.
Task	SendMatchStateAsync (string matchId, long opCode, ArraySegment< byte > state, IEnumerable< IUserPresence > presences=null)
	Send input to a multiplayer match on the server.
Task	SendMatchStateAsync (string matchId, long opCode, byte[] state, IEnumerable< IUserPresence > presences=null)
	Send input to a multiplayer match on the server.
Task	SendPartyDataAsync (string partyId, long opCode, ArraySegment< byte > data)
	Send data to a party.
Task	SendPartyDataAsync (string partyId, long opCode, string data)
	Send data to a party.
Task	SendPartyDataAsync (string partyId, long opCode, byte[] data)
	Send data to a party.
Task	UnfollowUsersAsync (IEnumerable< IApiUser > users)
	Unfollow one or more users from their status updates.
Task	UnfollowUsersAsync (IEnumerable< string > userIDs)
	Unfollow one or more users from their status updates.
Task< IChannelMessageAck >	UpdateChatMessageAsync (IChannel channel, string messageId, string content)
	Update a chat message on a chat channel in the server.
Task< IChannelMessageAck >	UpdateChatMessageAsync (string channelId, string messageId, string content)
	Update a chat message on a chat channel in the server.
Task< IPartyUpdate >	UpdatePartyAsync (string partyId, bool open, bool hidden, string label="")
	Update party label and optionally whether it is open or closed.
Task	UpdateStatusAsync (string status)
	Update the status for the current user online.
Task< IChannelMessageAck >	WriteChatMessageAsync (IChannel channel, string content)
	Send a chat message to a chat channel on the server.
Task< IChannelMessageAck >	WriteChatMessageAsync (string channelId, string content)
	Send a chat message to a chat channel on the server.

Properties
bool	IsConnected `[get]`
	If the socket is connected.
bool	IsConnecting `[get]`
	If the socket is connecting.

Events
Action	Closed
	Received when a socket is closed.
Action	Connected
	Received when a socket is connected.
Action< IApiChannelMessage >	ReceivedChannelMessage
	Received a chat channel message.
Action< IChannelPresenceEvent >	ReceivedChannelPresence
	Received a presence change for joins and leaves with users in a chat channel.
Action< Exception >	ReceivedError
	Received when an error occurs on the socket.
Action< IMatchmakerMatched >	ReceivedMatchmakerMatched
	Received a matchmaker matched message.
Action< IMatchState >	ReceivedMatchState
	Received a message from a multiplayer match.
Action< IMatchPresenceEvent >	ReceivedMatchPresence
	Received a presence change for joins and leaves of users in a multiplayer match.
Action< IApiNotification >	ReceivedNotification
	Received a notification for the current user.
Action< IParty >	ReceivedParty
	Received a party event. This will occur when the current user's invitation request is accepted by the party leader of a closed party.
Action< IPartyClose >	ReceivedPartyClose
	Received a party close event.
Action< IPartyData >	ReceivedPartyData
	Received custom party data.
Action< IPartyJoinRequest >	ReceivedPartyJoinRequest
	Received a request to join the party.
Action< IPartyLeader >	ReceivedPartyLeader
	Received a change in the party leader.
Action< IPartyMatchmakerTicket >	ReceivedPartyMatchmakerTicket
	Received a new matchmaker ticket for the party.
Action< IPartyPresenceEvent >	ReceivedPartyPresence
	Received a new presence event in the party.
Action< IPartyUpdate >	ReceivedPartyUpdate
	Received a party label and/or open/closed change.
Action< IStatusPresenceEvent >	ReceivedStatusPresence
	Received a presence change for when a user updated their online status.
Action< IStreamPresenceEvent >	ReceivedStreamPresence
	Received a presence change for joins and leaves on a realtime stream.
Action< IStreamState >	ReceivedStreamState
	Received a message from a realtime stream.

Detailed Description

A socket to interact with Nakama server.

Member Function Documentation

◆ AcceptPartyMemberAsync()

Task Nakama.ISocket.AcceptPartyMemberAsync	(	string	partyId,
		IUserPresence	presence )

Accept a party member's request to join the party.

Parameters

partyId	The party ID to accept the join request for.
presence	The presence to accept as a party member.

Returns: A task to represent the asynchronous operation.

Implemented in Nakama.Socket.

◆ AddMatchmakerAsync()

Task< IMatchmakerTicket > Nakama.ISocket.AddMatchmakerAsync	(	string	query = "*",
		int	minCount = 2,
		int	maxCount = 8,
		Dictionary< string, string >	stringProperties = null,
		Dictionary< string, double >	numericProperties = null,
		int?	countMultiple = null )

Join the matchmaker pool and search for opponents on the server.

Parameters

query	The matchmaker query to search for opponents.
minCount	The minimum number of players to compete against in a match.
maxCount	The maximum number of players to compete against in a match.
stringProperties	A set of key/value properties to provide to searches.
numericProperties	A set of key/value numeric properties to provide to searches.
countMultiple	An optional integer to force the matchmaker to match in multiples of.

Returns: A task which resolves to a matchmaker ticket object.

Implemented in Nakama.Socket.

◆ AddMatchmakerPartyAsync()

Task< IPartyMatchmakerTicket > Nakama.ISocket.AddMatchmakerPartyAsync	(	string	partyId,
		string	query,
		int	minCount,
		int	maxCount,
		Dictionary< string, string >	stringProperties = null,
		Dictionary< string, double >	numericProperties = null,
		int?	countMultiple = null )

Begin matchmaking as a party.

Parameters

partyId	Party ID.
query	Filter query used to identify suitable users.
minCount	Minimum total user count to match together.
maxCount	Maximum total user count to match together.
stringProperties	String properties.
numericProperties	Numeric properties.
countMultiple	An optional integer to force the matchmaker to match in multiples of.

Returns: A task which resolves to a party matchmaker ticket object.

Implemented in Nakama.Socket.

◆ CloseAsync()

Task Nakama.ISocket.CloseAsync ( )

Close the socket connection to the server.

Returns: A task to represent the asynchronous operation.

Implemented in Nakama.Socket.

◆ ClosePartyAsync()

Task Nakama.ISocket.ClosePartyAsync ( string partyId )

End a party, kicking all party members and closing it.

Parameters

partyId The ID of the party.

Returns: A task to represent the asynchronous operation.

Implemented in Nakama.Socket.

◆ ConnectAsync()

Task Nakama.ISocket.ConnectAsync	(	ISession	session,
		bool	appearOnline = false,
		int	connectTimeout = Socket.DefaultConnectTimeout,
		string	langTag = "en" )

Connect to the server.

Parameters

session	The session of the user.
appearOnline	If the user who appear online to other users.
connectTimeout	The time allowed for the socket connection to be established.
langTag	The language tag of the user on the connected socket.

Returns: A task to represent the asynchronous operation.

Implemented in Nakama.Socket.

◆ CreateMatchAsync()

Task< IMatch > Nakama.ISocket.CreateMatchAsync ( string matchName = null )

Create a multiplayer match on the server.

Returns: A task to represent the asynchronous operation.

Implemented in Nakama.Socket.

◆ CreatePartyAsync()

Task< IParty > Nakama.ISocket.CreatePartyAsync	(	bool	open,
		bool	hidden,
		int	maxSize,
		string	label = null )

Create a party.

Parameters

open	Whether the party will require join requests to be approved by the party leader.
hidden	Whether the party should be hidden from client listing.
maxSize	Maximum number of party members.
label	An optional label to set for party listing.

Returns: A task to represent the asynchronous operation.

Implemented in Nakama.Socket.

◆ FollowUsersAsync() [1/2]

Task< IStatus > Nakama.ISocket.FollowUsersAsync ( IEnumerable< IApiUser > users )

Subscribe to one or more users for their status updates.

Parameters

users The users.

Returns: A task which resolves to the current statuses for the users.

Implemented in Nakama.Socket.

◆ FollowUsersAsync() [2/2]

Task< IStatus > Nakama.ISocket.FollowUsersAsync	(	IEnumerable< string >	userIDs,
		IEnumerable< string >	usernames = null )

Subscribe to one or more users for their status updates.

Parameters

userIDs	The IDs of users.
usernames	The usernames of the users.

Returns: A task which resolves to the current statuses for the users.

Implemented in Nakama.Socket.

◆ JoinChatAsync()

Task< IChannel > Nakama.ISocket.JoinChatAsync	(	string	target,
		ChannelType	type,
		bool	persistence = false,
		bool	hidden = false )

Join a chat channel on the server.

Parameters

target	The target channel to join.
type	The type of channel to join.
persistence	If chat messages should be stored.
hidden	If the current user should be hidden on the channel.

Returns: A task which resolves to a chat channel object.

Implemented in Nakama.Socket.

◆ JoinMatchAsync() [1/2]

Task< IMatch > Nakama.ISocket.JoinMatchAsync ( IMatchmakerMatched matched )

Join a multiplayer match with the matchmaker matched object.

Parameters

matched A matchmaker matched object.

Returns: A task which resolves to a multiplayer match.

Implemented in Nakama.Socket.

◆ JoinMatchAsync() [2/2]

Task< IMatch > Nakama.ISocket.JoinMatchAsync	(	string	matchId,
		IDictionary< string, string >	metadata = null )

Join a multiplayer match by ID.

Parameters

matchId	The ID of the match to attempt to join.
metadata	An optional set of key-value metadata pairs to be passed to the match handler.

Returns: A task which resolves to a multiplayer match.

Implemented in Nakama.Socket.

◆ JoinPartyAsync()

Task Nakama.ISocket.JoinPartyAsync ( string partyId )

Join a party.

Parameters

partyId Party ID

Returns: A task to represent the asynchronous operation.

Implemented in Nakama.Socket.

◆ LeaveChatAsync() [1/2]

Task Nakama.ISocket.LeaveChatAsync ( IChannel channel )

Leave a chat channel on the server.

Parameters

channel The chat channel to leave.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ LeaveChatAsync() [2/2]

Task Nakama.ISocket.LeaveChatAsync ( string channelId )

Leave a chat channel on the server.

Parameters

channelId The ID of the chat channel to leave.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ LeaveMatchAsync() [1/2]

Task Nakama.ISocket.LeaveMatchAsync ( IMatch match )

Leave a multiplayer match on the server.

Parameters

match The multiplayer match to leave.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ LeaveMatchAsync() [2/2]

Task Nakama.ISocket.LeaveMatchAsync ( string matchId )

Leave a multiplayer match on the server.

Parameters

matchId The multiplayer match to leave.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ LeavePartyAsync()

Task Nakama.ISocket.LeavePartyAsync ( string partyId )

Leave the party.

Parameters

partyId Party ID.

Returns: A task to represent the asynchronous operation.

Implemented in Nakama.Socket.

◆ ListPartyJoinRequestsAsync()

Task< IPartyJoinRequest > Nakama.ISocket.ListPartyJoinRequestsAsync ( string partyId )

Request a list of pending join requests for a party.

Parameters

partyId Party ID.

Returns: A task which resolves to a list of all party join requests.

Implemented in Nakama.Socket.

◆ PromotePartyMemberAsync()

Task Nakama.ISocket.PromotePartyMemberAsync	(	string	partyId,
		IUserPresence	partyMember )

Promote a new party leader.

Parameters

partyId	Party ID.
partyMember	The presence of an existing party member to promote as the new leader.

Returns: A task which resolves to an announcement of a new party leader.

Implemented in Nakama.Socket.

◆ RemoveChatMessageAsync() [1/2]

Task< IChannelMessageAck > Nakama.ISocket.RemoveChatMessageAsync	(	IChannel	channel,
		string	messageId )

Remove a chat message from a chat channel on the server.

Parameters

channel	The chat channel with the message to remove.
messageId	The ID of the chat message to remove.

Returns: A task which resolves to an acknowledgement of the removed message.

Implemented in Nakama.Socket.

◆ RemoveChatMessageAsync() [2/2]

Task< IChannelMessageAck > Nakama.ISocket.RemoveChatMessageAsync	(	string	channelId,
		string	messageId )

Remove a chat message from a chat channel on the server.

Parameters

channelId	The ID of the chat channel with the message to remove.
messageId	The ID of the chat message to remove.

Returns: A task which resolves to an acknowledgement of the removed message.

Implemented in Nakama.Socket.

◆ RemoveMatchmakerAsync() [1/2]

Task Nakama.ISocket.RemoveMatchmakerAsync ( IMatchmakerTicket ticket )

Leave the matchmaker pool with the ticket.

Parameters

ticket The ticket returned by the matchmaker on join.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ RemoveMatchmakerAsync() [2/2]

Task Nakama.ISocket.RemoveMatchmakerAsync ( string ticket )

Leave the matchmaker pool with the ticket contents.

Parameters

ticket The contents of the ticket returned by the matchmaker on join.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ RemoveMatchmakerPartyAsync()

Task Nakama.ISocket.RemoveMatchmakerPartyAsync	(	string	partyId,
		string	ticket )

Cancel a party matchmaking process using a ticket.

Parameters

partyId	Party ID.
ticket	The ticket to cancel.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ RemovePartyMemberAsync()

Task Nakama.ISocket.RemovePartyMemberAsync	(	string	partyId,
		IUserPresence	presence )

Kick a party member, or decline a request to join.

Parameters

partyId	Party ID to remove/reject from.
presence	The presence to remove or reject.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ RpcAsync() [1/2]

Task< IApiRpc > Nakama.ISocket.RpcAsync	(	string	funcId,
		ArraySegment< byte >	payload )

Execute an RPC function to the server.

Parameters

funcId	The ID of the function to execute.
payload	An (optional) payload sent to the server from the byte buffer.

Returns: A task which resolves to the RPC function response object.

Implemented in Nakama.Socket.

◆ RpcAsync() [2/2]

Task< IApiRpc > Nakama.ISocket.RpcAsync	(	string	funcId,
		string	payload = null )

Execute an RPC function to the server.

Parameters

funcId	The ID of the function to execute.
payload	An (optional) payload to send to the server.

Returns: A task which resolves to the RPC function response object.

Implemented in Nakama.Socket.

◆ SendMatchStateAsync() [1/3]

Task Nakama.ISocket.SendMatchStateAsync	(	string	matchId,
		long	opCode,
		ArraySegment< byte >	state,
		IEnumerable< IUserPresence >	presences = null )

Send input to a multiplayer match on the server.

Parameters

matchId	The ID of the match.
opCode	An operation code for the input.
state	The input data to send from the byte buffer.
presences	The presences in the match who should receive the input.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ SendMatchStateAsync() [2/3]

Task Nakama.ISocket.SendMatchStateAsync	(	string	matchId,
		long	opCode,
		byte[]	state,
		IEnumerable< IUserPresence >	presences = null )

Send input to a multiplayer match on the server.

///

When no presences are supplied the new match state will be sent to all presences.

Parameters

matchId	The ID of the match.
opCode	An operation code for the input.
state	The input data to send.
presences	The presences in the match who should receive the input.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ SendMatchStateAsync() [3/3]

Task Nakama.ISocket.SendMatchStateAsync	(	string	matchId,
		long	opCode,
		string	state,
		IEnumerable< IUserPresence >	presences = null )

Send input to a multiplayer match on the server.

///

When no presences are supplied the new match state will be sent to all presences.

Parameters

matchId	The ID of the match.
opCode	An operation code for the input.
state	The input data to send.
presences	The presences in the match who should receive the input.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ SendPartyDataAsync() [1/3]

Task Nakama.ISocket.SendPartyDataAsync	(	string	partyId,
		long	opCode,
		ArraySegment< byte >	data )

Send data to a party.

Parameters

partyId	Party ID to send to.
opCode	Op code value.
data	The input data to send from the byte buffer, if any.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ SendPartyDataAsync() [2/3]

Task Nakama.ISocket.SendPartyDataAsync	(	string	partyId,
		long	opCode,
		byte[]	data )

Send data to a party.

Parameters

partyId	Party ID to send to.
opCode	Op code value.
data	Data payload, if any.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ SendPartyDataAsync() [3/3]

Task Nakama.ISocket.SendPartyDataAsync	(	string	partyId,
		long	opCode,
		string	data )

Send data to a party.

Parameters

partyId	Party ID to send to.
opCode	Op code value.
data	Data payload, if any.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ UnfollowUsersAsync() [1/2]

Task Nakama.ISocket.UnfollowUsersAsync ( IEnumerable< IApiUser > users )

Unfollow one or more users from their status updates.

Parameters

users The users to unfollow.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ UnfollowUsersAsync() [2/2]

Task Nakama.ISocket.UnfollowUsersAsync ( IEnumerable< string > userIDs )

Unfollow one or more users from their status updates.

Parameters

userIDs The IDs of the users to unfollow.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ UpdateChatMessageAsync() [1/2]

Task< IChannelMessageAck > Nakama.ISocket.UpdateChatMessageAsync	(	IChannel	channel,
		string	messageId,
		string	content )

Update a chat message on a chat channel in the server.

Parameters

channel	The chat channel with the message to update.
messageId	The ID of the message to update.
content	The new contents of the chat message.

Returns: A task which resolves to an acknowledgement of the updated message.

Implemented in Nakama.Socket.

◆ UpdateChatMessageAsync() [2/2]

Task< IChannelMessageAck > Nakama.ISocket.UpdateChatMessageAsync	(	string	channelId,
		string	messageId,
		string	content )

Update a chat message on a chat channel in the server.

Parameters

channelId	The ID of the chat channel with the message to update.
messageId	The ID of the message to update.
content	The new contents of the chat message.

Returns: A task which resolves to an acknowledgement of the updated message.

Implemented in Nakama.Socket.

◆ UpdatePartyAsync()

Task< IPartyUpdate > Nakama.ISocket.UpdatePartyAsync	(	string	partyId,
		bool	open,
		bool	hidden,
		string	label = "" )

Update party label and optionally whether it is open or closed.

Parameters

partyId	The Party ID.
open	Whether the party is open or closed.
hidden	Whether the party should be hidden from client listing.
label	The new custom label to set to the party.

Returns

Implemented in Nakama.Socket.

◆ UpdateStatusAsync()

Task Nakama.ISocket.UpdateStatusAsync ( string status )

Update the status for the current user online.

Parameters

status The new status for the user.

Returns: A task which represents the asynchronous operation.

Implemented in Nakama.Socket.

◆ WriteChatMessageAsync() [1/2]

Task< IChannelMessageAck > Nakama.ISocket.WriteChatMessageAsync	(	IChannel	channel,
		string	content )

Send a chat message to a chat channel on the server.

Parameters

channel	The chat channel to send onto.
content	The contents of the message to send.

Returns: A task which resolves to the acknowledgement of the chat message write.

Implemented in Nakama.Socket.

◆ WriteChatMessageAsync() [2/2]

Task< IChannelMessageAck > Nakama.ISocket.WriteChatMessageAsync	(	string	channelId,
		string	content )

Send a chat message to a chat channel on the server.

Parameters

channelId	The ID of the chat channel to send onto.
content	The contents of the message to send.

Returns: A task which resolves to the acknowledgement of the chat message write.

Implemented in Nakama.Socket.

Property Documentation

◆ IsConnected

bool Nakama.ISocket.IsConnected

get

If the socket is connected.

Implemented in Nakama.Socket.

◆ IsConnecting

bool Nakama.ISocket.IsConnecting

get

If the socket is connecting.

Implemented in Nakama.Socket.

Event Documentation

◆ Closed

Action Nakama.ISocket.Closed

Received when a socket is closed.

◆ Connected

Action Nakama.ISocket.Connected

Received when a socket is connected.

◆ ReceivedChannelMessage

Action<IApiChannelMessage> Nakama.ISocket.ReceivedChannelMessage

Received a chat channel message.

◆ ReceivedChannelPresence

Action<IChannelPresenceEvent> Nakama.ISocket.ReceivedChannelPresence

Received a presence change for joins and leaves with users in a chat channel.

◆ ReceivedError

Action<Exception> Nakama.ISocket.ReceivedError

Received when an error occurs on the socket.

◆ ReceivedMatchmakerMatched

Action<IMatchmakerMatched> Nakama.ISocket.ReceivedMatchmakerMatched

Received a matchmaker matched message.

◆ ReceivedMatchPresence

Action<IMatchPresenceEvent> Nakama.ISocket.ReceivedMatchPresence

Received a presence change for joins and leaves of users in a multiplayer match.

◆ ReceivedMatchState

Action<IMatchState> Nakama.ISocket.ReceivedMatchState

Received a message from a multiplayer match.

◆ ReceivedNotification

Action<IApiNotification> Nakama.ISocket.ReceivedNotification

Received a notification for the current user.

◆ ReceivedParty

Action<IParty> Nakama.ISocket.ReceivedParty

Received a party event. This will occur when the current user's invitation request is accepted by the party leader of a closed party.

◆ ReceivedPartyClose

Action<IPartyClose> Nakama.ISocket.ReceivedPartyClose

Received a party close event.

◆ ReceivedPartyData

Action<IPartyData> Nakama.ISocket.ReceivedPartyData

Received custom party data.

◆ ReceivedPartyJoinRequest

Action<IPartyJoinRequest> Nakama.ISocket.ReceivedPartyJoinRequest

Received a request to join the party.

◆ ReceivedPartyLeader

Action<IPartyLeader> Nakama.ISocket.ReceivedPartyLeader

Received a change in the party leader.

◆ ReceivedPartyMatchmakerTicket

Action<IPartyMatchmakerTicket> Nakama.ISocket.ReceivedPartyMatchmakerTicket

Received a new matchmaker ticket for the party.

◆ ReceivedPartyPresence

Action<IPartyPresenceEvent> Nakama.ISocket.ReceivedPartyPresence

Received a new presence event in the party.

◆ ReceivedPartyUpdate

Action<IPartyUpdate> Nakama.ISocket.ReceivedPartyUpdate

Received a party label and/or open/closed change.

◆ ReceivedStatusPresence

Action<IStatusPresenceEvent> Nakama.ISocket.ReceivedStatusPresence

Received a presence change for when a user updated their online status.

◆ ReceivedStreamPresence

Action<IStreamPresenceEvent> Nakama.ISocket.ReceivedStreamPresence

Received a presence change for joins and leaves on a realtime stream.

◆ ReceivedStreamState

Action<IStreamState> Nakama.ISocket.ReceivedStreamState

Received a message from a realtime stream.

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

ISocket.cs

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ AcceptPartyMemberAsync()

◆ AddMatchmakerAsync()

◆ AddMatchmakerPartyAsync()

◆ CloseAsync()

◆ ClosePartyAsync()

◆ ConnectAsync()

◆ CreateMatchAsync()

◆ CreatePartyAsync()

◆ FollowUsersAsync() [1/2]

◆ FollowUsersAsync() [2/2]

◆ JoinChatAsync()

◆ JoinMatchAsync() [1/2]

◆ JoinMatchAsync() [2/2]

◆ JoinPartyAsync()

◆ LeaveChatAsync() [1/2]

◆ LeaveChatAsync() [2/2]

◆ LeaveMatchAsync() [1/2]

◆ LeaveMatchAsync() [2/2]

◆ LeavePartyAsync()

◆ ListPartyJoinRequestsAsync()

◆ PromotePartyMemberAsync()

◆ RemoveChatMessageAsync() [1/2]

◆ RemoveChatMessageAsync() [2/2]

◆ RemoveMatchmakerAsync() [1/2]

◆ RemoveMatchmakerAsync() [2/2]

◆ RemoveMatchmakerPartyAsync()

◆ RemovePartyMemberAsync()

◆ RpcAsync() [1/2]

◆ RpcAsync() [2/2]

◆ SendMatchStateAsync() [1/3]

◆ SendMatchStateAsync() [2/3]

◆ SendMatchStateAsync() [3/3]

◆ SendPartyDataAsync() [1/3]

◆ SendPartyDataAsync() [2/3]

◆ SendPartyDataAsync() [3/3]

◆ UnfollowUsersAsync() [1/2]

◆ UnfollowUsersAsync() [2/2]

◆ UpdateChatMessageAsync() [1/2]

◆ UpdateChatMessageAsync() [2/2]

◆ UpdatePartyAsync()

◆ UpdateStatusAsync()

◆ WriteChatMessageAsync() [1/2]

◆ WriteChatMessageAsync() [2/2]

Property Documentation

◆ IsConnected

◆ IsConnecting

Event Documentation

◆ Closed

◆ Connected

◆ ReceivedChannelMessage

◆ ReceivedChannelPresence

◆ ReceivedError

◆ ReceivedMatchmakerMatched

◆ ReceivedMatchPresence

◆ ReceivedMatchState

◆ ReceivedNotification

◆ ReceivedParty

◆ ReceivedPartyClose

◆ ReceivedPartyData

◆ ReceivedPartyJoinRequest

◆ ReceivedPartyLeader

◆ ReceivedPartyMatchmakerTicket

◆ ReceivedPartyPresence

◆ ReceivedPartyUpdate

◆ ReceivedStatusPresence

◆ ReceivedStreamPresence

◆ ReceivedStreamState