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

Inheritance diagram for Photon.Hive.Plugin.ICallInfo:

Public Member Functions
void	Continue ()

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

bool	StrictModeCheck (out string errorMsg)

Properties
IOperationRequest	OperationRequest `[get]`
	The operation request triggering the callback call. More...

byte	Status `[get]`
	Gets status of current call. I.E. whether it is new, deffered, failed, succeded or canceled 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	IsCancelled `[get]`

bool	IsProcessed `[get]`
	Helper property to check if the call was processed using any of the three methods: Continue, Cancel or Fail. More...

bool	IsPaused `[get]`
	Helper property to check if call is Paused More...

Detailed Description

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

Member Function Documentation

◆ Continue()

void Photon.Hive.Plugin.ICallInfo.Continue ( )

◆ Fail()

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

◆ StrictModeCheck()

bool Photon.Hive.Plugin.ICallInfo.StrictModeCheck ( out string errorMsg )

Property Documentation

◆ IsCanceled

bool Photon.Hive.Plugin.ICallInfo.IsCanceled

get

Helper property to check if Cancel() was called.

◆ IsCancelled

bool Photon.Hive.Plugin.ICallInfo.IsCancelled

get

◆ IsDeferred

bool Photon.Hive.Plugin.ICallInfo.IsDeferred

get

Helper property to check if call is deferred.

◆ IsFailed

bool Photon.Hive.Plugin.ICallInfo.IsFailed

get

Helper property to check if Fail() was called.

◆ IsNew

bool Photon.Hive.Plugin.ICallInfo.IsNew

get

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

◆ IsPaused

bool Photon.Hive.Plugin.ICallInfo.IsPaused

get

Helper property to check if call is Paused

◆ IsProcessed

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.

◆ IsSucceeded

bool Photon.Hive.Plugin.ICallInfo.IsSucceeded

get

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

◆ OperationRequest

IOperationRequest Photon.Hive.Plugin.ICallInfo.OperationRequest

get

The operation request triggering the callback call.

◆ Status

byte Photon.Hive.Plugin.ICallInfo.Status

get

Gets status of current call. I.E. whether it is new, deffered, failed, succeded or canceled

Photon Plugins API Documentation v5.0RC1

Public Member Functions

Properties