Class BinaryFieldBase<EntityT, SelectableT>

deprecated: Since v1.47.0. Use EdmTypeField instead. Represents a property with a binary value.

Type parameters

EntityT: EntityBase

Type of the entity the field belongs to
SelectableT: boolean = false

Hierarchy

EdmTypeField<EntityT, string, false, SelectableT>
- BinaryFieldBase
  - BinaryField
  - ComplexTypeBinaryPropertyField

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BinaryFieldBase<EntityT, SelectableT>(fieldName: string, _fieldOf: ConstructorOrField<EntityT, any>, edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4, fieldOptions?: FieldOptions<false, SelectableT>): BinaryFieldBase<EntityT, SelectableT>

Inherited from EdmTypeField.constructor
- Defined in packages/core/dist/odata-common/selectable/edm-type-field.d.ts:57
Creates an instance of EdmTypeField.

Type parameters
- EntityT: EntityBase<EntityT>
- SelectableT: boolean = false
Parameters
- fieldName: string
  
  Actual name of the field used in the OData request.
- _fieldOf: ConstructorOrField<EntityT, any>
  
  Constructor type of the entity the field belongs to.
- edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
  
  Type of the field according to the metadata description.
- Optional fieldOptions: FieldOptions<false, SelectableT>
  
  Optional settings for this field.
Returns BinaryFieldBase<EntityT, SelectableT>

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT, unknown>

Readonly _fieldName

_fieldName: string

Readonly _fieldOf

_fieldOf: ConstructorOrField<EntityT, any>

Readonly _fieldOptions

_fieldOptions: Required<FieldOptions<false, SelectableT>>

Readonly edmType

edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

Methods

equals

equals(value: string): Filter<EntityT, string>

Inherited from EdmTypeField.equals
- Defined in packages/core/dist/odata-common/selectable/edm-type-field.d.ts:63
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

Inherited from EdmTypeField.fieldPath
- Defined in packages/core/dist/odata-common/selectable/edm-type-field.d.ts:74
Path to the field to be used in filter and order by queries.

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

notEquals

notEquals(value: string): Filter<EntityT, string>

Inherited from EdmTypeField.notEquals
- Defined in packages/core/dist/odata-common/selectable/edm-type-field.d.ts:69
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

Copyright Ⓒ 2023 SAP SE or an SAP affiliate company. All rights reserved.