Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PublishedODataService2

See: relevant section in reference guide

In version 10.4.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "ODataPublish$PublishedODataService2"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

allowedModuleRoles

allowedModuleRolesQualifiedNames

  • get allowedModuleRolesQualifiedNames(): string[]

  • Returns string[]

authenticationMicroflow

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

authenticationMicroflowQualifiedName

  • get authenticationMicroflowQualifiedName(): null | string

  • Returns null | string

authenticationTypes

container

  • get container(): TContainer

containerAsFolderBase

containerAsModule

  • get containerAsModule(): Module

description

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

documentation

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

entitySets

entityTypes

enumerations

excluded

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

exportLevel

  • In version 9.3.0: introduced

    Returns ExportLevel

  • In version 9.3.0: introduced

    Parameters

    Returns void

includeMetadataByDefault

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

  • In version 10.8.0: introduced

    Returns boolean

  • In version 10.8.0: introduced

    Parameters

    • newValue: boolean

    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

microflows

model

  • get model(): TModel

name

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

namespace

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

oDataVersion

path

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

publishAssociations

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

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

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

replaceIllegalChars

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

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

serviceName

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

summary

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

  • Returns string

  • Parameters

    • newValue: string

    Returns void

supportsGraphQL

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

  • In version 10.12.0: introduced

    Returns boolean

  • In version 10.12.0: introduced

    Parameters

    • newValue: boolean

    Returns void

unit

  • get unit(): this

useGeneralization

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

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

version

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

  • Returns string

  • 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 PublishedODataService2

delete

  • delete(): void

findElementById

Protected getContainerAs

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

load

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

traversePublicParts

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

Static createIn

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

    Parameters

    Returns PublishedODataService2

Generated using TypeDoc