Interface RenameContainerOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional addAlias

addAlias?: boolean

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

Optional containerPath

containerPath?: string

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

Optional failure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optional name

name?: string

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

Optional scope

scope?: any

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

Optional success

success?: RequestSuccess<Container>

This will be called upon successfully completing a request.

Optional title

title?: string

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

Settings

Member Visibility

Theme

On This Page

addAliascontainerPathfailurenamescopesuccesstitle

Generated using TypeDoc