NativeNavigationProfile | Mendix Model SDK

In version 7.22.0: introduced

Hierarchy

NavigationProfileBase
- NativeNavigationProfile

Implements

INativeNavigationProfile

Constructors

constructor

new NativeNavigationProfile(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit<IAbstractModel>, container: AbstractElement<IAbstractModel, Container>): NativeNavigationProfile

Overrides NavigationProfileBase.constructor
Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit<IAbstractModel>
- container: AbstractElement<IAbstractModel, Container>
Returns NativeNavigationProfile

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Navigation$NativeNavigationProfile"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

applyScreenTransition

get applyScreenTransition(): boolean
set applyScreenTransition(newValue: boolean): void

In version 10.11.0: introduced

Returns boolean
In version 10.11.0: introduced

Parameters
- newValue: boolean
Returns void

container

get container(): TContainer

Implementation of INativeNavigationProfile.container
Inherited from NavigationProfileBase.container
Returns TContainer

containerAsNavigationDocument

get containerAsNavigationDocument(): NavigationDocument

Implementation of INativeNavigationProfile.containerAsNavigationDocument
Overrides NavigationProfileBase.containerAsNavigationDocument
Returns NavigationDocument

encryptionDbEnabled

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

hermesEnabled

get hermesEnabled(): boolean
set hermesEnabled(newValue: boolean): void

In version 10.18.0: deleted In version 10.11.0: introduced

Returns boolean
In version 10.18.0: deleted In version 10.11.0: introduced

Parameters
- newValue: boolean
Returns void

homePage

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
- newValue: null | IPage
Returns void

homePageQualifiedName

get homePageQualifiedName(): null | string

Returns null | string

isLoaded

get isLoaded(): boolean

Implementation of INativeNavigationProfile.isLoaded
Inherited from NavigationProfileBase.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

localFileEncryptionEnabled

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

loggingEnabled

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

model

get model(): TModel

Implementation of INativeNavigationProfile.model
Inherited from NavigationProfileBase.model
Returns TModel

name

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

Implementation of INativeNavigationProfile.name
Inherited from NavigationProfileBase.name

In version 7.2.0: introduced

Returns string
Implementation of INativeNavigationProfile.name
Inherited from NavigationProfileBase.name

In version 7.2.0: introduced

Parameters
- newValue: string
Returns void

nativeHomePage

get nativeHomePage(): NativeHomePage
set nativeHomePage(newValue: NativeHomePage): void

In version 9.4.0: introduced

Returns NativeHomePage
In version 9.4.0: introduced

Parameters
- newValue: NativeHomePage
Returns void

networkTimeoutMs

get networkTimeoutMs(): number
set networkTimeoutMs(newValue: number): void

In version 11.0.0: introduced

Returns number
In version 11.0.0: introduced

Parameters
- newValue: number
Returns void

otaEnabled

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

popupNavigationTransition

get popupNavigationTransition(): PopupNavigationTransition
set popupNavigationTransition(newValue: PopupNavigationTransition): void

In version 10.11.0: introduced

Returns PopupNavigationTransition
In version 10.11.0: introduced

Parameters
- newValue: PopupNavigationTransition
Returns void

qualifiedName

get qualifiedName(): null | string

Implementation of INativeNavigationProfile.qualifiedName
Inherited from NavigationProfileBase.qualifiedName

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

roleBasedNativeHomePages

get roleBasedNativeHomePages(): IList<RoleBasedNativeHomePage>

In version 8.0.0: introduced

Returns IList<RoleBasedNativeHomePage>

screenNavigationTransition

get screenNavigationTransition(): ScreenNavigationTransition
set screenNavigationTransition(newValue: ScreenNavigationTransition): void

In version 10.11.0: introduced

Returns ScreenNavigationTransition
In version 10.11.0: introduced

Parameters
- newValue: ScreenNavigationTransition
Returns void

sessionCookieEncryptionEnabled

get sessionCookieEncryptionEnabled(): boolean
set sessionCookieEncryptionEnabled(newValue: boolean): void

In version 10.21.0: introduced

Returns boolean
In version 10.21.0: introduced

