@labkey/api
    Preparing search index...

    Interface GetReadableContainersOptions

    interface GetReadableContainersOptions {
        container?: any;
        containerPath?: string;
        depth?: number;
        failure?: RequestFailure<any>;
        includeSubfolders?: boolean;
        scope?: any;
        success?: RequestSuccess<string[]>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    container? containerPath? depth? failure? includeSubfolders? scope? success?

    Properties

    container?: any

    A container id, full-path string, or an Array of container id/full-path Strings (only the first will be used). If not present, the current container is used.

    containerPath?: string

    An alternate container from which to request readable containers. If not specified, the current container path will be used.

    depth?: number

    May be used to control the depth of recursion if includeSubfolders is set to true.

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    includeSubfolders?: boolean

    If set to true, the entire branch of containers will be returned. If false, only the immediate children of the starting container will be returned (defaults to false).

    scope?: any

    A scoping object for the success and failure callback functions (default to this).

    success?: RequestSuccess<string[]>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties