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

Public Member Functions

override Promise< RoomCreatePrivateRoom (List< long > gamerTags)
 Ask the provider to create a private room consisting of the provided list of players. More...
 
- Public Member Functions inherited from Beamable.Experimental.Api.Chat.ChatProvider
void Initialize (IDependencyProvider provider)
 Initializes the ChatProvider. This should connect to the service and populate the list of rooms accessible to the user.
 
Promise< List< Room > > FetchAndUpdateRooms ()
 
void AddOnRoomAdded (OnRoomAddedDelegate callback)
 
string SubstituteEmoji (string original)
 Replaces :shortcode: emoji instances with TMP rich sprite tags. More...
 

Protected Member Functions

override Promise Connect ()
 Create a connection to the chat provider. This will be called when the ChatManager is initialized. The rest of the methods in this interface depend on a successfully connected player. More...
 
override Promise< List< Room > > FetchMyRooms ()
 Return the list of rooms the currently connected player has access to. More...
 
- Protected Member Functions inherited from Beamable.Experimental.Api.Chat.ChatProvider
void AddRoom (Room room)
 
string CreateRoomNameFromGamerTags (IEnumerable< long > gamerTags)
 

Properties

ChatService Chat [get]
 
- Properties inherited from Beamable.Experimental.Api.Chat.ChatProvider
INotificationService NotificationService [get]
 
List< RoomMyRooms [get]
 Return the full list of rooms this player has access to.
 
Room GeneralRoom [get]
 Return the general room for this game.
 
Room GuildRoom [get]
 Return the guild room if the player is in a guild. Otherwise, this will return null.
 
List< RoomDirectMessageRooms [get]
 Return this player's direct messages.
 
List< RoomAlwaysSubscribedRooms [get]
 Return all of the rooms the client should join immediately (and never leave).
 

Additional Inherited Members

- Protected Attributes inherited from Beamable.Experimental.Api.Chat.ChatProvider
IDependencyProvider Provider
 

Member Function Documentation

◆ Connect()

override Promise Beamable.Experimental.Api.Chat.PubNubChatProvider.Connect ( )
inlineprotectedvirtual

Create a connection to the chat provider. This will be called when the ChatManager is initialized. The rest of the methods in this interface depend on a successfully connected player.

Implements Beamable.Experimental.Api.Chat.ChatProvider.

◆ CreatePrivateRoom()

override Promise< Room > Beamable.Experimental.Api.Chat.PubNubChatProvider.CreatePrivateRoom ( List< long >  gamerTags)
inlinevirtual

Ask the provider to create a private room consisting of the provided list of players.

Parameters
gamerTagsGamerTags of players who should be in the room.

Implements Beamable.Experimental.Api.Chat.ChatProvider.

◆ FetchMyRooms()

override Promise< List< Room > > Beamable.Experimental.Api.Chat.PubNubChatProvider.FetchMyRooms ( )
inlineprotectedvirtual

Return the list of rooms the currently connected player has access to.

Implements Beamable.Experimental.Api.Chat.ChatProvider.


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