Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProjectSecurity

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Security$ProjectSecurity"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

adminPassword

  • get adminPassword(): string
  • set adminPassword(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

adminUserName

  • get adminUserName(): string
  • set adminUserName(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

adminUserRoleName

  • get adminUserRoleName(): string
  • set adminUserRoleName(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

checkSecurity

  • get checkSecurity(): boolean
  • set checkSecurity(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

container

  • get container(): TContainer

  • The parent unit of this unit.

    Returns TContainer

containerAsProject

demoUsers

enableDemoUsers

  • get enableDemoUsers(): boolean
  • set enableDemoUsers(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

enableGuestAccess

  • get enableGuestAccess(): boolean
  • set enableGuestAccess(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

fileDocumentAccess

guestUserRoleName

  • get guestUserRoleName(): string
  • set guestUserRoleName(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

imageAccess

isLoadable

  • get isLoadable(): boolean

  • Whether this unit and all of its children (recursively) can be loaded.

    Returns boolean

isLoaded

  • get isLoaded(): boolean

  • Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

    Returns boolean

isReadOnly

  • get isReadOnly(): boolean

  • Whether this unit and all of its children (recursively) are editable.

    Returns boolean

model

  • get model(): TModel

passwordPolicySettings

securityLevel

signInMicroflow

  • In version 8.0.0: deleted

    Returns null | IMicroflow

  • In version 8.0.0: deleted

    Parameters

    Returns void

signInMicroflowQualifiedName

  • get signInMicroflowQualifiedName(): null | string

  • Returns null | string

strictMode

  • get strictMode(): boolean
  • set strictMode(newValue: boolean): void

  • In version 9.24.0: introduced

    Returns boolean

  • In version 9.24.0: introduced

    Parameters

    • newValue: boolean

    Returns void

strictPageUrlCheck

  • get strictPageUrlCheck(): boolean
  • set strictPageUrlCheck(newValue: boolean): void

  • In version 9.8.0: introduced

    Returns boolean

  • In version 9.8.0: introduced

    Parameters

    • newValue: boolean

    Returns void

unit

  • get unit(): this

  • Unit that owns/contains this thing.

    Returns this

userRoles

Methods

allProperties

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 ProjectSecurity

delete

  • delete(): void

findElementById

Protected getContainerAs

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

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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<ProjectSecurity>

loadedProperties

publicProperties

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 IAbstractElementJson

traverse

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

  • 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

    Returns void

traverseFind

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

traversePublicParts

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

Static createIn

  • Creates a new ProjectSecurity unit in the SDK and on the server. Expects one argument, the projects.IProject in which this unit is contained.

    Parameters

    Returns ProjectSecurity

Generated using TypeDoc