Interface Cluster

This cluster provides an interface for UX navigation within a set of targets on a device or endpoint.

This cluster would be supported on Video Player devices or devices with navigable user interfaces. This cluster would also be supported on endpoints with navigable user interfaces such as a Content App. It supports listing a set of navigation targets, tracking and changing the current target.

The cluster server for Target Navigator is implemented by endpoints on a device that support UX navigation.

When this cluster is implemented for a Content App endpoint, the Video Player device containing the endpoint shall launch the Content App when a client invokes the NavigateTarget command.

See

MatterSpecification.v13.Cluster § 6.11

interface Cluster {
    attributes: Merge<{
        currentTarget: OptionalAttribute<number, any>;
        targetList: Attribute<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[], any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {
        navigateTarget: Command<TypeFromFields<{
            data: OptionalFieldType<string>;
            target: FieldType<number>;
        }>, TypeFromFields<{
            data: OptionalFieldType<string>;
            status: FieldType<TargetNavigator.Status>;
        }>, any>;
    };
    events: {
        targetUpdated: OptionalEvent<TypeFromFields<{
            currentTarget: OptionalFieldType<number>;
            data: OptionalFieldType<Uint8Array>;
            targetList: OptionalFieldType<TypeFromFields<{
                identifier: FieldType<number>;
                name: FieldType<string>;
            }>[]>;
        }>, any>;
    };
    extensions: undefined;
    features: {};
    id: Branded<1285, "ClusterId">;
    name: "TargetNavigator";
    revision: 2;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            currentTarget: OptionalAttribute<number, any>;
            targetList: Attribute<TypeFromFields<{
                identifier: FieldType<number>;
                name: FieldType<string>;
            }>[], any>;
        };
        commands: {
            navigateTarget: Command<TypeFromFields<{
                data: OptionalFieldType<string>;
                target: FieldType<number>;
            }>, TypeFromFields<{
                data: OptionalFieldType<string>;
                status: FieldType<TargetNavigator.Status>;
            }>, any>;
        };
        events: {
            targetUpdated: OptionalEvent<TypeFromFields<{
                currentTarget: OptionalFieldType<number>;
                data: OptionalFieldType<Uint8Array>;
                targetList: OptionalFieldType<TypeFromFields<{
                    identifier: ...;
                    name: ...;
                }>[]>;
            }>, any>;
        };
        id: 1285;
        name: "TargetNavigator";
        revision: 2;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            currentTarget: OptionalAttribute<number, any>;
            targetList: Attribute<TypeFromFields<{
                identifier: FieldType<number>;
                name: FieldType<string>;
            }>[], any>;
        };
        commands: {
            navigateTarget: Command<TypeFromFields<{
                data: OptionalFieldType<string>;
                target: FieldType<number>;
            }>, TypeFromFields<{
                data: OptionalFieldType<string>;
                status: FieldType<TargetNavigator.Status>;
            }>, any>;
        };
        events: {
            targetUpdated: OptionalEvent<TypeFromFields<{
                currentTarget: OptionalFieldType<number>;
                data: OptionalFieldType<Uint8Array>;
                targetList: OptionalFieldType<TypeFromFields<{
                    identifier: ...;
                    name: ...;
                }>[]>;
            }>, any>;
        };
        id: 1285;
        name: "TargetNavigator";
        revision: 2;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            currentTarget: OptionalAttribute<number, any>;
            targetList: Attribute<TypeFromFields<{
                identifier: FieldType<number>;
                name: FieldType<string>;
            }>[], any>;
        };
        commands: {
            navigateTarget: Command<TypeFromFields<{
                data: OptionalFieldType<string>;
                target: FieldType<number>;
            }>, TypeFromFields<{
                data: OptionalFieldType<string>;
                status: FieldType<TargetNavigator.Status>;
            }>, any>;
        };
        events: {
            targetUpdated: OptionalEvent<TypeFromFields<{
                currentTarget: OptionalFieldType<number>;
                data: OptionalFieldType<Uint8Array>;
                targetList: OptionalFieldType<TypeFromFields<{
                    identifier: ...;
                    name: ...;
                }>[]>;
            }>, any>;
        };
        id: 1285;
        name: "TargetNavigator";
        revision: 2;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            currentTarget: OptionalAttribute<number, any>;
            targetList: Attribute<TypeFromFields<{
                identifier: FieldType<number>;
                name: FieldType<string>;
            }>[], any>;
        };
        commands: {
            navigateTarget: Command<TypeFromFields<{
                data: OptionalFieldType<string>;
                target: FieldType<number>;
            }>, TypeFromFields<{
                data: OptionalFieldType<string>;
                status: FieldType<TargetNavigator.Status>;
            }>, any>;
        };
        events: {
            targetUpdated: OptionalEvent<TypeFromFields<{
                currentTarget: OptionalFieldType<number>;
                data: OptionalFieldType<Uint8Array>;
                targetList: OptionalFieldType<TypeFromFields<{
                    identifier: ...;
                    name: ...;
                }>[]>;
            }>, any>;
        };
        id: 1285;
        name: "TargetNavigator";
        revision: 2;
    }>, SelectionT>;
}

