Class OData

This is a generic OData service connector using odata-query package.

Hierarchy (View Summary)

WebApi
- OData

Index

Constructors

constructor

new OData(): OData
Returns OData
Inherited from WebApi.constructor
- Defined in core/src/services/WebApi.ts:39

Properties

`Protected`configManager

configManager: IConfigurationManager = ...

`Internal`httpClient

httpClient: IHttpClient

`Internal`responseCache

responseCache: Map<
string,
{ originalPromise: Promise<any>; responseValue?: any },
> = ...

In memory cache (short-lived storage)

Methods

callFetch

callFetch(callOptions: Partial<RemoteCallOptions>): Promise<any>
Parameters
- callOptions: Partial<RemoteCallOptions>
Returns Promise<any>
Inherited from WebApi.callFetch
- Defined in core/src/services/WebApi.ts:75

`Protected`configureHttpClient

configureHttpClient(): void
Configures the HttpClient with base url, default header, interceptors etc. Extension point for the child classes to alter the configuration for HttpClient.

Returns void
Inherited from WebApi.configureHttpClient
- Defined in core/src/services/WebApi.ts:206

create

create<T = unknown>(
    data: unknown,
    entityEndpoint: string,
    cancellationOptions?: RemoteCallCancellationOptions,
): Promise<T>
Adds a new entity object to the entity set specified by the query context
Type Parameters
- T = unknown
Parameters
- data: unknown
- entityEndpoint: string
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<T>
- Defined in core/src/services/OData.ts:113

delete

delete(
apiUrl: string,
cancellationOptions?: RemoteCallCancellationOptions,
): Promise<any>
Parameters
- apiUrl: string
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<any>
Inherited from WebApi.delete
- Defined in core/src/services/WebApi.ts:67

deleteById

deleteById(
    id: unknown,
    entityEndpoint: string,
    cancellationOptions?: RemoteCallCancellationOptions,
): Promise<void>
Deletes the item matching the id and the query context
Parameters
- id: unknown
- entityEndpoint: string
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<void>
- Defined in core/src/services/OData.ts:271

dispose

dispose(): void
Returns void
Inherited from WebApi.dispose
- Defined in core/src/services/WebApi.ts:46

download

download(
__namedParameters: Partial<DownloadOptions>,
): Promise<{ blob: Blob; headers: Headers }>
Parameters
- __namedParameters: Partial<DownloadOptions>
Returns Promise<{ blob: Blob; headers: Headers }>
Inherited from WebApi.download
- Defined in core/src/services/WebApi.ts:71

find

find<T = unknown>(
    id: unknown,
    queryContext: QueryContext<T>,
    cancellationOptions?: RemoteCallCancellationOptions,
): Promise<T>
Returns the item matching the id and the query context.
Type Parameters
- T = unknown
Parameters
- id: unknown
- queryContext: QueryContext<T>
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<T>
- Defined in core/src/services/OData.ts:38

get

get<T = any>(__namedParameters: Partial<RemoteGetOptions>): Promise<T>
Type Parameters
- T = any
Parameters
- __namedParameters: Partial<RemoteGetOptions>
Returns Promise<T>
Inherited from WebApi.get
- Defined in core/src/services/WebApi.ts:51

getAll

getAll<T = unknown>(
queryContext: QueryContext<T>,
cancellationOptions?: RemoteCallCancellationOptions,
): Promise<T[]>
Returns all items matching the query context.
Type Parameters
- T = unknown
Parameters
- queryContext: QueryContext<T>
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<T[]>
- Defined in core/src/services/OData.ts:59

getBaseUrl

getBaseUrl(): string
Returns string
Overrides WebApi.getBaseUrl
- Defined in core/src/services/OData.ts:275

getCount

getCount<T = unknown>(
queryContext: QueryContext<T>,
cancellationOptions?: RemoteCallCancellationOptions,
): Promise<number>
Returns the count of items matching the query context.
Type Parameters
- T = unknown
Parameters
- queryContext: QueryContext<T>
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<number>
- Defined in core/src/services/OData.ts:50

getNested

getNested<T>(options: ODataGetNestedOptions<T>, id: unknown): Promise<T>
Get an entity with nested entities.

This should be used instead of odata expansion if a large number of nested entities is possible.
Type Parameters
- T
Parameters
- options: ODataGetNestedOptions<T>
- id: unknown
Returns Promise<T>
- Defined in core/src/services/OData.ts:156

getPage

getPage<T = unknown>(
    pageNumber: number,
    queryContext: QueryContext<T>,
    cancellationOptions?: RemoteCallCancellationOptions,
): Promise<DataChunk<T>>
Returns the pageNumberth chunk matching the query context.
Type Parameters
- T = unknown
Parameters
- pageNumber: number
- queryContext: QueryContext<T>
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<DataChunk<T>>
- Defined in core/src/services/OData.ts:86

