Beamable.Experimental.Api.Chat.Room Class Reference

Inheritance diagram for Beamable.Experimental.Api.Chat.Room:

Public Member Functions
bool	ContainsMessage (Message message)
abstract Promise	Sync ()
	Synchronize the local representation of the room to the server state. More...
abstract Promise< Message >	SendMessage (string message)
	Send a message to this room. More...
virtual 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...
virtual Promise< Room >	Leave ()
	Leave this room. After this call is successful, this player no longer receive messages for this room. More...
virtual Promise< Room >	Forget ()
	Forget this room. This leaves the room and also removes it from saved rooms so it is no longer known More...
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...

Public Attributes
readonly string	Id
readonly string	Name
readonly bool	KeepSubscribed
readonly List< Message >	Messages

Protected Member Functions
	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
bool	FilterMessagesFromBlockedPlayers [get, set]

Member Function Documentation

Forget()

virtual Promise<Room> Beamable.Experimental.Api.Chat.Room.Forget ( )

inlinevirtual

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

Reimplemented in Beamable.Experimental.Api.Chat.PubNubRoom.

Join()

virtual Promise<Room> Beamable.Experimental.Api.Chat.Room.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 in Beamable.Experimental.Api.Chat.PubNubRoom.

Leave()

virtual Promise<Room> Beamable.Experimental.Api.Chat.Room.Leave ( )

inlinevirtual

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

Reimplemented in Beamable.Experimental.Api.Chat.PubNubRoom.

MessageReceived()

void Beamable.Experimental.Api.Chat.Room.MessageReceived ( Message  message )

inline

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.

MessageSent()

void Beamable.Experimental.Api.Chat.Room.MessageSent ( Message  message )

inlineprotected

Adds a new message to this room. This will not invoke the _onMessageReceived callback.

Parameters

message

The message to add to this room.

SendMessage()

abstract Promise<Message> Beamable.Experimental.Api.Chat.Room.SendMessage ( string  message )

pure virtual

Send a message to this room.

Parameters

message

Content of the message.

Implemented in Beamable.Experimental.Api.Chat.PubNubRoom.

Sync()

abstract Promise Beamable.Experimental.Api.Chat.Room.Sync ( )

pure virtual

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

Implemented in Beamable.Experimental.Api.Chat.PubNubRoom.

---

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

• client/Packages/com.beamable/Runtime/Core/Platform/SDK/Chat/Room.cs