Options for ComponentFactory.createProjectEditorActivity()

Hierarchy

  • Omit<ProjectEditorOptions, "container" | "eaiwsSession" | "projectInfo">
    • ProjectEditorActivityOptions

Properties

additionalActions?: ActionProvider

Additional actions for the editor

additionalRestrictions?: UserRestrictionsProvider | ReadonlySet<UserRestriction>

Additional restrictions for the current user. Effective only for this project editor.

closeSessionOnDispose?: boolean

If true the eaiws session will be closed if the activity gets disposed. (default: true)

editorMode?: ProjectEditorMode

The editor mode defines the primary purpose of the project editor. If not defined Default will be used. The mode may be used by plugins to react to different use cases.

lockedItems?: ReadonlyMap<string, number>

Optional list of locked items (map from basket item id to lock flag) which will be used to lock certain item related operations.

migrateLegacyProjectData?: boolean

If true, legacy data (e.g. header or address data) will be loaded and migrated. (default: false) Should be used when loading obk files of older applications.

onCreateSession?: (() => Promise<null | EaiwsSession>)

Type declaration

    • (): Promise<null | EaiwsSession>
    • Can be used to create a custom eaiws session. If not implemented a default session will be created. Null should be returned if the start of the project editor should be aborted.

      Returns Promise<null | EaiwsSession>

onGetMainMenuActions?: ((pProjectEditor: null | ProjectEditor) => null | readonly MenuAction[])

Type declaration

    • (pProjectEditor: null | ProjectEditor): null | readonly MenuAction[]
    • Will be called everytime the main menu gets opened. Can be used to add new actions or override the project editor actions. Note: use pProjectEditor.getMainMenuActions() to get the default actions of the editor.

      Parameters

      Returns null | readonly MenuAction[]

onGetProjectInfo?: ((pSession: EaiwsSession) => null | ProjectInfo)

Type declaration

    • (pSession: EaiwsSession): null | ProjectInfo
    • Will be called before creating the project editor to define a pre-created ProjectInfo instance.

      Parameters

      • pSession: EaiwsSession

      Returns null | ProjectInfo

onPrepareActivityStop?: ((pProjectEditor: null | ProjectEditor, pCancelable: boolean) => Promise<boolean>)

Type declaration

    • (pProjectEditor: null | ProjectEditor, pCancelable: boolean): Promise<boolean>
    • Can be implemented to make preparations before the activity gets stopped and disposed. If pCancelable is true and the promise resolves with false, the activity stop will be canceled. Otherwise true should be returned.

      Parameters

      Returns Promise<boolean>

onPrepareProjectEditor?: ((pProjectEditor: ProjectEditor) => Promise<void>)

Type declaration

    • (pProjectEditor: ProjectEditor): Promise<void>
    • Will be called directly after the project editor was started.

      Parameters

      Returns Promise<void>

onPrepareSession?: ((pSession: EaiwsSession) => Promise<boolean>)

Type declaration

    • (pSession: EaiwsSession): Promise<boolean>
    • Can be used to prepare the eaiws session before starting the project editor. False should be returned if the start of the project editor should be aborted. E.g. Can be used to load an existing project.

      Parameters

      • pSession: EaiwsSession

      Returns Promise<boolean>

projectMetaData?: ProjectMetaData

Optional project related meta data which may be used by certain operations (e.g. ordering)

useProjectNameAsTitle?: boolean

If true the project name will be used as the title for the activity. (default: true)

Generated using TypeDoc