`Protected`handleNonOkResponse

handleNonOkResponse(
error: RemoteCallError,
callOptions: Partial<RemoteCallOptions>,
): Promise<unknown> | null
Parameters
- error: RemoteCallError
- callOptions: Partial<RemoteCallOptions>
Returns Promise<unknown> | null
Overrides WebApi.handleNonOkResponse
- Defined in core/src/services/OData.ts:279

patch

patch(__namedParameters: Partial<RemotePostPutOptions>): Promise<any>
Parameters
- __namedParameters: Partial<RemotePostPutOptions>
Returns Promise<any>
Inherited from WebApi.patch
- Defined in core/src/services/WebApi.ts:59

patchById

patchById(
    id: unknown,
    data: unknown,
    entityEndpoint: string,
    cancellationOptions?: RemoteCallCancellationOptions,
): Promise<unknown>
Patches the item matching the id and the query context
Parameters
- id: unknown
- data: unknown
- entityEndpoint: string
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<unknown>
- Defined in core/src/services/OData.ts:121

patchObject

patchObject(
    entityEndpoint: string,
    original: any,
    current: any,
    id?: unknown,
    cancellationOptions?: RemoteCallCancellationOptions,
): Promise<unknown>
Patches the object by computing delta(original, current). Note that it does not change either the original or current objects.
Parameters
- entityEndpoint: string
- original: any
- current: any
- id: unknown = null
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<unknown>
- Defined in core/src/services/OData.ts:130

patchOrCreateNested

patchOrCreateNested<T>(
    options: ODataPatchNestedOptions<T>,
    entityEndpoint: string,
    original: T | null | undefined,
    model: T,
): Promise<void>
Patch or create an entity with nested entities.

This also removes nested entities that no longer exist in the model.

If a collection is missing, it is assumed, that nothing in that collection has changed.

This implementation also assumes that the backend implements cascading delete operations for nested entities.
Type Parameters
- T
Parameters
- options: ODataPatchNestedOptions<T>
- entityEndpoint: string
- original: T | null | undefined
- model: T
Returns Promise<void>
- Defined in core/src/services/OData.ts:189

post

post(__namedParameters: Partial<RemotePostPutOptions>): Promise<any>
Parameters
- __namedParameters: Partial<RemotePostPutOptions>
Returns Promise<any>
Inherited from WebApi.post
- Defined in core/src/services/WebApi.ts:55

put

put(__namedParameters: Partial<RemotePostPutOptions>): Promise<any>
Parameters
- __namedParameters: Partial<RemotePostPutOptions>
Returns Promise<any>
Inherited from WebApi.put
- Defined in core/src/services/WebApi.ts:63

query

query<T = unknown>(
queryContext: QueryContext<T>,
cancellationOptions?: RemoteCallCancellationOptions,
): Promise<T[]>
Perform ad-hoc GET query on odata.
Type Parameters
- T = unknown
Parameters
- queryContext: QueryContext<T>
- cancellationOptions: RemoteCallCancellationOptions = {}
Returns Promise<T[]>
- Defined in core/src/services/OData.ts:29

Class OData

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns OData

Properties

ProtectedconfigManager

InternalhttpClient

InternalresponseCache

Methods

callFetch

Parameters

Returns Promise<any>

ProtectedconfigureHttpClient

Returns void

create

Type Parameters

Parameters

Returns Promise<T>

delete

Parameters

Returns Promise<any>

deleteById

Parameters

Returns Promise<void>

dispose

Returns void

download

Parameters

Returns Promise<{ blob: Blob; headers: Headers }>

find

Type Parameters

Parameters

Returns Promise<T>

get

Type Parameters

Parameters

Returns Promise<T>

getAll

Type Parameters

Parameters

Returns Promise<T[]>

getBaseUrl

Returns string

getCount

Type Parameters

Parameters

Returns Promise<number>

getNested

Type Parameters

Parameters

Returns Promise<T>

getPage

Type Parameters

Parameters

Returns Promise<DataChunk<T>>

ProtectedhandleNonOkResponse

Parameters

Returns Promise<unknown> | null

patch

Parameters

Returns Promise<any>

patchById

Parameters

Returns Promise<unknown>

patchObject

Parameters

Returns Promise<unknown>

patchOrCreateNested

Type Parameters

Parameters

Returns Promise<void>

post

Parameters

Returns Promise<any>

put

`Protected`configManager

`Internal`httpClient

`Internal`responseCache

`Protected`configureHttpClient

`Protected`handleNonOkResponse