Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OperationMessageField<EntityT>

OperationMessageField

Type parameters

  • EntityT: Entity

    Type of the entity the complex type field belongs to.

Hierarchy

  • ComplexTypeField<EntityT>
    • OperationMessageField

Implements

  • EntityIdentifiable<EntityT>

Index

Constructors

Properties

Methods

Constructors

constructor

  • new OperationMessageField(fieldName: string, entityConstructor: Constructable<EntityT>, complexTypeName: string): OperationMessageField

  • Creates an instance of ComplexTypeField.

    Parameters

    • fieldName: string

      Actual name of the field used in the OData request

    • entityConstructor: Constructable<EntityT>

      Constructor type of the entity the field belongs to

    • complexTypeName: string

      Type of the field according to the metadata description

    Returns OperationMessageField

Properties

_entityConstructor

_entityConstructor: Constructable<EntityT>

_fieldName

_fieldName: string

complexTypeName

complexTypeName: string

message

message: ComplexTypeStringPropertyField<EntityT> = new ComplexTypeStringPropertyField('Message', this._entityConstructor, 'OperationMessage', 'Edm.String')

Representation of the OperationMessage.message property for query construction. Use to reference this property in query operations such as 'filter' in the fluent request API.

Methods

fieldPath

  • fieldPath(): string

  • Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.

    Returns string

    Path to the field to be used in filter and order by queries.