Beamable SDK
Public Member Functions | List of all members
Beamable.Experimental.Api.Chat.PubNubRoom Class Reference
Inheritance diagram for Beamable.Experimental.Api.Chat.PubNubRoom:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Experimental.Api.Chat.PubNubRoom:
Collaboration graph
[legend]

Public Member Functions

 PubNubRoom (RoomInfo roomInfo, IDependencyProvider provider)
 
override Promise Sync ()
 Synchronize the local representation of the room to the server state. More...
 
override Promise< MessageSendMessage (string message)
 Send a message to this room. More...
 
override Promise< RoomJoin (OnMessageReceivedDelegate callback=null)
 Join this room. After this call is successful, this player should start receiving messages for this room.

Parameters
callbackAssociated callback when a message is received for this room.
More...
 
override Promise< RoomLeave ()
 Leave this room. After this call is successful, this player no longer receive messages for this room. More...
 
override Promise< RoomForget ()
 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 Beamable.Experimental.Api.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
messageThe message to add to this room.

 

Additional Inherited Members

- Public Attributes inherited from Beamable.Experimental.Api.Chat.Room
readonly string Id
 
readonly string Name
 
readonly bool KeepSubscribed
 
readonly List< MessageMessages
 
- Protected Member Functions inherited from Beamable.Experimental.Api.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
messageThe message to add to this room.

 
- Properties inherited from Beamable.Experimental.Api.Chat.Room
bool FilterMessagesFromBlockedPlayers [getset]
 

Member Function Documentation

◆ Forget()

override Promise< Room > Beamable.Experimental.Api.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 Beamable.Experimental.Api.Chat.Room.

◆ Join()

override Promise< Room > Beamable.Experimental.Api.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
callbackAssociated callback when a message is received for this room.

Reimplemented from Beamable.Experimental.Api.Chat.Room.

◆ Leave()

override Promise< Room > Beamable.Experimental.Api.Chat.PubNubRoom.Leave ( )
inlinevirtual

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

Reimplemented from Beamable.Experimental.Api.Chat.Room.

◆ SendMessage()

override Promise< Message > Beamable.Experimental.Api.Chat.PubNubRoom.SendMessage ( string  message)
inlinevirtual

Send a message to this room.

Parameters
messageContent of the message.

Implements Beamable.Experimental.Api.Chat.Room.

◆ Sync()

override Promise Beamable.Experimental.Api.Chat.PubNubRoom.Sync ( )
inlinevirtual

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

Implements Beamable.Experimental.Api.Chat.Room.


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