ChatParameterCode Class Reference

Wraps up codes for parameters (in operations and events) used internally in Photon Chat. You don't have to use them directly usually. More...

Public Attributes
const byte	Channels = 0
	(0) Array of chat channels. More...
const byte	Channel = 1
	(1) Name of a single chat channel. More...
const byte	Messages = 2
	(2) Array of chat messages. More...
const byte	Message = 3
	(3) A single chat message. More...
const byte	Senders = 4
	(4) Array of names of the users who sent the array of chat messages. More...
const byte	Sender = 5
	(5) Name of a the user who sent a chat message. More...
const byte	ChannelUserCount = 6
	(6) Not used. More...
const byte	UserId = 225
	(225) Name of user to send a (private) message to. More...
const byte	MsgId = 8
	(8) Id of a message. More...
const byte	MsgIds = 9
	(9) Not used. More...
const byte	Secret = 221
	(221) Secret token to identify an authorized user. More...
const byte	SubscribeResults = 15
	(15) Subscribe operation result parameter. A bool[] with result per channel. More...
const byte	Status = 10
	(10) Status More...
const byte	Friends = 11
	(11) Friends More...
const byte	SkipMessage = 12
	(12) SkipMessage is used in SetOnlineStatus and if true, the message is not being broadcast. More...
const byte	HistoryLength = 14
	(14) Number of message to fetch from history. 0: no history. 1 and higher: number of messages in history. -1: all history. More...
const byte	WebFlags = 21
	(21) WebFlags object for changing behaviour of webhooks from client. More...
const byte	Properties = 22
	(22) Properties of channel or user. More...
const byte	ChannelSubscribers = 23
	(23) Array of UserIds of users already subscribed to a channel. More...

Detailed Description

Wraps up codes for parameters (in operations and events) used internally in Photon Chat. You don't have to use them directly usually.

Member Data Documentation

const byte Channel = 1

(1) Name of a single chat channel.

const byte Channels = 0

(0) Array of chat channels.

const byte ChannelSubscribers = 23

(23) Array of UserIds of users already subscribed to a channel.

Used in Subscribe event when PublishSubscribers is enabled. Does not include local user who just subscribed. Maximum length is (ChatChannel.MaxSubscribers - 1).

const byte ChannelUserCount = 6

(6) Not used.

const byte Friends = 11

(11) Friends

const byte HistoryLength = 14

(14) Number of message to fetch from history. 0: no history. 1 and higher: number of messages in history. -1: all history.

const byte Message = 3

(3) A single chat message.

const byte Messages = 2

(2) Array of chat messages.

const byte MsgId = 8

(8) Id of a message.

const byte MsgIds = 9

(9) Not used.

const byte Properties = 22

(22) Properties of channel or user.

In event ChatEventCode.Subscribe it's always channel properties.

const byte Secret = 221

(221) Secret token to identify an authorized user.

The code is used in LoadBalancing and copied over here.

const byte Sender = 5

(5) Name of a the user who sent a chat message.

const byte Senders = 4

(4) Array of names of the users who sent the array of chat messages.

const byte SkipMessage = 12

(12) SkipMessage is used in SetOnlineStatus and if true, the message is not being broadcast.

const byte Status = 10

(10) Status

const byte SubscribeResults = 15

(15) Subscribe operation result parameter. A bool[] with result per channel.

const byte UserId = 225

(225) Name of user to send a (private) message to.

The code is used in LoadBalancing and copied over here.

const byte WebFlags = 21

(21) WebFlags object for changing behaviour of webhooks from client.