Class SupportedResponseEvent

Namespace

ArcanaDevelopment.adTempus.Shared

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Information about a Response Event supported by an object

public class SupportedResponseEvent

Inheritance

object

SupportedResponseEvent

Constructors

SupportedResponseEvent(JobEvent)

public SupportedResponseEvent(JobEvent jobEvent)

Parameters

Name	Type	Description
jobEvent	JobEvent

SupportedResponseEvent(JobEvent, string)

public SupportedResponseEvent(JobEvent jobEvent, string description)

Parameters

Name	Type	Description
jobEvent	JobEvent
description	string

SupportedResponseEvent(JobEvent, string, string)

public SupportedResponseEvent(JobEvent jobEvent, string customID, string description)

Parameters

Name	Type	Description
jobEvent	JobEvent
customID	string
description	string

SupportedResponseEvent(string, string)

public SupportedResponseEvent(string definedResultValue, string definedResultDescription)

Parameters

Name	Type	Description
definedResultValue	string
definedResultDescription	string

Fields

CustomEventID

The custom event ID, when Event is Custom

public string CustomEventID

Field Value

string

CustomLabel

The custom label to use when displaying this event

public string CustomLabel

Field Value

string

DefinedResult

The defined value that is used for this event

public string DefinedResult

Field Value

string

Event

The supported event

public JobEvent Event

Field Value

JobEvent

Properties

DescriptionToStore

The description to store in object, if different than the default

public string DescriptionToStore { get; }

Property Value

string

DisplayName

The display name for the event

public string DisplayName { get; }

Property Value

string

Methods

CompareTo(object)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(object obj)

Parameters

Name	Type	Description
obj	object	An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:
Value

Meaning

Less than zero

This instance precedes obj in the sort order.

Zero

This instance occurs in the same position in the sort order as obj.

Greater than zero

This instance follows obj in the sort order.

Exceptions

ArgumentException

obj is not the same type as this instance.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.