Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StringField<EntityT>

Represents a selectable property with a string value.

Type parameters

  • EntityT: Entity

    Type of the entity the field belongs to

Hierarchy

  • StringFieldBase<EntityT>
    • StringField

Implements

Index

Constructors

constructor

  • new StringField(fieldName: string, entityConstructor: Constructable<EntityT>, edmType: EdmType): StringField
  • Creates an instance of EdmTypeField.

    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

    • edmType: EdmType

      Type of the field according to the metadata description

    Returns StringField

Properties

edmType

edmType: EdmType

Type of the field according to the metadata description

entityConstructor

entityConstructor: Constructable<EntityT>

Constructor type of the entity the field belongs to

fieldName

fieldName: string

Actual name of the field used in the OData request

selectable

selectable: true

Methods

equals

  • equals(value: string): Filter<EntityT, string>
  • Creates an instance of Filter for this field and the given value using the operator 'eq', i.e. ==.

    Parameters

    • value: string

      Value to be used in the filter

    Returns Filter<EntityT, string>

    The resulting filter

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.

getExpands

  • getExpands(): string[]

getSelects

  • getSelects(): string[]

notEquals

  • notEquals(value: string): Filter<EntityT, string>
  • Creates an instance of Filter for this field and the given value using the operator 'ne', i.e. !=.

    Parameters

    • value: string

      Value to be used in the filter

    Returns Filter<EntityT, string>

    The resulting filter