Class: CsdlDocumentProxy¶
A designer-facing interface that provides access to the $metadata of a odata provider.
Hierarchy¶
- CsdlDocumentProxy
Implements¶
Summary¶
Constructors¶
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
Implementation of ICsdlDocumentProxy
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.
Returns: string
getOriginalText¶
▸ getOriginalText(): string
Implementation of ICsdlDocumentProxy
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.
Returns: string
getResolvedText¶
▸ getResolvedText(): string
Implementation of ICsdlDocumentProxy
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.
Returns: string
getVersionCode¶
▸ getVersionCode(): number
Implementation of ICsdlDocumentProxy
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).
Returns: number
getVersionText¶
▸ getVersionText(): string
Implementation of ICsdlDocumentProxy
Returns text for the OData version, e.g. "4.0".
Returns: string