Photon Server API Documentation v5.0RC1

Public Member Functions | Protected Member Functions | Properties | List of all members
Photon.Hive.Plugin.RaiseEventCallInfo Class Reference
Inheritance diagram for Photon.Hive.Plugin.RaiseEventCallInfo:
Photon.Hive.Plugin.TypedCallInfo< IRaiseEventRequest > Photon.Hive.Plugin.IRaiseEventCallInfo Photon.Hive.Plugin.ITypedCallInfo< IRaiseEventRequest >

Public Member Functions

 RaiseEventCallInfo (CallCounter counter, CallEnv env)
 
- Public Member Functions inherited from Photon.Hive.Plugin.IRaiseEventCallInfo
void Cancel ()
 Silently skips processing. The Op RaiseEvent is ignored. More...
 
void Defer ()
 Processing of the call is deferred and plugin is nolonger interrupted. More...
 

Protected Member Functions

override bool StrictModeCheck (out string errorMsg)
 
- Protected Member Functions inherited from Photon.Hive.Plugin.TypedCallInfo< IRaiseEventRequest >
 TypedCallInfo (CallCounter counter, ILogger logger, CallEnv env)
 

Properties

int[] Actors [get, set]
 Gets or sets the actors which should receive the event. If set to null or an empty array the event will be sent to all actors in the room. More...
 
byte Cache [get, set]
 Gets or sets a value indicating how to use the EventCache. More...
 
object Data [get, set]
 Gets or sets the hashtable containing the data to send. More...
 
byte EvCode [get, set]
 Gets or sets a byte containing the Code to send. More...
 
bool IsCacheOpRemoveFromCache [get]
 
bool IsCacheOpRemoveFromCacheForActorsLeft [get]
 
bool IsCacheSliceIndexOperation [get]
 
bool IsCacheOnlyOperation [get]
 
bool IsBroadcastOperation [get]
 
- Properties inherited from Photon.Hive.Plugin.TypedCallInfo< IRaiseEventRequest >
RequestType Request [get, set]
 
string UserId [get, set]
 
string Nickname [get, set]
 
object? AuthResultsToken [get]
 
Dictionary< string, object >? AuthCookie [get]
 
- Properties inherited from Photon.Hive.Plugin.IRaiseEventCallInfo
int ActorNr [get]
 Number of the actor triggering the callback call. More...
 
- Properties inherited from Photon.Hive.Plugin.ITypedCallInfo< IRaiseEventRequest >
RequestType Request [get]
 
string UserId [get]
 User ID of the actor triggering the call. More...
 
string Nickname [get]
 NickName of the actor triggering the call. More...
 
object AuthResultsToken [get]
 
Dictionary< string, object > AuthCookie [get]
 AuthCookie of the actor triggering the call. More...
 

Additional Inherited Members

- Static Protected Attributes inherited from Photon.Hive.Plugin.TypedCallInfo< IRaiseEventRequest >
static readonly LogCountGuard onFailLogCountGuard
 

Constructor & Destructor Documentation

◆ RaiseEventCallInfo()

Photon.Hive.Plugin.RaiseEventCallInfo.RaiseEventCallInfo ( CallCounter  counter,
CallEnv  env 
)
inline

Member Function Documentation

◆ StrictModeCheck()

override bool Photon.Hive.Plugin.RaiseEventCallInfo.StrictModeCheck ( out string  errorMsg)
inlineprotected

Property Documentation

◆ Actors

int [] Photon.Hive.Plugin.RaiseEventCallInfo.Actors
getset

Gets or sets the actors which should receive the event. If set to null or an empty array the event will be sent to all actors in the room.

Optional request parameter.

◆ Cache

byte Photon.Hive.Plugin.RaiseEventCallInfo.Cache
getset

Gets or sets a value indicating how to use the EventCache.

Optional request parameter. Ignored if the event is sent to individual actors (submitted Actors or Photon.Hive.Operations.ReceiverGroup.MasterClient).

◆ Data

object Photon.Hive.Plugin.RaiseEventCallInfo.Data
getset

Gets or sets the hashtable containing the data to send.

Optional request parameter.

◆ EvCode

byte Photon.Hive.Plugin.RaiseEventCallInfo.EvCode
getset

Gets or sets a byte containing the Code to send.

Optional request parameter.

◆ IsBroadcastOperation

bool Photon.Hive.Plugin.RaiseEventCallInfo.IsBroadcastOperation
get

◆ IsCacheOnlyOperation

bool Photon.Hive.Plugin.RaiseEventCallInfo.IsCacheOnlyOperation
get

◆ IsCacheOpRemoveFromCache

bool Photon.Hive.Plugin.RaiseEventCallInfo.IsCacheOpRemoveFromCache
get

◆ IsCacheOpRemoveFromCacheForActorsLeft

bool Photon.Hive.Plugin.RaiseEventCallInfo.IsCacheOpRemoveFromCacheForActorsLeft
get

◆ IsCacheSliceIndexOperation

bool Photon.Hive.Plugin.RaiseEventCallInfo.IsCacheSliceIndexOperation
get