Options
All
  • Public
  • Public/Protected
  • All
Menu

Representation of a filter function, that returns a value of type string.

Type parameters

Hierarchy

Index

Constructors

constructor

  • Creates an instance of StringFilterFunction.

    Type parameters

    Parameters

    • functionName: string

      Name of the function that returns a string value

    • parameters: FilterFunctionParameterType<EntityT>[]

      Representation of the parameters passed to the filter function

    Returns StringFilterFunction<EntityT>

Properties

Readonly edmType

edmType: EdmTypeShared<ODataVersionOf<EntityT>>

Readonly functionName

functionName: string

Readonly parameters

parameters: FilterFunctionParameterType<EntityT>[]

Methods

equals

  • equals(value: string): Filter<EntityT, string>
  • Creates an instance of Filter for this filter function 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

notEquals

  • notEquals(value: string): Filter<EntityT, string>
  • Creates an instance of Filter for this filter function 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

toString

  • toString(parentFieldNames?: string[]): string
  • deprecated

    Since v1.21.0. There will be no replacement. Let us know if you were using this functionality. Serializes the filter function into a string

    Parameters

    • Optional parentFieldNames: string[]

      Names of parents in case the function is part of a filter on a navigation property

    Returns string

    The filter function as string