Photon .NET Client API 4.1.4.8

Public Attributes | Properties | List of all members
Photon.Chat.ChatAppSettings Class Reference

Settings for Photon application(s) and the server to connect to. More...

Public Attributes

string AppIdChat
 AppId for the Chat Api. More...
 
string AppVersion
 The AppVersion can be used to identify builds and will split the AppId distinct "Virtual AppIds" (important for the users to find each other). More...
 
string FixedRegion
 Can be set to any of the Photon Cloud's region names to directly connect to that region. More...
 
string Server
 The address (hostname or IP) of the server to connect to. More...
 
ushort Port
 If not null, this sets the port of the first Photon server to connect to (that will "forward" the client as needed). More...
 
ConnectionProtocol Protocol = ConnectionProtocol.Udp
 The network level protocol to use. More...
 
bool EnableProtocolFallback = true
 Enables a fallback to another protocol in case a connect to the Name Server fails. More...
 
DebugLevel NetworkLogging = DebugLevel.ERROR
 Log level for the network lib. More...
 

Properties

bool IsDefaultNameServer [get]
 If true, the default nameserver address for the Photon Cloud should be used. More...
 
string AppId [get, set]
 Available to not immediately break compatibility. More...
 

Detailed Description

Settings for Photon application(s) and the server to connect to.

This is Serializable for Unity, so it can be included in ScriptableObject instances.

Member Data Documentation

◆ AppIdChat

string Photon.Chat.ChatAppSettings.AppIdChat

AppId for the Chat Api.

◆ AppVersion

string Photon.Chat.ChatAppSettings.AppVersion

The AppVersion can be used to identify builds and will split the AppId distinct "Virtual AppIds" (important for the users to find each other).

◆ EnableProtocolFallback

bool Photon.Chat.ChatAppSettings.EnableProtocolFallback = true

Enables a fallback to another protocol in case a connect to the Name Server fails.

See: LoadBalancingClient.EnableProtocolFallback.

◆ FixedRegion

string Photon.Chat.ChatAppSettings.FixedRegion

Can be set to any of the Photon Cloud's region names to directly connect to that region.

◆ NetworkLogging

DebugLevel Photon.Chat.ChatAppSettings.NetworkLogging = DebugLevel.ERROR

Log level for the network lib.

◆ Port

ushort Photon.Chat.ChatAppSettings.Port

If not null, this sets the port of the first Photon server to connect to (that will "forward" the client as needed).

◆ Protocol

ConnectionProtocol Photon.Chat.ChatAppSettings.Protocol = ConnectionProtocol.Udp

The network level protocol to use.

◆ Server

string Photon.Chat.ChatAppSettings.Server

The address (hostname or IP) of the server to connect to.

Property Documentation

◆ AppId

string Photon.Chat.ChatAppSettings.AppId
getset

Available to not immediately break compatibility.

◆ IsDefaultNameServer

bool Photon.Chat.ChatAppSettings.IsDefaultNameServer
get

If true, the default nameserver address for the Photon Cloud should be used.


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