Core.Platform.SDK.Chat.ChatProvider Class Reference

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

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

Public Member Functions
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...
abstract Promise< Room >	CreatePrivateRoom (List< long > gamerTags)
	Ask the provider to create a private room consisting of the provided list of players. More...

Protected Member Functions
void	AddRoom (Room room)
string	CreateRoomNameFromGamerTags (IEnumerable< long > gamerTags)
abstract Promise< Unit >	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...
abstract Promise< List< Room > >	FetchMyRooms ()
	Return the list of rooms the currently connected player has access to. More...

Protected Attributes
PlatformService	Platform

Properties
List< Room >	MyRooms [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< Room >	DirectMessageRooms [get]
	Return this player's direct messages. More...
List< Room >	AlwaysSubscribedRooms [get]
	Return all of the rooms the client should join immediately (and never leave). More...

Member Function Documentation

Connect()

abstract Promise<Unit> Core.Platform.SDK.Chat.ChatProvider.Connect ( )

protectedpure virtual

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.

Implemented in Core.Platform.SDK.Chat.PubNubChatProvider.

CreatePrivateRoom()

abstract Promise<Room> Core.Platform.SDK.Chat.ChatProvider.CreatePrivateRoom ( List< long >  gamerTags )

pure virtual

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

Parameters

gamerTags

GamerTags of players who should be in the room.

Implemented in Core.Platform.SDK.Chat.PubNubChatProvider.

FetchMyRooms()

abstract Promise<List<Room> > Core.Platform.SDK.Chat.ChatProvider.FetchMyRooms ( )

protectedpure virtual

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

Implemented in Core.Platform.SDK.Chat.PubNubChatProvider.

Initialize()

void Core.Platform.SDK.Chat.ChatProvider.Initialize ( PlatformService  platform )

inline

Initializes the ChatProvider. This should connect to the service and populate the list of rooms accessible to the user.

Parameters

platform

SubstituteEmoji()

string Core.Platform.SDK.Chat.ChatProvider.SubstituteEmoji ( string  original )

inline

Replaces :shortcode: emoji instances with TMP rich sprite tags.

Parameters

original

The unaltered string

Property Documentation

AlwaysSubscribedRooms

List<Room> Core.Platform.SDK.Chat.ChatProvider.AlwaysSubscribedRooms

get

Return all of the rooms the client should join immediately (and never leave).

DirectMessageRooms

List<Room> Core.Platform.SDK.Chat.ChatProvider.DirectMessageRooms

get

Return this player's direct messages.

GeneralRoom

Room Core.Platform.SDK.Chat.ChatProvider.GeneralRoom

get

Return the general room for this game.

GuildRoom

Room Core.Platform.SDK.Chat.ChatProvider.GuildRoom

get

Return the guild room if the player is in a guild. Otherwise, this will return null.

MyRooms

List<Room> Core.Platform.SDK.Chat.ChatProvider.MyRooms

get

Return the full list of rooms this player has access to.

---

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

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