Package | com.adobe.csxs.types |
Class | public class SyncRequestResult |
status
member defines the result status if it failed or completed successfully.
The data
member contains the actual result, when applicable.
Property | Defined by | ||
---|---|---|---|
data : *
Retrieves the data associated with the request result.
| SyncRequestResult | ||
status : String
Retrieves the request status.
| SyncRequestResult |
Method | Defined by | ||
---|---|---|---|
SyncRequestResult(status:String = "PlugPlugRequestFailed", data:* = null)
Creates a request result object.
| SyncRequestResult | ||
toString():String
Creates a string that contains all the properties of this object.
| SyncRequestResult |
Constant | Defined by | ||
---|---|---|---|
COMPLETE : String = "PlugPlugRequestComplete" [static] Result status when the request completed successfully.
| SyncRequestResult | ||
DENIED : String = "PlugPlugRequestDenied" [static] Result status when the request was denied by the server.
| SyncRequestResult | ||
EXTERNALINTERFACE_NOT_AVAILABLE : String = "ExternalInterfaceNotAvailable" [static] Result status when the request failed because an external interface was not found.
| SyncRequestResult | ||
FAILED : String = "PlugPlugRequestFailed" [static] Result status when the request failed for any other reason.
| SyncRequestResult | ||
INVALID_INPUT_PARAMS : String = "InvalidInputParams" [static] Result status when the request failed because it contained invalid input parameters.
| SyncRequestResult | ||
INVALID_RETURN_PARAMS : String = "InvalidReturnParams" [static] Result status when the request because it contained invalid output parameters..
| SyncRequestResult |
data | property |
data:*
[read-write]
Retrieves the data associated with the request result.
The type depends of the request; for example, for getHostEnvrionment()
, it is
a HostEnvironment
object.
var result:SyncRequestResult = getHostEnvironment(); var hostEnv:HostEnvironment; if((SyncRequestResult.COMPLETE == result.status) && result.data) { result.data as HostEnvironment; }
public function get data():*
public function set data(value:*):void
status | property |
status:String
[read-write]Retrieves the request status.
Implementation public function get status():String
public function set status(value:String):void
SyncRequestResult | () | constructor |
public function SyncRequestResult(status:String = "PlugPlugRequestFailed", data:* = null)
Creates a request result object.
Parametersstatus:String (default = "PlugPlugRequestFailed ") — Optional. The result status constant.
|
|
data:* (default = null ) — Optional. The result data, if applicable.
|
toString | () | method |
public function toString():String
Creates a string that contains all the properties of this object.
ReturnsString — The properties string.
|
COMPLETE | constant |
public static const COMPLETE:String = "PlugPlugRequestComplete"
Result status when the request completed successfully.
DENIED | constant |
public static const DENIED:String = "PlugPlugRequestDenied"
Result status when the request was denied by the server.
EXTERNALINTERFACE_NOT_AVAILABLE | constant |
public static const EXTERNALINTERFACE_NOT_AVAILABLE:String = "ExternalInterfaceNotAvailable"
Result status when the request failed because an external interface was not found.
FAILED | constant |
public static const FAILED:String = "PlugPlugRequestFailed"
Result status when the request failed for any other reason.
INVALID_INPUT_PARAMS | constant |
public static const INVALID_INPUT_PARAMS:String = "InvalidInputParams"
Result status when the request failed because it contained invalid input parameters.
INVALID_RETURN_PARAMS | constant |
public static const INVALID_RETURN_PARAMS:String = "InvalidReturnParams"
Result status when the request because it contained invalid output parameters..