ClientActionResult

escribes the client side result of any ClientActionRequest requests that have been seen to the client device.

Note that ClientActionResult values may be provided by the client using any valin JSON type, although typically this is a string.

Therefore, two ways are provided to read a ClientActionRequest result:

• string Result - A property which returns the result as a string value, if it is available.

• Object GetResultObject() - a method which returns the result as a request type specific object (such as PageInfo).

pplications are responsible for determining the correct Object return type of GetResultObject() by checking either the Type or Request properties, snd casting to the correct Object accordingly.

NameSpace: StarMicronics.CloudPrnt.CpMessage

Syntax

public class ClientActionResult

Properties

Request

The request type that this response corresponds to as a string.

Declaration

public string Request { get; }

Property Value

Type	Description
System.String

Result

The result value reported by the client as a string.

Note that this values can only be relied upon if the particular ClientAction result is represented as a JSON string.

For other types, this will return the underlying JSON object as a string for deserialization.

Declaration

public string Result { get; }

Property Value

Type	Description
System.String

Type

The request type that this response corresponds to as a ClientActions Enum.

In case of an unrecognised type, this will be ClientActions.Other and applications should check the Request string property value instead.

Declaration

public ClientActions Type { get; }

Property Value

Type	Description
ClientActions

Methods

GetResultObject()

Return the appropriate object for the result.

In most cases this will be a string, but for some ClientActionResult types it can be a specific object type.

Applications are required to check the Type, or Request properties to determine the correct return object type and cast accordingly.

Declaration

public object GetResultObject()

Returns

Type	Description
System.Object	An opject representing the result. In most cases with object will always be a string type. If the ClientActionResult is a response to a ClientActions.PageInfo request, then the returned object will be a CpMessage.PageInfo object.