Beamable SDK
Public Member Functions | Protected Member Functions | List of all members
Core.Platform.SDK.Chat.PubNubChatProvider Class Reference
Inheritance diagram for Core.Platform.SDK.Chat.PubNubChatProvider:
Inheritance graph
[legend]
Collaboration diagram for Core.Platform.SDK.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 Core.Platform.SDK.Chat.ChatProvider
void Initialize (PlatformService platform)
 Initializes the ChatProvider. This should connect to the service and populate the list of rooms accessible to the user. More...
 
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 Core.Platform.SDK.Chat.ChatProvider
void AddRoom (Room room)
 
string CreateRoomNameFromGamerTags (IEnumerable< long > gamerTags)
 

Additional Inherited Members

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

Member Function Documentation

◆ Connect()

override Promise Core.Platform.SDK.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 Core.Platform.SDK.Chat.ChatProvider.

◆ CreatePrivateRoom()

override Promise<Room> Core.Platform.SDK.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 Core.Platform.SDK.Chat.ChatProvider.

◆ FetchMyRooms()

override Promise<List<Room> > Core.Platform.SDK.Chat.PubNubChatProvider.FetchMyRooms ( )
inlineprotectedvirtual

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

Implements Core.Platform.SDK.Chat.ChatProvider.


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