Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ODataRequest<RequestConfigT>

OData request configuration for an entity type.

typeparam

Type of the entity to setup a request for

Type parameters

  • RequestConfigT: ODataRequestConfig

Hierarchy

  • ODataRequest

Index

Constructors

constructor

  • Creates an instance of ODataRequest.

    memberof

    ODataRequest

    Parameters

    • config: RequestConfigT

      Configuration of the request

    • _destination: Destination

      Destination to setup the request against

    Returns ODataRequest

Properties

config

config: RequestConfigT

Configuration of the request

Accessors

destination

  • Returns Destination

  • Parameters

    Returns void

Methods

execute

  • execute(): Promise<any>
  • Execute the given request and return the according promise.

    Returns Promise<any>

    Promise resolving to the requested data

headers

  • headers(): Promise<MapType<string>>
  • Create object containing all headers, including custom headers for the given request.

    Returns Promise<MapType<string>>

    Key-value pairs where the key is the name of a header property and the value is the respective value

needsAuthentication

  • needsAuthentication(): boolean
  • Specifies whether the destination needs a specific authentication or not.

    memberof

    ODataRequest

    Returns boolean

    A boolean value that specifies whether the destination needs authentication or not

query

  • query(): string
  • Get query parameters as string. Leads with ? if there are parameters to return.

    Returns string

    Query parameter string

resourceUrl

  • resourceUrl(): string
  • Returns the URL to a specific OData resource, i.e. the entity collection.

    Returns string

    The URL of the resource

serviceUrl

  • serviceUrl(): string
  • Returns the service URL for a given OData request.

    Returns string

    The URL of the service the given entity belongs to

url

  • url(): string
  • Constructs the url for the request at hand.

    Returns string

    The url for the request