Core.Platform.SDK.Chat.PubNubRoom Class Reference

Inheritance diagram for Core.Platform.SDK.Chat.PubNubRoom:

Collaboration diagram for Core.Platform.SDK.Chat.PubNubRoom:

Public Member Functions
	PubNubRoom (RoomInfo roomInfo)
override Promise	Sync ()
	Synchronize the local representation of the room to the server state. More...
override Promise< Message >	SendMessage (string message)
	Send a message to this room. More...
override Promise< Room >	Join (OnMessageReceivedDelegate callback=null)
	Join this room. After this call is successful, this player should start receiving messages for this room. Parameters callback Associated callback when a message is received for this room. More...
override Promise< Room >	Leave ()
	Leave this room. After this call is successful, this player no longer receive messages for this room. More...
override Promise< Room >	Forget ()
	Forget this room. This leaves the room and also removes it from saved rooms so it is no longer known More...
Public Member Functions inherited from Core.Platform.SDK.Chat.Room
bool	ContainsMessage (Message message)
void	MessageReceived (Message message)
	Adds a new message to this room. Will also invoke the _onMessageReceived callback if one is defined. Parameters message The message to add to this room. More...

Additional Inherited Members
Public Attributes inherited from Core.Platform.SDK.Chat.Room
readonly string	Id
readonly string	Name
readonly bool	KeepSubscribed
readonly List< Message >	Messages
Protected Member Functions inherited from Core.Platform.SDK.Chat.Room
	Room (string id, string name, bool keepSubscribed, bool filterFromBlocked)
void	MessageSent (Message message)
	Adds a new message to this room. This will not invoke the _onMessageReceived callback. Parameters message The message to add to this room. More...
Properties inherited from Core.Platform.SDK.Chat.Room
bool	FilterMessagesFromBlockedPlayers [get, set]

Member Function Documentation

Forget()

override Promise<Room> Core.Platform.SDK.Chat.PubNubRoom.Forget ( )

inlinevirtual

Forget this room. This leaves the room and also removes it from saved rooms so it is no longer known

Reimplemented from Core.Platform.SDK.Chat.Room.

Join()

override Promise<Room> Core.Platform.SDK.Chat.PubNubRoom.Join ( OnMessageReceivedDelegate  callback = null )

inlinevirtual

Join this room. After this call is successful, this player should start receiving messages for this room.

Parameters

callback

Associated callback when a message is received for this room.

Reimplemented from Core.Platform.SDK.Chat.Room.

Leave()

override Promise<Room> Core.Platform.SDK.Chat.PubNubRoom.Leave ( )

inlinevirtual

Leave this room. After this call is successful, this player no longer receive messages for this room.

Reimplemented from Core.Platform.SDK.Chat.Room.

SendMessage()

override Promise<Message> Core.Platform.SDK.Chat.PubNubRoom.SendMessage ( string  message )

inlinevirtual

Send a message to this room.

Parameters

message

Content of the message.

Implements Core.Platform.SDK.Chat.Room.

Sync()

override Promise Core.Platform.SDK.Chat.PubNubRoom.Sync ( )

inlinevirtual

Synchronize the local representation of the room to the server state.

Implements Core.Platform.SDK.Chat.Room.

---

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

• client/Packages/com.disruptorbeam.engine/Runtime/Core/Platform/SDK/Chat/PubNubRoom.cs