Aculab Web Services Wrapper (v1.0.5)
\
Aculab
WebServicesWrapper

\Aculab\WebServicesWrapperOutboundInstanceStatus

Outbound instance status

Returned by \Aculab\WebServicesWrapper\OutboundServiceWebService::getInstanceStatus()

Summary

Methods
Properties
Constants
isFinished()
getStatus()
getStatusDetail()
getApplicationStatusETA()
getApplicationInstanceId()
No public properties found
QUEUED
RUNNING
COMPLETED
COULDNOTRUN
CANCELLED
UNKNOWN
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

QUEUED

QUEUED

The instance is queued.

RUNNING

RUNNING

The instance is runng.

CANCELLED

CANCELLED

The instance has been cancelled.

This is returned for a service that has been cancelled using service_cancel.

UNKNOWN

UNKNOWN

The instance id was not recognised.

Methods

isFinished()

isFinished() : boolean

Determine if the instance has finished.

Returns

boolean

getStatus()

getStatus() : string

Get the instance status.

Returns

string —

One of the constants.

getStatusDetail()

getStatusDetail() : string

Get the instance status detail.

Returns

string —

If the status is COMPLETED, then this returns the application's numeric return code. If the status is COULDNOTRUN, then this returns a description of the problem. Otherwise, this returns an empty string.

getApplicationStatusETA()

getApplicationStatusETA() : \DateTime|null

Get the application status ETA.

Returns

\DateTime|null —

The time at which the application's status will be ready for retrieval. Will be null if there is no ETA is available.

getApplicationInstanceId()

getApplicationInstanceId() : string

Get the application instance ID.

Use this ID to get the status of an application instance.

Returns

string —

The application instance ID.