Beamable.CronExpression.ExpressionDescriptor Class Reference

Converts a Cron Expression into a human readable string More...

Public Member Functions
	ExpressionDescriptor (string expression)
	Initializes a new instance of the ExpressionDescriptor class More...
	ExpressionDescriptor (string expression, Options options)
	Initializes a new instance of the ExpressionDescriptor class More...
string	GetDescription (DescriptionTypeEnum type, out ErrorData errorData)
	Generates a human readable string for the Cron Expression More...

Static Public Member Functions
static string	GetDescription (string expression, out ErrorData errorData)
	Generates a human readable string for the Cron Expression More...
static string	GetDescription (string expression, Options options, out ErrorData errorData)
	Generates a human readable string for the Cron Expression More...
static string	GetDescription (ScheduleDefinition scheduleDefinition, out ErrorData errorData)
	Generates a human readable string for the schedule definition More...
static string	GetDescription (ScheduleDefinition scheduleDefinition, Options options, out ErrorData errorData)
	Generates a human readable string for the schedule definition More...
static string	ScheduleDefinitionToCron (ScheduleDefinition scheduleDefinition)
	Converts schedule definition into cron expression More...
static ScheduleDefinition	CronToScheduleDefinition (string expression)
	Converts cron expression into schedule definition More...

Detailed Description

Converts a Cron Expression into a human readable string

Constructor & Destructor Documentation

ExpressionDescriptor() [1/2]

Beamable.CronExpression.ExpressionDescriptor.ExpressionDescriptor ( string  expression )

inline

Initializes a new instance of the ExpressionDescriptor class

Parameters

expression

The cron expression string

ExpressionDescriptor() [2/2]

Beamable.CronExpression.ExpressionDescriptor.ExpressionDescriptor ( string  expression, Options  options  )

inline

Initializes a new instance of the ExpressionDescriptor class

Parameters

expression	The cron expression string
options	Options to control the output description

Member Function Documentation

CronToScheduleDefinition()

static ScheduleDefinition Beamable.CronExpression.ExpressionDescriptor.CronToScheduleDefinition ( string  expression )

inlinestatic

Converts cron expression into schedule definition

Parameters

expression

Cron expression

Returns

Schedule definition

GetDescription() [1/5]

string Beamable.CronExpression.ExpressionDescriptor.GetDescription ( DescriptionTypeEnum  type, out ErrorData  errorData  )

inline

Generates a human readable string for the Cron Expression

Parameters

type	Which part(s) of the expression to describe

Returns

The cron expression description

GetDescription() [2/5]

static string Beamable.CronExpression.ExpressionDescriptor.GetDescription ( ScheduleDefinition  scheduleDefinition, Options  options, out ErrorData  errorData  )

inlinestatic

Generates a human readable string for the schedule definition

Parameters

scheduleDefinition	Schedule definition
options	Options to control the output description

Returns

The cron expression description

GetDescription() [3/5]

static string Beamable.CronExpression.ExpressionDescriptor.GetDescription ( ScheduleDefinition  scheduleDefinition, out ErrorData  errorData  )

inlinestatic

Generates a human readable string for the schedule definition

Parameters

scheduleDefinition

Schedule definition

Returns

The cron expression description

GetDescription() [4/5]

static string Beamable.CronExpression.ExpressionDescriptor.GetDescription ( string  expression, Options  options, out ErrorData  errorData  )

inlinestatic

Generates a human readable string for the Cron Expression

Parameters

expression	The cron expression string
options	Options to control the output description

Returns

The cron expression description

GetDescription() [5/5]

static string Beamable.CronExpression.ExpressionDescriptor.GetDescription ( string  expression, out ErrorData  errorData  )

inlinestatic

Generates a human readable string for the Cron Expression

Parameters

expression

The cron expression string

Returns

The cron expression description

ScheduleDefinitionToCron()

static string Beamable.CronExpression.ExpressionDescriptor.ScheduleDefinitionToCron ( ScheduleDefinition  scheduleDefinition )

inlinestatic

Converts schedule definition into cron expression

Parameters

scheduleDefinition

Schedule definition

Returns

The cron expression<returns>

---

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

• com.beamable/Editor/UI/CronExpression/ExpressionDescriptor.cs