Options
All
  • Public
  • Public/Protected
  • All
Menu

ReturnMessageField

Type parameters

  • EntityT: Entity

    Type of the entity the complex type field belongs to.

Hierarchy

  • ComplexTypeField<EntityT>
    • ReturnMessageField

Implements

  • EntityIdentifiable<EntityT>

Index

Constructors

constructor

  • new ReturnMessageField(fieldName: string, entityConstructor: Constructable<EntityT>, complexTypeName: string): ReturnMessageField
  • 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 ReturnMessageField

Properties

complexTypeName

complexTypeName: string

entityConstructor

entityConstructor: Constructable<EntityT>

fieldName

fieldName: string

message

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

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

messageType

messageType: ComplexTypeStringPropertyField<EntityT> = new ComplexTypeStringPropertyField('MessageType', this.entityConstructor, 'ReturnMessage', 'Edm.String')

Representation of the ReturnMessage.messageType 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.