A channel of communication in Photon Chat, updated by ChatClient and provided as READ ONLY.
More...
|
| 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, int msgId) |
| Used internally to add messages to this channel. More...
|
|
void | Add (string[] senders, object[] messages, int lastMsgId) |
| Used internally to add messages to this channel. More...
|
|
void | TruncateMessages () |
| Reduces the number of locally cached messages in this channel to the MessageLimit (if set). More...
|
|
void | ClearMessages () |
| Clear the local cache of messages currently stored. This frees memory but doesn't affect the server. More...
|
|
string | ToStringMessages () |
| Provides a string-representation of all messages in this channel. More...
|
|
|
readonly string | Name |
| Name of the channel (used to subscribe and unsubscribe). More...
|
|
readonly List< string > | Senders = new List<string>() |
| Senders of messages in chronological 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 chronological order. Senders and Messages refer to each other by index. Senders[x] is the sender of Messages[x]. More...
|
|
int | MessageLimit |
| If greater than 0, this channel will limit the number of messages, that it caches locally. More...
|
|
int | ChannelID |
| Unique channel ID. More...
|
|
readonly HashSet< string > | Subscribers = new HashSet<string>() |
| Subscribed users. More...
|
|
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
◆ ChatChannel()
Used internally to create new channels. This does NOT create a channel on the server! Use ChatClient.Subscribe.
◆ Add() [1/2]
void Add |
( |
string |
sender, |
|
|
object |
message, |
|
|
int |
msgId |
|
) |
| |
Used internally to add messages to this channel.
◆ Add() [2/2]
void Add |
( |
string[] |
senders, |
|
|
object[] |
messages, |
|
|
int |
lastMsgId |
|
) |
| |
Used internally to add messages to this channel.
◆ ClearMessages()
Clear the local cache of messages currently stored. This frees memory but doesn't affect the server.
◆ ToStringMessages()
string ToStringMessages |
( |
| ) |
|
Provides a string-representation of all messages in this channel.
- Returns
- All known messages in format "Sender: Message", line by line.
◆ TruncateMessages()
void TruncateMessages |
( |
| ) |
|
Reduces the number of locally cached messages in this channel to the MessageLimit (if set).
◆ ChannelID
◆ MessageLimit
If greater than 0, this channel will limit the number of messages, that it caches locally.
◆ Messages
readonly List<object> Messages = new List<object>() |
Messages in chronological order. Senders and Messages refer to each other by index. Senders[x] is the sender of Messages[x].
◆ Name
Name of the channel (used to subscribe and unsubscribe).
◆ Senders
readonly List<string> Senders = new List<string>() |
Senders of messages in chronological order. Senders and Messages refer to each other by index. Senders[x] is the sender of Messages[x].
◆ Subscribers
readonly HashSet<string> Subscribers = new HashSet<string>() |
◆ IsPrivate
Is this a private 1:1 channel?
◆ LastMsgId
ID of the last message received.
◆ MaxSubscribers
Maximum number of channel subscribers. 0 means infinite.
◆ MessageCount
Count of messages this client still buffers/knows for this channel.
◆ PublishSubscribers
Whether or not this channel keeps track of the list of its subscribers.