EffectResponse

Response to a request for an effect.

Kind: Class

Namespace: ConnectorLib.JSON

Inheritance: SimpleJSONResponse

Public Constructors

EffectResponse()

Creates a new instance of the ConnectorLib.JSON.EffectResponse class.

EffectResponse(uint id, EffectStatus status)

Creates a new instance of the ConnectorLib.JSON.EffectResponse class.

EffectResponse(uint id, EffectStatus status, StandardErrors messageID, string message = null)

Creates a new instance of the ConnectorLib.JSON.EffectResponse class.

EffectResponse(uint id, EffectStatus status, string message)

Creates a new instance of the ConnectorLib.JSON.EffectResponse class.

EffectResponse(uint id, EffectStatus status, TimeSpan timeRemaining)

Creates a new instance of the ConnectorLib.JSON.EffectResponse class.

EffectResponse(uint id, EffectStatus status, TimeSpan timeRemaining, StandardErrors messageID)

Creates a new instance of the ConnectorLib.JSON.EffectResponse class.

EffectResponse(uint id, EffectStatus status, TimeSpan timeRemaining, string message)

Creates a new instance of the ConnectorLib.JSON.EffectResponse class.

EffectResponse(uint id, EffectStatus status, long timeRemaining, string message = null)

Creates a new instance of the ConnectorLib.JSON.EffectResponse class.

EffectResponse(uint id, EffectStatus status, long timeRemaining, StandardErrors messageID, string message = null)

Creates a new instance of the ConnectorLib.JSON.EffectResponse class.

Public Static Functions

EffectResponse

Success(uint id, string message = null)

Creates a success response.

EffectResponse

Success(uint id, long delay, string message = null)

Creates a success response.

EffectResponse

Success(uint id, TimeSpan delay, string message = null)

Creates a success response.

EffectResponse

Failure(uint id, string message = null)

Creates a success response.

EffectResponse

Failure(uint id, StandardErrors error, string message = null)

Creates a success response.

EffectResponse

Unavailable(uint id, string message = null)

Creates a response indicating that the effect is unavailable.

EffectResponse

Unavailable(uint id, StandardErrors error)

Creates a response indicating that the effect is unavailable.

EffectResponse

Retry(uint id, string message = null)

Creates a response indicating that the effect is temporarily unavailable.

EffectResponse

Retry(uint id, long delay, string message = null)

Creates a response indicating that the effect is temporarily unavailable.

EffectResponse

Retry(uint id, TimeSpan delay, string message = null)

Creates a response indicating that the effect is temporarily unavailable.

EffectResponse

Retry(uint id, StandardErrors error)

Creates a response indicating that the effect is temporarily unavailable.

EffectResponse

Retry(uint id, long delay, StandardErrors error)

Creates a response indicating that the effect is temporarily unavailable.

EffectResponse

Retry(uint id, TimeSpan delay, StandardErrors error)

Creates a response indicating that the effect is temporarily unavailable.

EffectResponse

Paused(uint id, string message = null)

Creates a response indicating that the effect is paused.

EffectResponse

Paused(uint id, long timeRemaining, string message = null)

Creates a response indicating that the effect is paused.

EffectResponse

Paused(uint id, TimeSpan timeRemaining, string message = null)

Creates a response indicating that the effect is paused.

EffectResponse

Paused(uint id, StandardErrors error)

Creates a response indicating that the effect is paused.

EffectResponse

Paused(uint id, long timeRemaining, StandardErrors error)

Creates a response indicating that the effect is paused.

EffectResponse

Paused(uint id, TimeSpan timeRemaining, StandardErrors error)

Creates a response indicating that the effect is paused.

EffectResponse

Resumed(uint id, string message = null)

Creates a response indicating that the effect has resumed.

EffectResponse

Resumed(uint id, long timeRemaining, string message = null)

Creates a response indicating that the effect has resumed.

EffectResponse

Resumed(uint id, TimeSpan timeRemaining, string message = null)

Creates a response indicating that the effect has resumed.

EffectResponse

Resumed(uint id, StandardErrors error)

Creates a response indicating that the effect has resumed.

EffectResponse

Resumed(uint id, long timeRemaining, StandardErrors error)

Creates a response indicating that the effect has resumed.

EffectResponse

Resumed(uint id, TimeSpan timeRemaining, StandardErrors error)

Creates a response indicating that the effect has resumed.

EffectResponse

Finished(uint id, string message = null)

Creates a response indicating that the effect has finished.

EffectResponse

Finished(uint id, StandardErrors error)

Creates a response indicating that the effect has finished.

Public Attributes

EffectStatus

status

Status of the effect.

string

message

Message to be displayed to the user, if applicable.

StandardErrors

messageID

Standard ID of the error message, if applicable.

long

timeRemaining

Dictionary

metadata

Any additional metadata associated with the effect.