Interface ContainerHierarchy

Hierarchy

Properties

activeModules: string[]

Names of active modules in the container.

children: ContainerHierarchy[]

When the includeSubfolders parameter was true this will contain an array of child container objects with the same shape as the parent object.

effectivePermissions?: string[]

An array of effective permission unique names the group has. Only available if includeEffectivePermissions parameter is set to true.

folderType: string

The name of the container's folder type.

formats: {
    dateFormat: string;
    dateTimeFormat: string;
    numberFormat: string;
}

Date format settings for this container.

Type declaration

  • dateFormat: string
  • dateTimeFormat: string
  • numberFormat: string
hasRestrictedActiveModule: boolean

True if any active modules in this container require site permissions.

iconHref: string

Server relative icon URL for this container.

id: string

GUID of this container.

isContainerTab: boolean

Indicates if this container is a Container Tab.

isWorkbook: boolean

Indicates if this container is a workbook.

moduleProperties: ModuleProperty[]

If requested in the config object, an array of module properties for each included module.

name: string

Name of the container. This is used in the container's path.

parentId: string

GUID of this container's parent container.

parentPath: string

Path of this container's parent container.

path: string

Path of this container.

sortOrder: number

The relative sort order of the requested container

startUrl: string

Server relative start URL for this container.

title: string

An optional non-unique title for the container.

type: string

Type of this container. (e.g. "project", "folder").

userPermissions: number

Deprecated

The permissions the current user has in the container.

Generated using TypeDoc