Table of Contents

Class SupportedResponseEvent

Namespace
ArcanaDevelopment.adTempus.Shared
Assembly
ArcanaDevelopment.adTempus.Shared.dll
public class SupportedResponseEvent
Inheritance
object
SupportedResponseEvent

Constructors

SupportedResponseEvent(JobEvent)

public SupportedResponseEvent(JobEvent jobEvent)

Parameters

NameTypeDescription
jobEvent JobEvent

SupportedResponseEvent(JobEvent, string)

public SupportedResponseEvent(JobEvent jobEvent, string description)

Parameters

NameTypeDescription
jobEvent JobEvent
description string

SupportedResponseEvent(JobEvent, string, string)

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

Parameters

NameTypeDescription
jobEvent JobEvent
customID string
description string

SupportedResponseEvent(string, string)

public SupportedResponseEvent(string definedResultValue, string definedResultDescription)

Parameters

NameTypeDescription
definedResultValue string
definedResultDescription string

Fields

CustomEventID

public string CustomEventID

Field Value

string

CustomLabel

public string CustomLabel

Field Value

string

DefinedResult

public string DefinedResult

Field Value

string

Event

public JobEvent Event

Field Value

JobEvent

Properties

DescriptionToStore

public string DescriptionToStore { get; }

Property Value

string

DisplayName

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

NameTypeDescription
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.

CreateCustom(string, string)

public static SupportedResponseEvent CreateCustom(string customEventID, string resourceID)

Parameters

NameTypeDescription
customEventID string
resourceID string

Returns

SupportedResponseEvent

CreateFromResourceID(JobEvent, string)

Creates a new SupportedResponseEvent, setting the DisplayName to the ResponseEvents string resource with the specified resource ID.

public static SupportedResponseEvent CreateFromResourceID(JobEvent jobEvent, string resourceID)

Parameters

NameTypeDescription
jobEvent JobEvent
resourceID string

Returns

SupportedResponseEvent

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.