Hierarchy (view full)

Identity<typeof TargetNavigator.ClusterInstance>
- Cluster

Index

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    currentTarget: OptionalAttribute<number, any>;
    targetList: Attribute<TypeFromFields<{
        identifier: FieldType<number>;
        name: FieldType<string>;
    }>[], any>;
}, GlobalAttributes<{}>>

Type declaration

ReadonlycurrentTarget: OptionalAttribute<number, any>
Indicates the Identifier for the target which is currently in foreground on the corresponding Endpoint (Video Player or Content App), or 0xFF to indicate that no target is in the foreground.

When not 0xFF, the CurrentTarget shall be an Identifier value contained within one of the TargetInfoStruct objects in the TargetList attribute.

See
MatterSpecification.v13.Cluster § 6.11.5.2
ReadonlytargetList: Attribute<TypeFromFields<{
identifier: FieldType<number>;
name: FieldType<string>;
}>[], any>
Indicates a list of targets that can be navigated to within the experience presented to the user by the Endpoint (Video Player or Content App). The list shall not contain any entries with the same Identifier in the TargetInfoStruct object.

See
MatterSpecification.v13.Cluster § 6.11.5.1

base

base: undefined

commands

commands: {
    navigateTarget: Command<TypeFromFields<{
        data: OptionalFieldType<string>;
        target: FieldType<number>;
    }>, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<TargetNavigator.Status>;
    }>, any>;
}

Type declaration

ReadonlynavigateTarget: Command<TypeFromFields<{
    data: OptionalFieldType<string>;
    target: FieldType<number>;
}>, TypeFromFields<{
    data: OptionalFieldType<string>;
    status: FieldType<TargetNavigator.Status>;
}>, any>
Upon receipt, this shall navigation the UX to the target identified.

See
MatterSpecification.v13.Cluster § 6.11.6.1

events

events: {
    targetUpdated: OptionalEvent<TypeFromFields<{
        currentTarget: OptionalFieldType<number>;
        data: OptionalFieldType<Uint8Array>;
        targetList: OptionalFieldType<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[]>;
    }>, any>;
}

Type declaration

ReadonlytargetUpdated: OptionalEvent<TypeFromFields<{
    currentTarget: OptionalFieldType<number>;
    data: OptionalFieldType<Uint8Array>;
    targetList: OptionalFieldType<TypeFromFields<{
        identifier: FieldType<number>;
        name: FieldType<string>;
    }>[]>;
}>, any>
This event shall be generated when there is a change in either the active target or the list of available targets or both.

See
MatterSpecification.v13.Cluster § 6.11.7.1

extensions

extensions: undefined

features

features: {}

id

id: Branded<1285, "ClusterId">

name

revision

supportedFeatures

supportedFeatures: {}

unknown

Methods

alter

