Photon Unity Networking: ExitGames.Client.Photon.Chat.ChatClient Class Reference

Adds friends to a list on the Chat Server which will send you status updates for those.

AddFriends and RemoveFriends enable clients to handle their friend list in the Photon Chat server. Having users on your friends list gives you access to their current online status (and whatever info your client sets in it).

Each user can set an online status consisting of an integer and an arbitratry (serializable) object. The object can be null, Hashtable, object[] or anything else Photon can serialize.

The status is published automatically to friends (anyone who set your user ID with AddFriends).

Photon flushes friends-list when a chat client disconnects, so it has to be set each time. If your community API gives you access to online status already, you could filter and set online friends in AddFriends.

Actual friend relations are not persistent and have to be stored outside of Photon.

Parameters

friends

Array of friend userIds.

Returns

If the operation could be sent.

Connects this client to the Photon Chat Cloud service, which will also authenticate the user (and set a UserId).

Parameters

appId	Get your Photon Chat AppId from the Dashboard.
appVersion	Any version string you make up. Used to separate users and variants of your clients, which might be incompatible.
authValues	Values for authentication. You can leave this null, if you set a UserId before. If you set authValues, they will override any UserId set before.

Returns

Get you the (locally used) channel name for the chat between this client and another user.

Parameters

userName

Remote user's name or UserId.

Returns

The (locally used) channel name for a private channel.

Sends a message to a public channel which this client subscribed to.

Before you publish to a channel, you have to subscribe it. Everyone in that channel will get the message.

Parameters

channelName	Name of the channel to publish to.
message	Your message (string or any serializable data).

Returns

False if the client is not yet ready to send messages.

Removes the provided entries from the list on the Chat Server and stops their status updates.

Photon flushes friends-list when a chat client disconnects. Unless you want to remove individual entries, you don't have to RemoveFriends.

AddFriends and RemoveFriends enable clients to handle their friend list in the Photon Chat server. Having users on your friends list gives you access to their current online status (and whatever info your client sets in it).

Each user can set an online status consisting of an integer and an arbitratry (serializable) object. The object can be null, Hashtable, object[] or anything else Photon can serialize.

The status is published automatically to friends (anyone who set your user ID with AddFriends).

Photon flushes friends-list when a chat client disconnects, so it has to be set each time. If your community API gives you access to online status already, you could filter and set online friends in AddFriends.

Actual friend relations are not persistent and have to be stored outside of Photon.

AddFriends and RemoveFriends enable clients to handle their friend list in the Photon Chat server. Having users on your friends list gives you access to their current online status (and whatever info your client sets in it).

Each user can set an online status consisting of an integer and an arbitratry (serializable) object. The object can be null, Hashtable, object[] or anything else Photon can serialize.

The status is published automatically to friends (anyone who set your user ID with AddFriends).

Actual friend relations are not persistent and have to be stored outside of Photon.

Parameters

friends

Array of friend userIds.

Returns

If the operation could be sent.

Sends a private message to a single target user. Calls OnPrivateMessage on the receiving client.

Parameters

target	Username to send this message to.
message	The message you want to send. Can be a simple string or anything serializable.

Returns

True if this clients can send the message to the server.

Sends a private message to a single target user. Calls OnPrivateMessage on the receiving client.

Parameters

target	Username to send this message to.
message	The message you want to send. Can be a simple string or anything serializable.
encrypt	Optionally, private messages can be encrypted. Encryption is not end-to-end as the server decrypts the message.

Returns

True if this clients can send the message to the server.

Must be called regularly to keep connection between client and server alive and to process incoming messages.

This method limits the effort it does automatically using the private variable msDeltaForServiceCalls. That value is lower for connect and multiplied by 4 when chat-server connection is ready.

Sets the user's status without changing your status-message.

The predefined status values can be found in class ChatUserStatus. State ChatUserStatus.Invisible will make you offline for everyone and send no message.

You can set custom values in the status integer. Aside from the pre-configured ones, all states will be considered visible and online. Else, no one would see the custom state.

This overload does not change the set message.

Parameters

status

Predefined states are in class ChatUserStatus. Other values can be used at will.

Returns

True if the operation gets called on the server.

Sets the user's status without changing your status-message.

The predefined status values can be found in class ChatUserStatus. State ChatUserStatus.Invisible will make you offline for everyone and send no message.

You can set custom values in the status integer. Aside from the pre-configured ones, all states will be considered visible and online. Else, no one would see the custom state.

The message object can be anything that Photon can serialize, including (but not limited to) Hashtable, object[] and string. This value is defined by your own conventions.

Parameters

status	Predefined states are in class ChatUserStatus. Other values can be used at will.
message	Also sets a status-message which your friends can get.

Returns

True if the operation gets called on the server.

Sends operation to subscribe to a list of channels by name.

Parameters

channels

List of channels to subscribe to. Avoid null or empty values.

Returns

If the operation could be sent at all (Example: Fails if not connected to Chat Server).

Sends operation to subscribe client to channels, optionally fetching a number of messages from the cache.

Subscribes channels will forward new messages to this user. Use PublishMessage to do so. The messages cache is limited but can be useful to get into ongoing conversations, if that's needed.

Parameters

channels	List of channels to subscribe to. Avoid null or empty values.
messagesFromHistory	0: no history. 1 and higher: number of messages in history. -1: all available history.

Returns

If the operation could be sent at all (Example: Fails if not connected to Chat Server).

Simplified access to either private or public channels by name.

Parameters

channelName	Name of the channel to get. For private channels, the channel-name is composed of both user's names.
isPrivate	Define if you expect a private or public channel.
channel	Out parameter gives you the found channel, if any.

Returns

True if the channel was found.

Simplified access to all channels by name. Checks public channels first, then private ones.

Parameters

channelName	Name of the channel to get.
channel	Out parameter gives you the found channel, if any.

Returns

True if the channel was found.

Unsubscribes from a list of channels, which stops getting messages from those.

The client will remove these channels from the PublicChannels dictionary once the server sent a response to this request.

The request will be sent to the server and IChatClientListener.OnUnsubscribed gets called when the server actually removed the channel subscriptions.

Unsubscribe will fail if you include null or empty channel names.

Parameters

channels

Names of channels to unsubscribe.

Returns

False, if not connected to a chat server.

If greater than 0, new channels will limit the number of messages they cache locally.

This can be useful to limit the amount of memory used by chats. You can set a MessageLimit per channel but this value gets applied to new ones.

Note: Changing this value, does not affect ChatChannels that are already in use!

The AppID as assigned from the Photon Cloud. If you host yourself, this is the "regular" Photon Server Application Name (most likely: "LoadBalancing").

The version of your client. A new version also creates a new "virtual app" to separate players from older client versions.

Settable only before you connect!

Settable only before you connect! Defaults to "EU".

Sets the level (and amount) of debug output provided by the library.

This affects the callbacks to IChatClientListener.DebugReturn. Default Level: Error.

The address of the actual chat server assigned from NameServer. Public for read only.

The address of last connected Name Server.

Current state of the ChatClient. Also use CanChat.

The unique ID of a user/person, stored in AuthValues.UserId. Set it before you connect.

This value wraps AuthValues.UserId. It's not a nickname and we assume users with the same userID are the same person.