Class CorporateActionsWireStrings

Namespace

DatabentoDotNet.Reference

Assembly

DatabentoDotNet.Reference.dll

Wire-string conversions for the enums the corporate_actions.* endpoints carry.

public static class CorporateActionsWireStrings

Inheritance

object

CorporateActionsWireStrings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Named for its endpoint group, as SecurityMasterWireStrings is, and holding to the same contract as WireStrings: ToWireString throws ArgumentOutOfRangeException for a value outside the defined set rather than inventing a spelling for it. It holds one method because this endpoint group has one enum on the request side — the ten open code types and eight closed ones its response carries are ReferenceWireStrings' business, and list_enums'.

There is deliberately no TryParseCorporateActionIndex, for the reason SecurityMasterWireStrings gives about its own: no reference response carries an index, so a parse direction would be public surface with no caller and no wire to check it against.

Methods

ToWireString(CorporateActionIndex)

Returns the wire string for value.

public static string ToWireString(this CorporateActionIndex value)

Parameters

value CorporateActionIndex

The index.

Returns

string

The wire string.

Remarks

The three spellings are upstream's Display impl (corporate.rs:445-452), and they are the names of the response fields they filter on — so a spelling that drifted from EventDate, ExDate or TsRecord would be wrong in a way the model itself records.

Exceptions

ArgumentOutOfRangeException

value is not a defined CorporateActionIndex.