alter<const AlterationsT>(alterations): WithAlterations<Of<{
    attributes: {
        currentTarget: OptionalAttribute<number, any>;
        targetList: Attribute<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[], any>;
    };
    commands: {
        navigateTarget: Command<TypeFromFields<{
            data: OptionalFieldType<string>;
            target: FieldType<number>;
        }>, TypeFromFields<{
            data: OptionalFieldType<string>;
            status: FieldType<TargetNavigator.Status>;
        }>, any>;
    };
    events: {
        targetUpdated: OptionalEvent<TypeFromFields<{
            currentTarget: OptionalFieldType<number>;
            data: OptionalFieldType<Uint8Array>;
            targetList: OptionalFieldType<TypeFromFields<{
                identifier: ...;
                name: ...;
            }>[]>;
        }>, any>;
    };
    id: 1285;
    name: "TargetNavigator";
    revision: 2;
}>, AlterationsT>
Modify elements using ElementModifier.alter.
Type Parameters
- const AlterationsT extends Alterations<Of<{
      attributes: {
          currentTarget: OptionalAttribute<number, any>;
          targetList: Attribute<TypeFromFields<{
              identifier: FieldType<number>;
              name: FieldType<string>;
          }>[], any>;
      };
      commands: {
          navigateTarget: Command<TypeFromFields<{
              data: OptionalFieldType<string>;
              target: FieldType<number>;
          }>, TypeFromFields<{
              data: OptionalFieldType<string>;
              status: FieldType<TargetNavigator.Status>;
          }>, any>;
      };
      events: {
          targetUpdated: OptionalEvent<TypeFromFields<{
              currentTarget: OptionalFieldType<number>;
              data: OptionalFieldType<Uint8Array>;
              targetList: OptionalFieldType<TypeFromFields<{
                  identifier: ...;
                  name: ...;
              }>[]>;
          }>, any>;
      };
      id: 1285;
      name: "TargetNavigator";
      revision: 2;
  }>>
Parameters
- alterations: AlterationsT
Returns WithAlterations<Of<{
    attributes: {
        currentTarget: OptionalAttribute<number, any>;
        targetList: Attribute<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[], any>;
    };
    commands: {
        navigateTarget: Command<TypeFromFields<{
            data: OptionalFieldType<string>;
            target: FieldType<number>;
        }>, TypeFromFields<{
            data: OptionalFieldType<string>;
            status: FieldType<TargetNavigator.Status>;
        }>, any>;
    };
    events: {
        targetUpdated: OptionalEvent<TypeFromFields<{
            currentTarget: OptionalFieldType<number>;
            data: OptionalFieldType<Uint8Array>;
            targetList: OptionalFieldType<TypeFromFields<{
                identifier: ...;
                name: ...;
            }>[]>;
        }>, any>;
    };
    id: 1285;
    name: "TargetNavigator";
    revision: 2;
}>, AlterationsT>
Inherited from Identity.alter
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:37

enable

enable<const FlagsT>(flags): WithFlags<Of<{
    attributes: {
        currentTarget: OptionalAttribute<number, any>;
        targetList: Attribute<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[], any>;
    };
    commands: {
        navigateTarget: Command<TypeFromFields<{
            data: OptionalFieldType<string>;
            target: FieldType<number>;
        }>, TypeFromFields<{
            data: OptionalFieldType<string>;
            status: FieldType<TargetNavigator.Status>;
        }>, any>;
    };
    events: {
        targetUpdated: OptionalEvent<TypeFromFields<{
            currentTarget: OptionalFieldType<number>;
            data: OptionalFieldType<Uint8Array>;
            targetList: OptionalFieldType<TypeFromFields<{
                identifier: ...;
                name: ...;
            }>[]>;
        }>, any>;
    };
    id: 1285;
    name: "TargetNavigator";
    revision: 2;
}>, FlagsT>
Modify elements using ElementModifier.enable.
Type Parameters
- const FlagsT extends ElementFlags<Of<{
      attributes: {
          currentTarget: OptionalAttribute<number, any>;
          targetList: Attribute<TypeFromFields<{
              identifier: FieldType<number>;
              name: FieldType<string>;
          }>[], any>;
      };
      commands: {
          navigateTarget: Command<TypeFromFields<{
              data: OptionalFieldType<string>;
              target: FieldType<number>;
          }>, TypeFromFields<{
              data: OptionalFieldType<string>;
              status: FieldType<TargetNavigator.Status>;
          }>, any>;
      };
      events: {
          targetUpdated: OptionalEvent<TypeFromFields<{
              currentTarget: OptionalFieldType<number>;
              data: OptionalFieldType<Uint8Array>;
              targetList: OptionalFieldType<TypeFromFields<{
                  identifier: ...;
                  name: ...;
              }>[]>;
          }>, any>;
      };
      id: 1285;
      name: "TargetNavigator";
      revision: 2;
  }>>
