@labkey/api
    Preparing search index...

    Interface RenameContainerOptions

    interface RenameContainerOptions {
        addAlias?: boolean;
        containerPath?: string;
        failure?: RequestFailure<any>;
        name?: string;
        scope?: any;
        success?: RequestSuccess<Container>;
        title?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addAlias? containerPath? failure? name? scope? success? title?

    Properties

    addAlias?: boolean

    If set to true, adds an alias for the container's current name.

    containerPath?: string

    The container which should be renamed. If not specified the current container path will be renamed.

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    name?: string

    The new container name. If not specified, defaults to existing name.

    scope?: any

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

    success?: RequestSuccess<Container>

    This will be called upon successfully completing a request.

    title?: string

    The new container title. If not specified, defaults to name.

    Settings

    Member Visibility

    On This Page

    Properties