Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetAllRequestBuilder<EntityT>

Create OData request to get multiple entities based on the configuration of the request. A GetAllRequestBuilder allows to restrict the response in multiple dimensions. The properties available in the response can be restricted by creating a selection, where no selection is equal to selecting all fields. The entities can be filtered and ordered based on the values of their properties. The number of entities in the result can be limited and results can be skipped for paging purposes. If none of the above mentioned are configured all entities of the given type will be requested.

Type parameters

  • EntityT: Entity

    Type of the entity to be requested

Hierarchy

  • MethodRequestBuilderBase<ODataGetAllRequestConfig<EntityT>>
    • GetAllRequestBuilder

Implements

  • EntityIdentifiable<EntityT>

Index

Constructors

constructor

Properties

Readonly _entity

_entity: EntityT

Readonly _entityConstructor

_entityConstructor: Constructable<EntityT>

Constructor of the entity to create the request for

requestConfig

requestConfig: ODataGetAllRequestConfig<EntityT>

Request configuration to initialize with

Methods

build

execute

filter

  • filter(...expressions: Filterable<EntityT>[]): this

orderBy

  • orderBy(...orderBy: Orderable<EntityT>[]): this

relativeUrl

  • relativeUrl(): string

select

skip

  • skip(skip: number): this

top

  • top(top: number): this

url

withCustomHeaders

  • withCustomHeaders(headers: MapType<string>): this

withCustomQueryParameters

  • withCustomQueryParameters(queryParameters: MapType<string>): this

withCustomServicePath

  • withCustomServicePath(servicePath: string): this