Parameters
- flags: FlagsT
Returns WithFlags<Of<{
    attributes: {
        currentTarget: OptionalAttribute<number, any>;
        targetList: Attribute<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[], any>;
    };
    commands: {
        navigateTarget: Command<TypeFromFields<{
            data: OptionalFieldType<string>;
            target: FieldType<number>;
        }>, TypeFromFields<{
            data: OptionalFieldType<string>;
            status: FieldType<TargetNavigator.Status>;
        }>, any>;
    };
    events: {
        targetUpdated: OptionalEvent<TypeFromFields<{
            currentTarget: OptionalFieldType<number>;
            data: OptionalFieldType<Uint8Array>;
            targetList: OptionalFieldType<TypeFromFields<{
                identifier: ...;
                name: ...;
            }>[]>;
        }>, any>;
    };
    id: 1285;
    name: "TargetNavigator";
    revision: 2;
}>, FlagsT>
Inherited from Identity.enable
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:45

set

set<const ValuesT>(values): WithValues<Of<{
    attributes: {
        currentTarget: OptionalAttribute<number, any>;
        targetList: Attribute<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[], any>;
    };
    commands: {
        navigateTarget: Command<TypeFromFields<{
            data: OptionalFieldType<string>;
            target: FieldType<number>;
        }>, TypeFromFields<{
            data: OptionalFieldType<string>;
            status: FieldType<TargetNavigator.Status>;
        }>, any>;
    };
    events: {
        targetUpdated: OptionalEvent<TypeFromFields<{
            currentTarget: OptionalFieldType<number>;
            data: OptionalFieldType<Uint8Array>;
            targetList: OptionalFieldType<TypeFromFields<{
                identifier: ...;
                name: ...;
            }>[]>;
        }>, any>;
    };
    id: 1285;
    name: "TargetNavigator";
    revision: 2;
}>, ValuesT>
Modify elements using ElementModifier.set.
Type Parameters
- const ValuesT extends {
      currentTarget?: number;
      targetList: {
          identifier: number;
          name: string;
      }[];
  }
Parameters
- values: ValuesT
Returns WithValues<Of<{
    attributes: {
        currentTarget: OptionalAttribute<number, any>;
        targetList: Attribute<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[], any>;
    };
    commands: {
        navigateTarget: Command<TypeFromFields<{
            data: OptionalFieldType<string>;
            target: FieldType<number>;
        }>, TypeFromFields<{
            data: OptionalFieldType<string>;
            status: FieldType<TargetNavigator.Status>;
        }>, any>;
    };
    events: {
        targetUpdated: OptionalEvent<TypeFromFields<{
            currentTarget: OptionalFieldType<number>;
            data: OptionalFieldType<Uint8Array>;
            targetList: OptionalFieldType<TypeFromFields<{
                identifier: ...;
                name: ...;
            }>[]>;
        }>, any>;
    };
    id: 1285;
    name: "TargetNavigator";
    revision: 2;
}>, ValuesT>
Inherited from Identity.set
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:41

with

