C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.TaskStatusExtensions Class Reference

Extension methods for TaskStatus enum values. More...

Static Public Member Functions

static bool IsBusy (this TaskStatus taskStatus)
 Indicates whether the current status is busy at the server side, (TaskStatus.Queued or TaskStatus.Processing) which usually indicates that continued polling of the resource should see the status change to one of the "Processing Complete" states (see IsProcessingComplete).
 
static bool IsError (this TaskStatus taskStatus)
 Indicates whether the current status is an error. (TaskStatus.Failed or TaskStatus.BadRequest)
 
static bool IsProcessingComplete (this TaskStatus taskStatus)
 Indicates whether the current status has completed processing. (TaskStatus.Success, TaskStatus.Failed or TaskStatus.BadRequest)
 
static string ToAPIString (this TaskStatus taskStatus)
 Returns the API string for this task status, which is what this status looks like when it appears in a json representation.
 

Detailed Description

Extension methods for TaskStatus enum values.

Definition at line 38 of file TaskStatus.cs.

Member Function Documentation

◆ IsBusy()

static bool AnalyzeRe.TaskStatusExtensions.IsBusy ( this TaskStatus  taskStatus)
inlinestatic

Indicates whether the current status is busy at the server side, (TaskStatus.Queued or TaskStatus.Processing) which usually indicates that continued polling of the resource should see the status change to one of the "Processing Complete" states (see IsProcessingComplete).

Parameters
taskStatusThe status to check for busy.
Returns
True if the current status is busy.

Definition at line 47 of file TaskStatus.cs.

◆ IsError()

static bool AnalyzeRe.TaskStatusExtensions.IsError ( this TaskStatus  taskStatus)
inlinestatic

Indicates whether the current status is an error. (TaskStatus.Failed or TaskStatus.BadRequest)

Parameters
taskStatusThe status to check for errors.
Returns
True if the current status is an error.

Definition at line 68 of file TaskStatus.cs.

◆ IsProcessingComplete()

static bool AnalyzeRe.TaskStatusExtensions.IsProcessingComplete ( this TaskStatus  taskStatus)
inlinestatic

Indicates whether the current status has completed processing. (TaskStatus.Success, TaskStatus.Failed or TaskStatus.BadRequest)

Parameters
taskStatusThe status to check for completion.
Returns
True if the current status is complete.

Definition at line 58 of file TaskStatus.cs.

◆ ToAPIString()

static string AnalyzeRe.TaskStatusExtensions.ToAPIString ( this TaskStatus  taskStatus)
inlinestatic

Returns the API string for this task status, which is what this status looks like when it appears in a json representation.

Parameters
taskStatusThe status to check for errors.
Returns
True if the current status is an error.

Definition at line 77 of file TaskStatus.cs.


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