Group Messages

Action Messages

• GROUP_COLLAPSE - Collapses groups. This message is undoable and broadcastable. This message will trigger the following response messages: GROUP_COLLAPSED. This default maximum wait time for this message is 20.

  Parameters:

  • parentIds (tuple) - The IDs of the parent nodes.

• GROUP_CREATE - Creates a group node and puts it under the specified parent. This message is undoable and broadcastable.

  Parameters:

  • nodeId (unicode) - The ID of the node to create (if possible).

  • parent (unicode) - The ID of the new parent.

  • index (int) - The position at which to place the newly created node. If < 0, the node is inserted as the last child of the parent. Otherwise, we try to insert it as the specified child.

• GROUP_EXPAND - Expands groups. This message is undoable and broadcastable.

  Parameters:

  • parentIds (tuple) - The IDs of the parent nodes.

• GROUP_NODES - Creates a group under the lowest common ancestor of the specified nodes, then moves them all under that new node. This message is undoable and broadcastable. This message will trigger the following response messages: NODE_CREATED. This default maximum wait time for this message is 10.

  Parameters:

  • nodeIds (tuple) - The IDs of the node to group.

• UNGROUP_NODES - Deletes the group node after taking all of its children and giving them to the nodes original parent. This message is undoable and broadcastable.

  Parameters:

  • nodeIds (tuple) - The IDs of the nodes to ungroup.

Information Messages

• GROUP_EXPANDED - Indicates that groups were expanded.

  Parameters:

  • parentIds (tuple) - The IDs of the parent nodes.

Response Messages

• GROUP_COLLAPSED - Indicates that groups were collapsed.

  Parameters:

  • parentIds (tuple) - The IDs of the parent nodes.