Photon Plugins API Documentation
Public Member Functions | Properties | List of all members
Photon.Hive.Plugin.ICallInfo Interface Reference

Common/base interface of all arguments passed to plugin callbacks. More...

Inheritance diagram for Photon.Hive.Plugin.ICallInfo:
Photon.Hive.Plugin.ITypedCallInfo< out out RequestType >

Public Member Functions

void Continue ()
 
void Fail (string msg=null, Dictionary< byte, object > errorData=null)
 

Properties

IOperationRequest OperationRequest [get]
 The operation request triggering the callback call. More...
 
byte Status [get]
 Call processing status. For possible values, Photon.Hive.Plugins.CallStatus. More...
 
bool IsNew [get]
 Helper property to check if call is not processed nor deferred. More...
 
bool IsDeferred [get]
 Helper property to check if call is deferred. More...
 
bool IsSucceeded [get]
 Helper property to check if call was processed successfully (Continue() was called). More...
 
bool IsFailed [get]
 Helper property to check if Fail() was called. More...
 
bool IsCanceled [get]
 Helper property to check if Cancel() was called. More...
 
bool IsProcessed [get]
 Helper property to check if the call was processed using any of the three methods: Continue, Cancel or Fail. More...
 

Detailed Description

Common/base interface of all arguments passed to plugin callbacks.

Member Function Documentation

void Photon.Hive.Plugin.ICallInfo.Continue ( )
void Photon.Hive.Plugin.ICallInfo.Fail ( string  msg = null,
Dictionary< byte, object >  errorData = null 
)

Property Documentation

bool Photon.Hive.Plugin.ICallInfo.IsCanceled
get

Helper property to check if Cancel() was called.

bool Photon.Hive.Plugin.ICallInfo.IsDeferred
get

Helper property to check if call is deferred.

bool Photon.Hive.Plugin.ICallInfo.IsFailed
get

Helper property to check if Fail() was called.

bool Photon.Hive.Plugin.ICallInfo.IsNew
get

Helper property to check if call is not processed nor deferred.

bool Photon.Hive.Plugin.ICallInfo.IsProcessed
get

Helper property to check if the call was processed using any of the three methods: Continue, Cancel or Fail.

bool Photon.Hive.Plugin.ICallInfo.IsSucceeded
get

Helper property to check if call was processed successfully (Continue() was called).

IOperationRequest Photon.Hive.Plugin.ICallInfo.OperationRequest
get

The operation request triggering the callback call.

byte Photon.Hive.Plugin.ICallInfo.Status
get

Call processing status. For possible values, Photon.Hive.Plugins.CallStatus.