Photon .NET Client API
Public Member Functions | Public Attributes | Properties | List of all members
ExitGames.Client.Photon.Chat.ChatChannel Class Reference

A channel of communication in Photon Chat, updated by ChatClient and provided as READ ONLY. More...

Public Member Functions

 ChatChannel (string name)
 Used internally to create new channels. This does NOT create a channel on the server! Use ChatClient.Subscribe. More...
 
void Add (string sender, object message)
 Used internally to add messages to this channel. More...
 
void Add (string[] senders, object[] messages)
 Used internally to add messages to this channel. More...
 
void ClearMessages ()
 Clear the local cache of messages currently stored. This frees memory but doesn't affect the server. More...
 
string ToStringMessages ()
 

Public Attributes

readonly string Name
 Name of the channel (used to subscribe and unsubscribe). More...
 
readonly List< string > Senders = new List<string>()
 Senders of messages in chronoligical order. Senders and Messages refer to each other by index. Senders[x] is the sender of Messages[x]. More...
 
readonly List< object > Messages = new List<object>()
 Messages in chronoligical order. Senders and Messages refer to each other by index. Senders[x] is the sender of Messages[x]. More...
 

Properties

bool IsPrivate [get, set]
 Is this a private 1:1 channel? More...
 
int MessageCount [get]
 Count of messages this client still buffers/knows for this channel. More...
 

Detailed Description

A channel of communication in Photon Chat, updated by ChatClient and provided as READ ONLY.

Contains messages and senders to use (read!) and display by your GUI. Access these by: ChatClient.PublicChannels ChatClient.PrivateChannels

Constructor & Destructor Documentation

ExitGames.Client.Photon.Chat.ChatChannel.ChatChannel ( string  name)
inline

Used internally to create new channels. This does NOT create a channel on the server! Use ChatClient.Subscribe.

Member Function Documentation

void ExitGames.Client.Photon.Chat.ChatChannel.Add ( string  sender,
object  message 
)
inline

Used internally to add messages to this channel.

void ExitGames.Client.Photon.Chat.ChatChannel.Add ( string[]  senders,
object[]  messages 
)
inline

Used internally to add messages to this channel.

void ExitGames.Client.Photon.Chat.ChatChannel.ClearMessages ( )
inline

Clear the local cache of messages currently stored. This frees memory but doesn't affect the server.

string ExitGames.Client.Photon.Chat.ChatChannel.ToStringMessages ( )
inline

Member Data Documentation

readonly List<object> ExitGames.Client.Photon.Chat.ChatChannel.Messages = new List<object>()

Messages in chronoligical order. Senders and Messages refer to each other by index. Senders[x] is the sender of Messages[x].

readonly string ExitGames.Client.Photon.Chat.ChatChannel.Name

Name of the channel (used to subscribe and unsubscribe).

readonly List<string> ExitGames.Client.Photon.Chat.ChatChannel.Senders = new List<string>()

Senders of messages in chronoligical order. Senders and Messages refer to each other by index. Senders[x] is the sender of Messages[x].

Property Documentation

bool ExitGames.Client.Photon.Chat.ChatChannel.IsPrivate
getset

Is this a private 1:1 channel?

int ExitGames.Client.Photon.Chat.ChatChannel.MessageCount
get

Count of messages this client still buffers/knows for this channel.


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