with<const SelectionT>(...selection): Of<Of<{
    attributes: {
        currentTarget: OptionalAttribute<number, any>;
        targetList: Attribute<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[], any>;
    };
    commands: {
        navigateTarget: Command<TypeFromFields<{
            data: OptionalFieldType<string>;
            target: FieldType<number>;
        }>, TypeFromFields<{
            data: OptionalFieldType<string>;
            status: FieldType<TargetNavigator.Status>;
        }>, any>;
    };
    events: {
        targetUpdated: OptionalEvent<TypeFromFields<{
            currentTarget: OptionalFieldType<number>;
            data: OptionalFieldType<Uint8Array>;
            targetList: OptionalFieldType<TypeFromFields<{
                identifier: ...;
                name: ...;
            }>[]>;
        }>, any>;
    };
    id: 1285;
    name: "TargetNavigator";
    revision: 2;
}>, SelectionT>
Select features using ClusterComposer.compose.
Type Parameters
- const SelectionT extends FeatureSelection<Of<{
      attributes: {
          currentTarget: OptionalAttribute<number, any>;
          targetList: Attribute<TypeFromFields<{
              identifier: FieldType<number>;
              name: FieldType<string>;
          }>[], any>;
      };
      commands: {
          navigateTarget: Command<TypeFromFields<{
              data: OptionalFieldType<string>;
              target: FieldType<number>;
          }>, TypeFromFields<{
              data: OptionalFieldType<string>;
              status: FieldType<TargetNavigator.Status>;
          }>, any>;
      };
      events: {
          targetUpdated: OptionalEvent<TypeFromFields<{
              currentTarget: OptionalFieldType<number>;
              data: OptionalFieldType<Uint8Array>;
              targetList: OptionalFieldType<TypeFromFields<{
                  identifier: ...;
                  name: ...;
              }>[]>;
          }>, any>;
      };
      id: 1285;
      name: "TargetNavigator";
      revision: 2;
  }>>
Parameters
- Rest...selection: SelectionT
Returns Of<Of<{
    attributes: {
        currentTarget: OptionalAttribute<number, any>;
        targetList: Attribute<TypeFromFields<{
            identifier: FieldType<number>;
            name: FieldType<string>;
        }>[], any>;
    };
    commands: {
        navigateTarget: Command<TypeFromFields<{
            data: OptionalFieldType<string>;
            target: FieldType<number>;
        }>, TypeFromFields<{
            data: OptionalFieldType<string>;
            status: FieldType<TargetNavigator.Status>;
        }>, any>;
    };
    events: {
        targetUpdated: OptionalEvent<TypeFromFields<{
            currentTarget: OptionalFieldType<number>;
            data: OptionalFieldType<Uint8Array>;
            targetList: OptionalFieldType<TypeFromFields<{
                identifier: ...;
                name: ...;
            }>[]>;
        }>, any>;
    };
    id: 1285;
    name: "TargetNavigator";
    revision: 2;
}>, SelectionT>
Inherited from Identity.with
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:33

Interface Cluster

See

Hierarchy (view full)

Index

Properties

Methods

Properties

attributes

Type declaration

ReadonlycurrentTarget: OptionalAttribute<number, any>

See

ReadonlytargetList: Attribute<TypeFromFields<{ identifier: FieldType<number>; name: FieldType<string>; }>[], any>

See

base

commands

Type declaration

ReadonlynavigateTarget: Command<TypeFromFields<{ data: OptionalFieldType<string>; target: FieldType<number>; }>, TypeFromFields<{ data: OptionalFieldType<string>; status: FieldType<TargetNavigator.Status>; }>, any>

See

events

Type declaration

ReadonlytargetUpdated: OptionalEvent<TypeFromFields<{ currentTarget: OptionalFieldType<number>; data: OptionalFieldType<Uint8Array>; targetList: OptionalFieldType<TypeFromFields<{ identifier: FieldType<number>; name: FieldType<string>; }>[]>; }>, any>

See

extensions

features

id

name

revision

supportedFeatures

unknown

Methods

alter

Type Parameters

Parameters

enable

Type Parameters

Parameters

set

Type Parameters

Parameters

with

Type Parameters

Parameters

Settings

On This Page

`Readonly`currentTarget: OptionalAttribute<number, any>

`Readonly`targetList: Attribute<TypeFromFields<{
identifier: FieldType<number>;
name: FieldType<string>;
}>[], any>

`Readonly`navigateTarget: Command<TypeFromFields<{
data: OptionalFieldType<string>;
target: FieldType<number>;
}>, TypeFromFields<{
data: OptionalFieldType<string>;
status: FieldType<TargetNavigator.Status>;
}>, any>

`Readonly`targetUpdated: OptionalEvent<TypeFromFields<{
currentTarget: OptionalFieldType<number>;
data: OptionalFieldType<Uint8Array>;
targetList: OptionalFieldType<TypeFromFields<{
identifier: FieldType<number>;
name: FieldType<string>;
}>[]>;
}>, any>