Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConsumedODataService

See: relevant section in reference guide

NOTE: This class is experimental and is subject to change in newer Model SDK versions.

In version 7.18.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsModule

containerAsModule: Module

documentation

documentation: string

entities

entities: IList<ODataEntity>

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

excluded

excluded: boolean

id

id: string

isLoaded

isLoaded: boolean

location

location: IConstant | null

locationQualifiedName

locationQualifiedName: string | null

metadata

metadata: string

metadataUrl

metadataUrl: string

model

model: IModel

name

name: string

proxyHost

proxyHost: IConstant | null

proxyHostQualifiedName

proxyHostQualifiedName: string | null

proxyPassword

proxyPassword: IConstant | null

proxyPasswordQualifiedName

proxyPasswordQualifiedName: string | null

proxyPort

proxyPort: IConstant | null

proxyPortQualifiedName

proxyPortQualifiedName: string | null

proxyType

proxyType: RequestProxyType

proxyUsername

proxyUsername: IConstant | null

proxyUsernameQualifiedName

proxyUsernameQualifiedName: string | null

qualifiedName

qualifiedName: string | null

serviceUrl

serviceUrl: string

structureTypeName

structureTypeName: string

unit

unit:

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

allProperties

asLoaded

  • asLoaded()

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

delete

  • delete(): void

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    • callback: function
        • (elem: ): void

        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static createIn

  • Creates a new ConsumedODataService unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

    Parameters

    Returns ConsumedODataService

Generated using TypeDoc