Options
All
  • Public
  • Public/Protected
  • All
Menu

In version 7.2.0: added public

Hierarchy

Implements

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Navigation$NavigationProfile"
versionInfo: StructureVersionInfo = ...

Accessors

  • get appIcon(): null | IImage
  • set appIcon(newValue: null | IImage): void
  • In version 8.12.0: introduced

    Returns null | IImage

  • In version 8.12.0: introduced

    Parameters

    Returns void

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

  • get appTitle(): Text
  • set appTitle(newValue: Text): void
  • In version 8.12.0: introduced

    Returns Text

  • In version 8.12.0: introduced

    Parameters

    Returns void

  • get applicationTitle(): string
  • set applicationTitle(newValue: string): void
  • In version 8.12.0: deleted

    Returns string

  • In version 8.12.0: deleted

    Parameters

    • newValue: string

    Returns void

  • get container(): TContainer
  • get enabled(): boolean
  • set enabled(newValue: boolean): void
  • In version 7.2.0: deleted

    Returns boolean

  • In version 7.2.0: deleted

    Parameters

    • newValue: boolean

    Returns void

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

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

    Returns boolean

  • In version 7.2.0: introduced

    Returns ProfileKind

  • In version 7.2.0: introduced

    Parameters

    Returns void

  • In version 7.0.2: introduced

    Returns PageSettings

  • In version 7.0.2: introduced

    Parameters

    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 offlineEnabled(): boolean
  • set offlineEnabled(newValue: boolean): void
  • In version 7.2.0: deleted In version 7.0.2: introduced

    Returns boolean

  • In version 7.2.0: deleted In version 7.0.2: introduced

    Parameters

    • newValue: boolean

    Returns void

  • get offlineEnabled6(): boolean
  • set offlineEnabled6(newValue: boolean): void
  • In version 7.0.0: deleted In version 6.10.4: introduced

    Returns boolean

  • In version 7.0.0: deleted In version 6.10.4: 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

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

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

  • Creates and returns a new NavigationProfile instance in the SDK and on the server. The new NavigationProfile 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.2.0 and higher

    Parameters

    Returns NavigationProfile

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.1.0

    Parameters

    Returns NavigationProfile

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.0.2 to 7.1.0

    Parameters

    Returns NavigationProfile

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.10.4 to 6.10.4

    Parameters

    Returns NavigationProfile

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.0.2 to 7.1.0

    Parameters

    Returns NavigationProfile

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.10.4 to 6.10.4

    Parameters

    Returns NavigationProfile

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.0.1

    Parameters

    Returns NavigationProfile

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.1.0

    Parameters

    Returns NavigationProfile

  • Creates and returns a new NavigationProfile instance in the SDK and on the server. The new NavigationProfile 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.2.0 and higher

    Parameters

    Returns NavigationProfile

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.1.0

    Parameters

    Returns NavigationProfile

Generated using TypeDoc