Photon Plugins API Documentation
Static Public Member Functions | Public Attributes | List of all members
Photon.Hive.Plugin.WebFlags Class Reference

Optional flags to be used in Photon client SDKs with Op RaiseEvent and Op SetProperties. Introduced mainly for webhooks 1.2 to control behavior of forwarded HTTP requests. More...

Static Public Member Functions

static bool ShouldHttpForward (byte flags)
 Helper method to indicate if HttpForward flag is set or not. More...
 
static bool ShouldSendAuthCookie (byte flags)
 Helper method to indicate if SendAuthCookie flag is set or not. More...
 
static bool ShouldSendSync (byte flags)
 Helper method to indicate if SendSync flag is set or not. More...
 
static bool ShouldSendState (byte flags)
 Helper method to indicate if SendState flag is set or not. More...
 

Public Attributes

const byte HttpForward = 0x01
 Indicates whether to forward HTTP request to web service or not. More...
 
const byte SendAuthCookie = 0x02
 Indicates whether to send AuthCookie of actor in the HTTP request to web service or not. More...
 
const byte HttpForwardWithAuthCookie = HttpForward|SendAuthCookie
 HttpForward and SendAuthCookie combined. More...
 
const byte SendSync = 0x04
 Indicates whether to send HTTP request synchronously or asynchronously to web service. More...
 
const byte SendState = 0x08
 Indicates whether to send serialized game state in HTTP request to web service or not. More...
 

Detailed Description

Optional flags to be used in Photon client SDKs with Op RaiseEvent and Op SetProperties. Introduced mainly for webhooks 1.2 to control behavior of forwarded HTTP requests.

Member Function Documentation

static bool Photon.Hive.Plugin.WebFlags.ShouldHttpForward ( byte  flags)
inlinestatic

Helper method to indicate if HttpForward flag is set or not.

Parameters
flagsWeb flags parameter.
Returns
If HttpForward flag is set or not.
static bool Photon.Hive.Plugin.WebFlags.ShouldSendAuthCookie ( byte  flags)
inlinestatic

Helper method to indicate if SendAuthCookie flag is set or not.

Parameters
flagsWeb flags parameter.
Returns
If SendAuthCookie flag is set or not.
static bool Photon.Hive.Plugin.WebFlags.ShouldSendState ( byte  flags)
inlinestatic

Helper method to indicate if SendState flag is set or not.

Parameters
flagsWeb flags parameter.
Returns
If SendState flag is set or not.
static bool Photon.Hive.Plugin.WebFlags.ShouldSendSync ( byte  flags)
inlinestatic

Helper method to indicate if SendSync flag is set or not.

Parameters
flagsWeb flags parameter.
Returns
If SendSync flag is set or not.

Member Data Documentation

const byte Photon.Hive.Plugin.WebFlags.HttpForward = 0x01

Indicates whether to forward HTTP request to web service or not.

const byte Photon.Hive.Plugin.WebFlags.HttpForwardWithAuthCookie = HttpForward|SendAuthCookie

HttpForward and SendAuthCookie combined.

const byte Photon.Hive.Plugin.WebFlags.SendAuthCookie = 0x02

Indicates whether to send AuthCookie of actor in the HTTP request to web service or not.

const byte Photon.Hive.Plugin.WebFlags.SendState = 0x08

Indicates whether to send serialized game state in HTTP request to web service or not.

const byte Photon.Hive.Plugin.WebFlags.SendSync = 0x04

Indicates whether to send HTTP request synchronously or asynchronously to web service.