Photon.Realtime.ErrorInfo Class Reference

Class wrapping the received EventCode.ErrorInfo event. More...

Public Member Functions
	ErrorInfo (EventData eventData)
	Creates a new ErrorInfo from a (Photon) event. More...
override string	ToString ()
	Provides a string representation of this instance. More...

Public Attributes
readonly string	Info
	String containing information about the error. More...

Detailed Description

Class wrapping the received EventCode.ErrorInfo event.

This is passed inside IErrorInfoCallback.OnErrorInfo callback. If you implement IOnEventCallback.OnEvent or RealtimeClient.EventReceived you will also get EventCode.ErrorInfo but not parsed.

In most cases this could be either:

1. an error from webhooks plugin (if HasErrorInfo is enabled), read more here: https://doc.photonengine.com/en-us/realtime/current/gameplay/web-extensions/webhooks#options
2. an error sent from a custom server plugin via PluginHost.BroadcastErrorInfoEvent, see example here: https://doc.photonengine.com/en-us/server/current/plugins/manual#handling_http_response
3. an error sent from the server, for example, when the limit of cached events has been exceeded in the room (all clients will be disconnected and the room will be closed in this case) read more here: https://doc.photonengine.com/en-us/realtime/current/gameplay/cached-events#special_considerations

Constructor & Destructor Documentation

ErrorInfo()

Photon.Realtime.ErrorInfo.ErrorInfo ( EventData  eventData )

inline

Creates a new ErrorInfo from a (Photon) event.

Parameters

eventData

The event to read.

Member Function Documentation

ToString()

override string Photon.Realtime.ErrorInfo.ToString ( )

inline

Provides a string representation of this instance.

Returns

String representation of this instance.

Member Data Documentation

Info

readonly string Photon.Realtime.ErrorInfo.Info

String containing information about the error.