Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConsumedODataService

See: relevant section in reference guide

In version 10.0.0: removed experimental In version 7.18.0: introduced

Hierarchy

  • RemoteEntitySourceDocument
    • ConsumedODataService

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Rest$ConsumedODataService"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

applicationId

  • get applicationId(): string
  • set applicationId(newValue: string): void

  • In version 8.12.0: added public In version 8.11.0: introduced

    Returns string

  • In version 8.12.0: added public In version 8.11.0: introduced

    Parameters

    • newValue: string

    Returns void

catalogUrl

  • get catalogUrl(): string
  • set catalogUrl(newValue: string): void

  • In version 8.10.0: introduced

    Returns string

  • In version 8.10.0: introduced

    Parameters

    • newValue: string

    Returns void

configurationMicroflow

  • get configurationMicroflow(): null | IMicroflow
  • set configurationMicroflow(newValue: null | IMicroflow): void

  • In version 10.12.0: introduced

    Returns null | IMicroflow

  • In version 10.12.0: introduced

    Parameters

    Returns void

configurationMicroflowQualifiedName

  • get configurationMicroflowQualifiedName(): null | string

  • Returns null | string

container

  • get container(): TContainer

containerAsFolderBase

containerAsModule

  • get containerAsModule(): Module

description

  • get description(): string
  • set description(newValue: string): void

  • In version 8.10.0: introduced

    Returns string

  • In version 8.10.0: introduced

    Parameters

    • newValue: string

    Returns void

documentation

  • get documentation(): string
  • set documentation(newValue: string): void

  • In version 9.10.0: added public

    Returns string

  • In version 9.10.0: added public

    Parameters

    • newValue: string

    Returns void

endpointId

  • get endpointId(): string
  • set endpointId(newValue: string): void

  • In version 8.14.0: introduced

    Returns string

  • In version 8.14.0: introduced

    Parameters

    • newValue: string

    Returns void

environmentType

errorHandlingMicroflow

  • get errorHandlingMicroflow(): null | IMicroflow
  • set errorHandlingMicroflow(newValue: null | IMicroflow): void

  • In version 9.6.0: introduced

    Returns null | IMicroflow

  • In version 9.6.0: introduced

    Parameters

    Returns void

errorHandlingMicroflowQualifiedName

  • get errorHandlingMicroflowQualifiedName(): null | string

  • Returns null | string

excluded

  • get excluded(): boolean
  • set excluded(newValue: boolean): void

  • In version 9.11.0: added public

    Returns boolean

  • In version 9.11.0: added public

    Parameters

    • newValue: boolean

    Returns void

exportLevel

  • In version 9.3.0: introduced

    Returns ExportLevel

  • In version 9.3.0: introduced

    Parameters

    Returns void

headersMicroflow

  • In version 10.12.0: deleted In version 8.4.0: introduced

    Returns null | IMicroflow

  • In version 10.12.0: deleted In version 8.4.0: introduced

    Parameters

    Returns void

headersMicroflowQualifiedName

  • get headersMicroflowQualifiedName(): null | string

  • Returns null | string

httpConfiguration

icon

  • get icon(): null | string
  • set icon(newValue: null | string): void

  • In version 8.11.0: added public In version 8.10.0: introduced

    Returns null | string

  • In version 8.11.0: added public In version 8.10.0: introduced

    Parameters

    • newValue: null | string

    Returns void

isLoadable

  • get isLoadable(): boolean

  • Whether this unit and all of its children (recursively) can be loaded.

    Returns boolean

isLoaded

  • get isLoaded(): boolean

  • Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

    Returns boolean

isReadOnly

  • get isReadOnly(): boolean

  • Whether this unit and all of its children (recursively) are editable.

    Returns boolean

lastUpdated

  • get lastUpdated(): string
  • set lastUpdated(newValue: string): void

metadata

  • get metadata(): string
  • set metadata(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

metadataHash

  • get metadataHash(): string
  • set metadataHash(newValue: string): void

  • In version 8.16.0: introduced

    Returns string

  • In version 8.16.0: introduced

    Parameters

    • newValue: string

    Returns void

metadataReferences

metadataUrl

  • get metadataUrl(): string
  • set metadataUrl(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

minimumMxVersion

  • get minimumMxVersion(): string
  • set minimumMxVersion(newValue: string): void

model

  • get model(): TModel

name

  • get name(): string
  • set name(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

oDataVersion

  • In version 8.6.0: introduced

    Returns ODataVersion

  • In version 8.6.0: introduced

    Parameters

    Returns void

proxyHost

proxyHostQualifiedName

  • get proxyHostQualifiedName(): null | string

  • Returns null | string

proxyPassword

proxyPasswordQualifiedName

  • get proxyPasswordQualifiedName(): null | string

  • Returns null | string

proxyPort

proxyPortQualifiedName

  • get proxyPortQualifiedName(): null | string

  • Returns null | string

proxyType

proxyUsername

proxyUsernameQualifiedName

  • get proxyUsernameQualifiedName(): null | string

  • Returns null | string

qualifiedName

  • get qualifiedName(): null | string

  • Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

    Returns null | string

recommendedMxVersion

  • get recommendedMxVersion(): string
  • set recommendedMxVersion(newValue: string): void

serviceId

  • get serviceId(): string
  • set serviceId(newValue: string): void

  • In version 8.14.0: deleted In version 8.0.0: introduced

    Returns string

  • In version 8.14.0: deleted In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns void

serviceName

  • get serviceName(): string
  • set serviceName(newValue: string): void

  • In version 8.10.0: added public In version 8.0.0: introduced

    Returns string

  • In version 8.10.0: added public In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns void

timeoutExpression

  • get timeoutExpression(): string
  • set timeoutExpression(newValue: string): void

  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    In version 8.5.0: introduced

    Returns string

  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    In version 8.5.0: introduced

    Parameters

    • newValue: string

    Returns void

unit

  • get unit(): this

  • Unit that owns/contains this thing.

    Returns this

useQuerySegment

  • get useQuerySegment(): boolean
  • set useQuerySegment(newValue: boolean): void

  • In version 9.6.0: introduced

    Returns boolean

  • In version 9.6.0: introduced

    Parameters

    • newValue: boolean

    Returns void

validated

  • get validated(): boolean
  • set validated(newValue: boolean): void

  • In version 9.6.0: introduced

    Returns boolean

  • In version 9.6.0: introduced

    Parameters

    • newValue: boolean

    Returns void

validatedEntities

  • get validatedEntities(): IList<string>

version

  • get version(): string
  • set version(newValue: string): void

  • In version 8.10.0: added public In version 8.0.0: introduced

    Returns string

  • In version 8.10.0: added public In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns void

versionApiMockResults

  • get versionApiMockResults(): string
  • set versionApiMockResults(newValue: string): void

  • In version 8.14.0: deleted In version 8.13.0: introduced

    Returns string

  • In version 8.14.0: deleted In version 8.13.0: introduced

    Parameters

    • newValue: string

    Returns void

Methods

allProperties

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.

    Returns ConsumedODataService

delete

  • delete(): void

  • Deletes this element from the model.

    Returns void

findElementById

Protected getContainerAs

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

  • Type parameters

    Parameters

    • containerType: any

    Returns T

load

  • 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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<ConsumedODataService>

loadedProperties

publicProperties

toJSON

  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IAbstractElementJson

traverse

  • traverse(visit: (structure: IStructure) => void): void

  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T

  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): 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