Interface DiscoveryGetContextMenuTreeSuccess

Successful response from discovery.getContextMenuTree.

interface DiscoveryGetContextMenuTreeSuccess {
    childrenExceeded: boolean;
    depthExceeded: boolean;
    itemCount: number;
    maxChildrenPerNode: number;
    maxDepth: number;
    success: true;
    tree: DiscoveryContextMenuTreeNode;
    truncated: boolean;
}

Properties

childrenExceeded: boolean

Whether the per-node children limit clipped something.

depthExceeded: boolean

Whether the depth limit clipped something.

itemCount: number

How many tracks the menu was built for.

maxChildrenPerNode: number

The per-node children limit that applied.

maxDepth: number

The depth limit that applied.

success: true

Always true here; a failed call resolves with ApiFailure instead.

The root node.

truncated: boolean

Whether anything in the tree was clipped.