Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NavigationProfile

In version 7.2.0: added public

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

appIcon

  • In version 8.12.0: introduced

    Returns IImage | null

  • In version 8.12.0: introduced

    Parameters

    Returns any

appIconQualifiedName

  • get (): string | null

  • Returns string | null

appTitle

  • get (): Text
  • set (newValue: Text): any

  • In version 8.12.0: introduced

    Returns Text

  • In version 8.12.0: introduced

    Parameters

    Returns any

applicationTitle

  • get (): string
  • set (newValue: string): any

  • In version 8.12.0: deleted

    Returns string

  • In version 8.12.0: deleted

    Parameters

    • newValue: string

    Returns any

container

containerAsNavigationDocument

enabled

  • get (): boolean
  • set (newValue: boolean): any

  • In version 7.2.0: deleted

    Returns boolean

  • In version 7.2.0: deleted

    Parameters

    • newValue: boolean

    Returns any

homePage

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

kind

  • In version 7.2.0: introduced

    Returns ProfileKind

  • In version 7.2.0: introduced

    Parameters

    Returns any

loginPageSettings

  • In version 7.0.2: introduced

    Returns PageSettings

  • In version 7.0.2: introduced

    Parameters

    Returns any

menuItemCollection

model

name

  • get (): string
  • set (newValue: string): any

offlineEnabled

  • get (): boolean
  • set (newValue: boolean): any

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

offlineEnabled6

  • get (): boolean
  • set (newValue: boolean): any

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

qualifiedName

  • get (): string | null

roleBasedHomePages

unit

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

  • 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: this): void

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

traverse

  • traverse(visit: function): void

traverseFind

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

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • 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

    Returns NavigationProfile

Static createIn

  • 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

Static createInNavigationDocumentUnderDesktopProfile

  • 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

Static createInNavigationDocumentUnderHybridPhoneProfile

  • 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

Static createInNavigationDocumentUnderHybridPhoneProfile6

  • 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

Static createInNavigationDocumentUnderHybridTabletProfile

  • 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

Static createInNavigationDocumentUnderHybridTabletProfile6

  • 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

Static createInNavigationDocumentUnderOfflinePhoneProfile

  • 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

Static createInNavigationDocumentUnderPhoneProfile

  • 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

Static createInNavigationDocumentUnderProfiles

  • 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

Static createInNavigationDocumentUnderTabletProfile

  • 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