Parameters
- newValue: boolean
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

Implementation of INativeNavigationProfile.unit
Inherited from NavigationProfileBase.unit

Unit that owns/contains this thing.

Returns ModelUnit<IAbstractModel>

Methods

allProperties

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

Implementation of INativeNavigationProfile.allProperties
Inherited from NavigationProfileBase.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): NativeNavigationProfile

Implementation of INativeNavigationProfile.asLoaded
Inherited from NavigationProfileBase.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 NativeNavigationProfile

deepCopy

deepCopy(targetModel: IAbstractModel): NativeNavigationProfile

Inherited from NavigationProfileBase.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns NativeNavigationProfile

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }

Inherited from NavigationProfileBase.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }
- copy: Element<IAbstractModel>
- idMap: IMap<Structure<IAbstractModel, null | IContainer>>

delete

delete(): void

Inherited from NavigationProfileBase.delete

Deletes this element from the model.

Returns void

detach

detach(): NativeNavigationProfile

Inherited from NavigationProfileBase.detach

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

Returns NativeNavigationProfile

findElementById

findElementById(id: string): null | AbstractElement<IAbstractModel, Container>

Implementation of INativeNavigationProfile.findElementById
Inherited from NavigationProfileBase.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns null | AbstractElement<IAbstractModel, Container>

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from NavigationProfileBase.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: (elem: NativeNavigationProfile) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<NativeNavigationProfile>

Implementation of INativeNavigationProfile.load
Inherited from NavigationProfileBase.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
- callback: (elem: NativeNavigationProfile) => void
  - - (elem: NativeNavigationProfile): void
    - Parameters
      - elem: NativeNavigationProfile
      Returns void
- Optional forceRefresh: boolean
Returns void
Implementation of INativeNavigationProfile.load
Inherited from NavigationProfileBase.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<NativeNavigationProfile>

loadedProperties

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

Implementation of INativeNavigationProfile.loadedProperties
Inherited from NavigationProfileBase.loadedProperties

Returns all properties when this structure is loaded, otherwise just the public properties.

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of INativeNavigationProfile.publicProperties
Inherited from NavigationProfileBase.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Implementation of INativeNavigationProfile.toJSON
Inherited from NavigationProfileBase.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 IStructureJSON

traverse

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

Implementation of INativeNavigationProfile.traverse
Inherited from NavigationProfileBase.traverse

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

traverseFind

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

Implementation of INativeNavigationProfile.traverseFind
Inherited from NavigationProfileBase.traverseFind

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

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

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

Implementation of INativeNavigationProfile.traversePublicParts
Inherited from NavigationProfileBase.traversePublicParts

Traverses this structure, only visiting children contained in public properties.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): NativeNavigationProfile

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

Static createIn

createIn(container: NavigationDocument): 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
- container: NavigationDocument
Returns NativeNavigationProfile

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

model: AbstractModel

structureTypeName: string

id: string

isPartial: boolean

unit: ModelUnit<IAbstractModel>

container: AbstractElement<IAbstractModel, Container>

Returns NativeNavigationProfile

Properties

id

structureTypeName

Static structureTypeName

Static versionInfo

Accessors

applyScreenTransition

Returns boolean

Parameters

newValue: boolean

Returns void

container

Returns TContainer

containerAsNavigationDocument

Returns NavigationDocument

encryptionDbEnabled

Returns boolean

Parameters

newValue: boolean

Returns void

hermesEnabled

Returns boolean

Parameters

newValue: boolean

Returns void

homePage

Returns null | IPage

Parameters

newValue: null | IPage

Returns void

homePageQualifiedName

Returns null | string

isLoaded

Returns boolean

localFileEncryptionEnabled

Returns boolean

Parameters

newValue: boolean

Returns void

loggingEnabled

Returns boolean

Parameters

newValue: boolean

Returns void

model

Returns TModel

name

Returns string

Parameters

newValue: string

Returns void

nativeHomePage

Returns NativeHomePage

Parameters

newValue: NativeHomePage

Returns void

networkTimeoutMs

Returns number

Parameters

newValue: number

Returns void

otaEnabled

Returns boolean