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

Properties

config

config: RequestConfigT

Configuration of the request

Accessors

destination

Methods

customHeaders

  • customHeaders(): Record<string, any>

defaultHeaders

  • defaultHeaders(): Record<string, any>
  • Get all default headers. If custom headers are set, those take precedence.

    Returns Record<string, any>

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

eTagHeaders

  • eTagHeaders(): Record<string, any>

execute

headers

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

    Returns Promise<Record<string, any>>

    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

relativeResourceUrl

  • relativeResourceUrl(includeServicePath?: boolean): string
  • Returns the relative URL to a specific OData resource.

    Parameters

    • Default value includeServicePath: boolean = true

      Whether or not to include the service path in the URL.

    Returns string

    The relative URL of the resource.

relativeServiceUrl

  • relativeServiceUrl(): string

relativeUrl

  • relativeUrl(includeServicePath?: boolean): string
  • Constructs a URL relative to the destination.

    Parameters

    • Default value includeServicePath: boolean = true

      Whether or not to include the service path in the URL.

    Returns string

    The relative URL for the request.

resourceUrl

  • resourceUrl(): string

serviceUrl

  • serviceUrl(): string

url

  • url(): string