Skip to content

Class: CsdlDocumentProxy

CsdlDocumentProxy provides access to the $metadata of a OData provider.

Implements

Summary

Constructors

Properties

Class Properties

Currently none in this class.

Inherited Properties

Currently none inherited from the parent class(es).

Accessors

Class Accessors

Currently none in this class.

Inherited Accessors

Currently none inherited from the parent class(es).

Methods

Class Methods

Inherited Methods

Currently none inherited from the parent class(es).

Constructors

Constructor

+ new CsdlDocumentProxy(csdlDocument: CsdlDocument): CsdlDocumentProxy

Parameters:

Name Type
csdlDocument CsdlDocument

Returns: CsdlDocumentProxy

Methods

getCompactXML

getCompactXML(): string

Returns the original $metadata content as a minified XML string with unnecessary information removed if retainOriginalText in the CSDLOptions is enabled. Otherwise, an error message indicating the missing CSDL option will be returned.

Implementation of ICsdlDocumentProxy.getCompactXML

Returns: string


getOriginalText

getOriginalText(): string

Returns the original $metadata content as a XML string if retainOriginalText in the CSDLOptions is enabled. Otherwise, an error message indicating the missing CSDL option will be returned.

Implementation of ICsdlDocumentProxy.getOriginalText

Returns: string


getResolvedText

getResolvedText(): string

Returns the resolved $metadata content as a XML string, with inline references and expanded aliases, if retainResolvedText in the CSDLOptions is enabled. Otherwise, an error message indicating the missing CSDL option will be returned.

Implementation of ICsdlDocumentProxy.getResolvedText

Returns: string


getVersionCode

getVersionCode(): number

Returns code for the OData version, e.g. 400. If the OData version is considered as a decimal number (e.g. 4.0), then multiplying by 100 will give the code (e.g. 400).

Implementation of ICsdlDocumentProxy.getVersionCode

Returns: number


getVersionText

getVersionText(): string

Returns text for the OData version, e.g. "4.0".

Implementation of ICsdlDocumentProxy.getVersionText

Returns: string