Interface: IODataProviderProxy¶

A designer-facing interface that provides access to a odata provider.

Hierarchy¶

IODataProviderProxy
IOfflineODataProviderProxy

Implemented by¶

Summary¶

Methods¶

Class Methods¶

Inherited Methods¶

Currently none inherited from the parent class(es).

Methods¶

getMetadata¶

▸ getMetadata(): ICsdlDocumentProxy

Returns the proxy of the $metadata associated with the data provider if available. Otherwise, it will be null. Any $metadata changes happening on the backend server after initializing the data service for the first time will not be reflected unless the users restart the application or call the refreshMetadata API.

Returns: ICsdlDocumentProxy

isDraftEnabled¶

▸ isDraftEnabled(entitySet: string): Boolean

Determine whether the entitySet is draft enabled

Parameters:

Name	Type
`entitySet`	string

Returns: Boolean

isInitialized¶

▸ isInitialized(): boolean

Determine whether the data provider is initialized

Returns: boolean

isOfflineEnabled¶

▸ isOfflineEnabled(): boolean

Determine whether the data provider is offline enabled

Returns: boolean

refreshMetadata¶

▸ refreshMetadata(): Promise‹boolean›

Reloads the latest $metadata from the backend server. It checks the compatibility between the current $metadata and the $metadata from the backend server, then updates the $metadata associated with the data provider if there is no conflict.

Returns: Promise‹boolean›

a promise with a boolean result indicating whether the $metadata was updated successfully.