Photon .NET Client API 4.1.4.8

Public Member Functions | Properties | List of all members
Photon.Realtime.WebRpcResponse Class Reference

Reads an operation response of a WebRpc and provides convenient access to most common values. More...

Public Member Functions

 WebRpcResponse (OperationResponse response)
 An OperationResponse for a WebRpc is needed to read it's values. More...
 
string ToStringFull ()
 Turns the response into an easier to read string. More...
 

Properties

string Name [get]
 Name of the WebRpc that was called. More...
 
int ResultCode [get]
 ResultCode of the WebService that answered the WebRpc. More...
 
int ReturnCode [get]
 
string Message [get]
 Might be empty or null. More...
 
string DebugMessage [get]
 
Dictionary< string, object > Parameters [get]
 Other key/values returned by the webservice that answered the WebRpc. More...
 

Detailed Description

Reads an operation response of a WebRpc and provides convenient access to most common values.

See LoadBalancingClient.OpWebRpc.
Create a WebRpcResponse to access common result values.
The operationResponse.OperationCode should be: OperationCode.WebRpc.

Constructor & Destructor Documentation

◆ WebRpcResponse()

Photon.Realtime.WebRpcResponse.WebRpcResponse ( OperationResponse  response)
inline

An OperationResponse for a WebRpc is needed to read it's values.

Member Function Documentation

◆ ToStringFull()

string Photon.Realtime.WebRpcResponse.ToStringFull ( )
inline

Turns the response into an easier to read string.

Returns
String resembling the result.

Property Documentation

◆ DebugMessage

string Photon.Realtime.WebRpcResponse.DebugMessage
get

◆ Message

string Photon.Realtime.WebRpcResponse.Message
get

Might be empty or null.

◆ Name

string Photon.Realtime.WebRpcResponse.Name
get

Name of the WebRpc that was called.

◆ Parameters

Dictionary<string, object> Photon.Realtime.WebRpcResponse.Parameters
get

Other key/values returned by the webservice that answered the WebRpc.

◆ ResultCode

int Photon.Realtime.WebRpcResponse.ResultCode
get

ResultCode of the WebService that answered the WebRpc.

0 is: "OK" for WebRPCs.
-1 is: No ResultCode by WebRpc service (check OperationResponse.ReturnCode).
Other ResultCode are defined by the individual WebRpc and service.

◆ ReturnCode

int Photon.Realtime.WebRpcResponse.ReturnCode
get

The documentation for this class was generated from the following file: