Options
All
  • Public
  • Public/Protected
  • All
Menu

In version 7.22.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

__bottomBarItems: PartListProperty<BottomBarItem> = ...
internal
__encryptionDbEnabled: PrimitiveProperty<boolean> = ...
internal
__homePage: ByNameReferenceProperty<IPage> = ...
internal
__localFileEncryptionEnabled: PrimitiveProperty<boolean> = ...
internal
__loggingEnabled: PrimitiveProperty<boolean> = ...
internal
__name: PrimitiveProperty<string> = ...
internal
__nativeHomePage: PartProperty<NativeHomePage> = ...
internal
__offlineEntityConfigs: PartListProperty<OfflineEntityConfig> = ...
internal
__otaEnabled: PrimitiveProperty<boolean> = ...
internal
__roleBasedNativeHomePages: PartListProperty<RoleBasedNativeHomePage> = ...
internal
_container: null | IContainer
internal
_declaredAsNamespace: boolean = false
internal
_isDoingDelete: boolean = false
internal
_isPartial: boolean
internal
_isReverting: boolean = false

Indicates that the internal data of this element is being reverted to its previous value, so some validation check could be skipped

internal
_isUpdating: boolean = true

Indicates that the internal data of this element is being updated, as a result of data received from the server, so no storage events should be send

internal
internal
_registeredQualifiedName: null | string = null

used by qualified names cache to determine old name after a rename

internal
_state: StructureState = "attached"

The current state of the structure: (new|attached|detached|deleted).

internal
internal
id: string
structureTypeName: string
structureTypeName: string = "Navigation$NativeNavigationProfile"
versionInfo: StructureVersionInfo = ...

Accessors

  • get _isAttached(): boolean
  • This structure is attached somewhere in the model. This is the "normal" state for an structure.

    internal

    Returns boolean

  • get _isDeleted(): boolean
  • This structure has been deleted and should no longer be used.

    internal

    Returns boolean

  • get _isDetached(): boolean
  • This structure is detached, so that it can be attached somewhere else in the model.

    internal

    Returns boolean

  • get _isNew(): boolean
  • This structure was just constructed and has not been added to the model yet.

    internal

    Returns boolean

  • get container(): TContainer
  • get encryptionDbEnabled(): boolean
  • set encryptionDbEnabled(newValue: boolean): void
  • In version 9.18.0: introduced

    Returns boolean

  • In version 9.18.0: introduced

    Parameters

    • newValue: boolean

    Returns void

  • get homePage(): null | IPage
  • set homePage(newValue: null | IPage): void
  • In version 9.4.0: deleted

    Returns null | IPage

  • In version 9.4.0: deleted

    Parameters

    Returns void

  • get homePageQualifiedName(): null | string
  • Returns null | string

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

  • get localFileEncryptionEnabled(): boolean
  • set localFileEncryptionEnabled(newValue: boolean): void
  • In version 9.22.0: introduced

    Returns boolean

  • In version 9.22.0: introduced

    Parameters

    • newValue: boolean

    Returns void

  • get loggingEnabled(): boolean
  • set loggingEnabled(newValue: boolean): void
  • In version 9.15.0: introduced

    Returns boolean

  • In version 9.15.0: introduced

    Parameters

    • newValue: boolean

    Returns void

  • get model(): TModel
  • get name(): string
  • set name(newValue: string): void
  • In version 7.2.0: introduced

    Returns string

  • In version 7.2.0: introduced

    Parameters

    • newValue: string

    Returns void

  • get otaEnabled(): boolean
  • set otaEnabled(newValue: boolean): void
  • In version 9.4.0: introduced

    Returns boolean

  • In version 9.4.0: introduced

    Parameters

    • newValue: boolean

    Returns void

  • 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

Methods

  • _deleteInternal(): void
  • _dispose(): void
  • _getQualifiedName(): null | string
  • _initializeDefaultProperties(): void
  • _initializeNewInstance(): void
  • _isByNameReferrable(): boolean
  • Return true if this is an abstractElement that might be referred to by some other element. If true, this element is maintained in the qualifiedNamesCache

    internal

    Returns boolean

  • _markCurrentValuesAsDefaults(): void
  • _processLocalNameChange(previousName: null | string): void
  • _processNameChange(): void
  • If the name of a model element changes, this might effect currently broken references-by-name, so let's process those.

    internal

    Returns void

  • _registerProperty(prop: AbstractProperty<any, any>, declaredOn: IStructureClass): void
  • _scheduleDeltaAfterCreate(delta: Delta): void
  • _sendChangeDelta(propertyName: string, newValue: any, changeType?: "CHANGE" | "ADD" | "REMOVE", index?: number): void
  • Sends the change delta in case a simple property has changed.

    internal

    Parameters

    • propertyName: string
    • newValue: any
    • changeType: "CHANGE" | "ADD" | "REMOVE" = "CHANGE"
    • index: number = -1

    Returns void

  • _sendDeleteDelta(): void
  • _sendDetachDelta(): void
  • 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 NativeNavigationProfile

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • resolveByIdReferences(): void
  • toJSON(): IStructureJSON
  • 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 IStructureJSON

  • traverse(visit: (structure: IStructure) => void): void
  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates and returns a new NativeNavigationProfile instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    • model: IModel

    Returns NativeNavigationProfile

  • Creates and returns a new NativeNavigationProfile instance in the SDK and on the server. The new NativeNavigationProfile will be automatically stored in the 'profiles' property of the parent NavigationDocument element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.22.0 and higher

    Parameters

    Returns NativeNavigationProfile

Generated using TypeDoc