Variable BlockChannelsComponentConst

Type declaration

• Readonlyattributes: {
      blockChannelList: Attribute<TypeFromFields<{
          blockChannelIndex: FieldType<null | number>;
          identifier: OptionalFieldType<string>;
          majorNumber: FieldType<number>;
          minorNumber: FieldType<number>;
      }>[], any>;
  }

  • ReadonlyblockChannelList: Attribute<TypeFromFields<{
        blockChannelIndex: FieldType<null | number>;
        identifier: OptionalFieldType<string>;
        majorNumber: FieldType<number>;
        minorNumber: FieldType<number>;
    }>[], any>

    Indicates a set of channels that shall be blocked when the Content Control feature is activated.

    See

    MatterSpecification.v13.Cluster § 6.13.7.9

• Readonlycommands: {
      addBlockChannels: Command<TypeFromFields<{
          channels: FieldType<TypeFromFields<{
              blockChannelIndex: FieldType<(...) | (...)>;
              identifier: OptionalFieldType<string>;
              majorNumber: FieldType<number>;
              minorNumber: FieldType<number>;
          }>[]>;
      }>, void, any>;
      removeBlockChannels: Command<TypeFromFields<{
          channelIndexes: FieldType<number[]>;
      }>, void, any>;
  }

  • ReadonlyaddBlockChannels: Command<TypeFromFields<{
        channels: FieldType<TypeFromFields<{
            blockChannelIndex: FieldType<(...) | (...)>;
            identifier: OptionalFieldType<string>;
            majorNumber: FieldType<number>;
            minorNumber: FieldType<number>;
        }>[]>;
    }>, void, any>

    The purpose of this command is to set BlockChannelList attribute.

    Upon receipt of the AddBlockChannels command, the media device shall check if the channels passed in this command are valid. If the channel is invalid, then a response with InvalidChannel error Status shall be returned.

    If there is at least one channel in Channels field which is not in the BlockChannelList attribute, the media device shall process the request by adding these new channels into the BlockChannelList attribute and return a successful Status Response. During this process, the media device shall assign one unique index to BlockChannelIndex field for every channel passed in this command.

    If all channels in Channel field already exist in the BlockChannelList attribute, then a response with ChannelAlreadyExist error Status shall be returned.

    See

    MatterSpecification.v13.Cluster § 6.13.8.12

  • ReadonlyremoveBlockChannels: Command<TypeFromFields<{
        channelIndexes: FieldType<number[]>;
    }>, void, any>

    The purpose of this command is to remove channels from the BlockChannelList attribute.

    Upon receipt of the RemoveBlockChannels command, the media device shall check if the channels indicated by ChannelIndexes passed in this command are present in BlockChannelList attribute. If one or more channels indicated by ChannelIndexes passed in this command field are not present in the BlockChannelList attribute, then a response with ChannelNotExist error Status shall be returned.

    See

    MatterSpecification.v13.Cluster § 6.13.8.13