Interface Cluster

See

MatterSpecification.v13.Core § 11.20.6

interface Cluster {
    attributes: {};
    base: undefined;
    commands: {
        applyUpdateRequest: Command<TypeFromFields<{
            newVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, TypeFromFields<{
            action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
            delayedActionTime: FieldType<number>;
        }>, any>;
        notifyUpdateApplied: Command<TypeFromFields<{
            softwareVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, void, any>;
        queryImage: Command<TypeFromFields<{
            hardwareVersion: OptionalFieldType<number>;
            location: OptionalFieldType<string>;
            metadataForProvider: OptionalFieldType<Uint8Array>;
            productId: FieldType<number>;
            protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
            requestorCanConsent: OptionalFieldType<boolean>;
            softwareVersion: FieldType<number>;
            vendorId: FieldType<VendorId>;
        }>, TypeFromFields<{
            delayedActionTime: OptionalFieldType<number>;
            imageUri: OptionalFieldType<string>;
            metadataForRequestor: OptionalFieldType<Uint8Array>;
            softwareVersion: OptionalFieldType<number>;
            softwareVersionString: OptionalFieldType<string>;
            status: FieldType<OtaSoftwareUpdateProvider.Status>;
            updateToken: OptionalFieldType<Uint8Array>;
            userConsentNeeded: OptionalFieldType<boolean>;
        }>, any>;
    };
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<41, "ClusterId">;
    name: "OtaSoftwareUpdateProvider";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        commands: {
            applyUpdateRequest: Command<TypeFromFields<{
                newVersion: FieldType<number>;
                updateToken: FieldType<Uint8Array>;
            }>, TypeFromFields<{
                action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
                delayedActionTime: FieldType<number>;
            }>, any>;
            notifyUpdateApplied: Command<TypeFromFields<{
                softwareVersion: FieldType<number>;
                updateToken: FieldType<Uint8Array>;
            }>, void, any>;
            queryImage: Command<TypeFromFields<{
                hardwareVersion: OptionalFieldType<number>;
                location: OptionalFieldType<string>;
                metadataForProvider: OptionalFieldType<Uint8Array>;
                productId: FieldType<number>;
                protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
                requestorCanConsent: OptionalFieldType<boolean>;
                softwareVersion: FieldType<number>;
                vendorId: FieldType<VendorId>;
            }>, TypeFromFields<{
                delayedActionTime: OptionalFieldType<number>;
                imageUri: OptionalFieldType<string>;
                metadataForRequestor: OptionalFieldType<Uint8Array>;
                softwareVersion: OptionalFieldType<number>;
                softwareVersionString: OptionalFieldType<string>;
                status: FieldType<OtaSoftwareUpdateProvider.Status>;
                updateToken: OptionalFieldType<Uint8Array>;
                userConsentNeeded: OptionalFieldType<boolean>;
            }>, any>;
        };
        id: 41;
        name: "OtaSoftwareUpdateProvider";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        commands: {
            applyUpdateRequest: Command<TypeFromFields<{
                newVersion: FieldType<number>;
                updateToken: FieldType<Uint8Array>;
            }>, TypeFromFields<{
                action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
                delayedActionTime: FieldType<number>;
            }>, any>;
            notifyUpdateApplied: Command<TypeFromFields<{
                softwareVersion: FieldType<number>;
                updateToken: FieldType<Uint8Array>;
            }>, void, any>;
            queryImage: Command<TypeFromFields<{
                hardwareVersion: OptionalFieldType<number>;
                location: OptionalFieldType<string>;
                metadataForProvider: OptionalFieldType<Uint8Array>;
                productId: FieldType<number>;
                protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
                requestorCanConsent: OptionalFieldType<boolean>;
                softwareVersion: FieldType<number>;
                vendorId: FieldType<VendorId>;
            }>, TypeFromFields<{
                delayedActionTime: OptionalFieldType<number>;
                imageUri: OptionalFieldType<string>;
                metadataForRequestor: OptionalFieldType<Uint8Array>;
                softwareVersion: OptionalFieldType<number>;
                softwareVersionString: OptionalFieldType<string>;
                status: FieldType<OtaSoftwareUpdateProvider.Status>;
                updateToken: OptionalFieldType<Uint8Array>;
                userConsentNeeded: OptionalFieldType<boolean>;
            }>, any>;
        };
        id: 41;
        name: "OtaSoftwareUpdateProvider";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        commands: {
            applyUpdateRequest: Command<TypeFromFields<{
                newVersion: FieldType<number>;
                updateToken: FieldType<Uint8Array>;
            }>, TypeFromFields<{
                action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
                delayedActionTime: FieldType<number>;
            }>, any>;
            notifyUpdateApplied: Command<TypeFromFields<{
                softwareVersion: FieldType<number>;
                updateToken: FieldType<Uint8Array>;
            }>, void, any>;
            queryImage: Command<TypeFromFields<{
                hardwareVersion: OptionalFieldType<number>;
                location: OptionalFieldType<string>;
                metadataForProvider: OptionalFieldType<Uint8Array>;
                productId: FieldType<number>;
                protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
                requestorCanConsent: OptionalFieldType<boolean>;
                softwareVersion: FieldType<number>;
                vendorId: FieldType<VendorId>;
            }>, TypeFromFields<{
                delayedActionTime: OptionalFieldType<number>;
                imageUri: OptionalFieldType<string>;
                metadataForRequestor: OptionalFieldType<Uint8Array>;
                softwareVersion: OptionalFieldType<number>;
                softwareVersionString: OptionalFieldType<string>;
                status: FieldType<OtaSoftwareUpdateProvider.Status>;
                updateToken: OptionalFieldType<Uint8Array>;
                userConsentNeeded: OptionalFieldType<boolean>;
            }>, any>;
        };
        id: 41;
        name: "OtaSoftwareUpdateProvider";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        commands: {
            applyUpdateRequest: Command<TypeFromFields<{
                newVersion: FieldType<number>;
                updateToken: FieldType<Uint8Array>;
            }>, TypeFromFields<{
                action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
                delayedActionTime: FieldType<number>;
            }>, any>;
            notifyUpdateApplied: Command<TypeFromFields<{
                softwareVersion: FieldType<number>;
                updateToken: FieldType<Uint8Array>;
            }>, void, any>;
            queryImage: Command<TypeFromFields<{
                hardwareVersion: OptionalFieldType<number>;
                location: OptionalFieldType<string>;
                metadataForProvider: OptionalFieldType<Uint8Array>;
                productId: FieldType<number>;
                protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
                requestorCanConsent: OptionalFieldType<boolean>;
                softwareVersion: FieldType<number>;
                vendorId: FieldType<VendorId>;
            }>, TypeFromFields<{
                delayedActionTime: OptionalFieldType<number>;
                imageUri: OptionalFieldType<string>;
                metadataForRequestor: OptionalFieldType<Uint8Array>;
                softwareVersion: OptionalFieldType<number>;
                softwareVersionString: OptionalFieldType<string>;
                status: FieldType<OtaSoftwareUpdateProvider.Status>;
                updateToken: OptionalFieldType<Uint8Array>;
                userConsentNeeded: OptionalFieldType<boolean>;
            }>, any>;
        };
        id: 41;
        name: "OtaSoftwareUpdateProvider";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Identity<typeof OtaSoftwareUpdateProvider.ClusterInstance>
- Cluster

Index

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: {}

base

base: undefined

commands

commands: {
    applyUpdateRequest: Command<TypeFromFields<{
        newVersion: FieldType<number>;
        updateToken: FieldType<Uint8Array>;
    }>, TypeFromFields<{
        action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
        delayedActionTime: FieldType<number>;
    }>, any>;
    notifyUpdateApplied: Command<TypeFromFields<{
        softwareVersion: FieldType<number>;
        updateToken: FieldType<Uint8Array>;
    }>, void, any>;
    queryImage: Command<TypeFromFields<{
        hardwareVersion: OptionalFieldType<number>;
        location: OptionalFieldType<string>;
        metadataForProvider: OptionalFieldType<Uint8Array>;
        productId: FieldType<number>;
        protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
        requestorCanConsent: OptionalFieldType<boolean>;
        softwareVersion: FieldType<number>;
        vendorId: FieldType<VendorId>;
    }>, TypeFromFields<{
        delayedActionTime: OptionalFieldType<number>;
        imageUri: OptionalFieldType<string>;
        metadataForRequestor: OptionalFieldType<Uint8Array>;
        softwareVersion: OptionalFieldType<number>;
        softwareVersionString: OptionalFieldType<string>;
        status: FieldType<OtaSoftwareUpdateProvider.Status>;
        updateToken: OptionalFieldType<Uint8Array>;
        userConsentNeeded: OptionalFieldType<boolean>;
    }>, any>;
}

Type declaration

ReadonlyapplyUpdateRequest: Command<TypeFromFields<{
    newVersion: FieldType<number>;
    updateToken: FieldType<Uint8Array>;
}>, TypeFromFields<{
    action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
    delayedActionTime: FieldType<number>;
}>, any>
See
MatterSpecification.v13.Core § 11.20.6.5.3
ReadonlynotifyUpdateApplied: Command<TypeFromFields<{
softwareVersion: FieldType<number>;
updateToken: FieldType<Uint8Array>;
}>, void, any>
See
MatterSpecification.v13.Core § 11.20.6.5.5
ReadonlyqueryImage: Command<TypeFromFields<{
    hardwareVersion: OptionalFieldType<number>;
    location: OptionalFieldType<string>;
    metadataForProvider: OptionalFieldType<Uint8Array>;
    productId: FieldType<number>;
    protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
    requestorCanConsent: OptionalFieldType<boolean>;
    softwareVersion: FieldType<number>;
    vendorId: FieldType<VendorId>;
}>, TypeFromFields<{
    delayedActionTime: OptionalFieldType<number>;
    imageUri: OptionalFieldType<string>;
    metadataForRequestor: OptionalFieldType<Uint8Array>;
    softwareVersion: OptionalFieldType<number>;
    softwareVersionString: OptionalFieldType<string>;
    status: FieldType<OtaSoftwareUpdateProvider.Status>;
    updateToken: OptionalFieldType<Uint8Array>;
    userConsentNeeded: OptionalFieldType<boolean>;
}>, any>
Upon receipt, this command shall trigger an attempt to find an updated Software Image by the OTA Provider to match the OTA Requestor’s constraints provided in the payload fields.

See
MatterSpecification.v13.Core § 11.20.6.5.1

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<41, "ClusterId">

name

revision

supportedFeatures

supportedFeatures: {}

unknown

Methods

alter

alter<const AlterationsT>(alterations): WithAlterations<Of<{
    commands: {
        applyUpdateRequest: Command<TypeFromFields<{
            newVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, TypeFromFields<{
            action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
            delayedActionTime: FieldType<number>;
        }>, any>;
        notifyUpdateApplied: Command<TypeFromFields<{
            softwareVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, void, any>;
        queryImage: Command<TypeFromFields<{
            hardwareVersion: OptionalFieldType<number>;
            location: OptionalFieldType<string>;
            metadataForProvider: OptionalFieldType<Uint8Array>;
            productId: FieldType<number>;
            protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
            requestorCanConsent: OptionalFieldType<boolean>;
            softwareVersion: FieldType<number>;
            vendorId: FieldType<VendorId>;
        }>, TypeFromFields<{
            delayedActionTime: OptionalFieldType<number>;
            imageUri: OptionalFieldType<string>;
            metadataForRequestor: OptionalFieldType<Uint8Array>;
            softwareVersion: OptionalFieldType<number>;
            softwareVersionString: OptionalFieldType<string>;
            status: FieldType<OtaSoftwareUpdateProvider.Status>;
            updateToken: OptionalFieldType<Uint8Array>;
            userConsentNeeded: OptionalFieldType<boolean>;
        }>, any>;
    };
    id: 41;
    name: "OtaSoftwareUpdateProvider";
    revision: 1;
}>, AlterationsT>
Modify elements using ElementModifier.alter.
Type Parameters
- const AlterationsT extends Alterations<Of<{
      commands: {
          applyUpdateRequest: Command<TypeFromFields<{
              newVersion: FieldType<number>;
              updateToken: FieldType<Uint8Array>;
          }>, TypeFromFields<{
              action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
              delayedActionTime: FieldType<number>;
          }>, any>;
          notifyUpdateApplied: Command<TypeFromFields<{
              softwareVersion: FieldType<number>;
              updateToken: FieldType<Uint8Array>;
          }>, void, any>;
          queryImage: Command<TypeFromFields<{
              hardwareVersion: OptionalFieldType<number>;
              location: OptionalFieldType<string>;
              metadataForProvider: OptionalFieldType<Uint8Array>;
              productId: FieldType<number>;
              protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
              requestorCanConsent: OptionalFieldType<boolean>;
              softwareVersion: FieldType<number>;
              vendorId: FieldType<VendorId>;
          }>, TypeFromFields<{
              delayedActionTime: OptionalFieldType<number>;
              imageUri: OptionalFieldType<string>;
              metadataForRequestor: OptionalFieldType<Uint8Array>;
              softwareVersion: OptionalFieldType<number>;
              softwareVersionString: OptionalFieldType<string>;
              status: FieldType<OtaSoftwareUpdateProvider.Status>;
              updateToken: OptionalFieldType<Uint8Array>;
              userConsentNeeded: OptionalFieldType<boolean>;
          }>, any>;
      };
      id: 41;
      name: "OtaSoftwareUpdateProvider";
      revision: 1;
  }>>
Parameters
- alterations: AlterationsT
Returns WithAlterations<Of<{
    commands: {
        applyUpdateRequest: Command<TypeFromFields<{
            newVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, TypeFromFields<{
            action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
            delayedActionTime: FieldType<number>;
        }>, any>;
        notifyUpdateApplied: Command<TypeFromFields<{
            softwareVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, void, any>;
        queryImage: Command<TypeFromFields<{
            hardwareVersion: OptionalFieldType<number>;
            location: OptionalFieldType<string>;
            metadataForProvider: OptionalFieldType<Uint8Array>;
            productId: FieldType<number>;
            protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
            requestorCanConsent: OptionalFieldType<boolean>;
            softwareVersion: FieldType<number>;
            vendorId: FieldType<VendorId>;
        }>, TypeFromFields<{
            delayedActionTime: OptionalFieldType<number>;
            imageUri: OptionalFieldType<string>;
            metadataForRequestor: OptionalFieldType<Uint8Array>;
            softwareVersion: OptionalFieldType<number>;
            softwareVersionString: OptionalFieldType<string>;
            status: FieldType<OtaSoftwareUpdateProvider.Status>;
            updateToken: OptionalFieldType<Uint8Array>;
            userConsentNeeded: OptionalFieldType<boolean>;
        }>, any>;
    };
    id: 41;
    name: "OtaSoftwareUpdateProvider";
    revision: 1;
}>, AlterationsT>
Inherited from Identity.alter
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:37

enable

enable<const FlagsT>(flags): WithFlags<Of<{
    commands: {
        applyUpdateRequest: Command<TypeFromFields<{
            newVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, TypeFromFields<{
            action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
            delayedActionTime: FieldType<number>;
        }>, any>;
        notifyUpdateApplied: Command<TypeFromFields<{
            softwareVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, void, any>;
        queryImage: Command<TypeFromFields<{
            hardwareVersion: OptionalFieldType<number>;
            location: OptionalFieldType<string>;
            metadataForProvider: OptionalFieldType<Uint8Array>;
            productId: FieldType<number>;
            protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
            requestorCanConsent: OptionalFieldType<boolean>;
            softwareVersion: FieldType<number>;
            vendorId: FieldType<VendorId>;
        }>, TypeFromFields<{
            delayedActionTime: OptionalFieldType<number>;
            imageUri: OptionalFieldType<string>;
            metadataForRequestor: OptionalFieldType<Uint8Array>;
            softwareVersion: OptionalFieldType<number>;
            softwareVersionString: OptionalFieldType<string>;
            status: FieldType<OtaSoftwareUpdateProvider.Status>;
            updateToken: OptionalFieldType<Uint8Array>;
            userConsentNeeded: OptionalFieldType<boolean>;
        }>, any>;
    };
    id: 41;
    name: "OtaSoftwareUpdateProvider";
    revision: 1;
}>, FlagsT>
Modify elements using ElementModifier.enable.
Type Parameters
- const FlagsT extends ElementFlags<Of<{
      commands: {
          applyUpdateRequest: Command<TypeFromFields<{
              newVersion: FieldType<number>;
              updateToken: FieldType<Uint8Array>;
          }>, TypeFromFields<{
              action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
              delayedActionTime: FieldType<number>;
          }>, any>;
          notifyUpdateApplied: Command<TypeFromFields<{
              softwareVersion: FieldType<number>;
              updateToken: FieldType<Uint8Array>;
          }>, void, any>;
          queryImage: Command<TypeFromFields<{
              hardwareVersion: OptionalFieldType<number>;
              location: OptionalFieldType<string>;
              metadataForProvider: OptionalFieldType<Uint8Array>;
              productId: FieldType<number>;
              protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
              requestorCanConsent: OptionalFieldType<boolean>;
              softwareVersion: FieldType<number>;
              vendorId: FieldType<VendorId>;
          }>, TypeFromFields<{
              delayedActionTime: OptionalFieldType<number>;
              imageUri: OptionalFieldType<string>;
              metadataForRequestor: OptionalFieldType<Uint8Array>;
              softwareVersion: OptionalFieldType<number>;
              softwareVersionString: OptionalFieldType<string>;
              status: FieldType<OtaSoftwareUpdateProvider.Status>;
              updateToken: OptionalFieldType<Uint8Array>;
              userConsentNeeded: OptionalFieldType<boolean>;
          }>, any>;
      };
      id: 41;
      name: "OtaSoftwareUpdateProvider";
      revision: 1;
  }>>
Parameters
- flags: FlagsT
Returns WithFlags<Of<{
    commands: {
        applyUpdateRequest: Command<TypeFromFields<{
            newVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, TypeFromFields<{
            action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
            delayedActionTime: FieldType<number>;
        }>, any>;
        notifyUpdateApplied: Command<TypeFromFields<{
            softwareVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, void, any>;
        queryImage: Command<TypeFromFields<{
            hardwareVersion: OptionalFieldType<number>;
            location: OptionalFieldType<string>;
            metadataForProvider: OptionalFieldType<Uint8Array>;
            productId: FieldType<number>;
            protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
            requestorCanConsent: OptionalFieldType<boolean>;
            softwareVersion: FieldType<number>;
            vendorId: FieldType<VendorId>;
        }>, TypeFromFields<{
            delayedActionTime: OptionalFieldType<number>;
            imageUri: OptionalFieldType<string>;
            metadataForRequestor: OptionalFieldType<Uint8Array>;
            softwareVersion: OptionalFieldType<number>;
            softwareVersionString: OptionalFieldType<string>;
            status: FieldType<OtaSoftwareUpdateProvider.Status>;
            updateToken: OptionalFieldType<Uint8Array>;
            userConsentNeeded: OptionalFieldType<boolean>;
        }>, any>;
    };
    id: 41;
    name: "OtaSoftwareUpdateProvider";
    revision: 1;
}>, FlagsT>
Inherited from Identity.enable
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:45

set

set<const ValuesT>(values): WithValues<Of<{
    commands: {
        applyUpdateRequest: Command<TypeFromFields<{
            newVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, TypeFromFields<{
            action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
            delayedActionTime: FieldType<number>;
        }>, any>;
        notifyUpdateApplied: Command<TypeFromFields<{
            softwareVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, void, any>;
        queryImage: Command<TypeFromFields<{
            hardwareVersion: OptionalFieldType<number>;
            location: OptionalFieldType<string>;
            metadataForProvider: OptionalFieldType<Uint8Array>;
            productId: FieldType<number>;
            protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
            requestorCanConsent: OptionalFieldType<boolean>;
            softwareVersion: FieldType<number>;
            vendorId: FieldType<VendorId>;
        }>, TypeFromFields<{
            delayedActionTime: OptionalFieldType<number>;
            imageUri: OptionalFieldType<string>;
            metadataForRequestor: OptionalFieldType<Uint8Array>;
            softwareVersion: OptionalFieldType<number>;
            softwareVersionString: OptionalFieldType<string>;
            status: FieldType<OtaSoftwareUpdateProvider.Status>;
            updateToken: OptionalFieldType<Uint8Array>;
            userConsentNeeded: OptionalFieldType<boolean>;
        }>, any>;
    };
    id: 41;
    name: "OtaSoftwareUpdateProvider";
    revision: 1;
}>, ValuesT>
Modify elements using ElementModifier.set.
Type Parameters
- const ValuesT extends {}
Parameters
- values: ValuesT
Returns WithValues<Of<{
    commands: {
        applyUpdateRequest: Command<TypeFromFields<{
            newVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, TypeFromFields<{
            action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
            delayedActionTime: FieldType<number>;
        }>, any>;
        notifyUpdateApplied: Command<TypeFromFields<{
            softwareVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, void, any>;
        queryImage: Command<TypeFromFields<{
            hardwareVersion: OptionalFieldType<number>;
            location: OptionalFieldType<string>;
            metadataForProvider: OptionalFieldType<Uint8Array>;
            productId: FieldType<number>;
            protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
            requestorCanConsent: OptionalFieldType<boolean>;
            softwareVersion: FieldType<number>;
            vendorId: FieldType<VendorId>;
        }>, TypeFromFields<{
            delayedActionTime: OptionalFieldType<number>;
            imageUri: OptionalFieldType<string>;
            metadataForRequestor: OptionalFieldType<Uint8Array>;
            softwareVersion: OptionalFieldType<number>;
            softwareVersionString: OptionalFieldType<string>;
            status: FieldType<OtaSoftwareUpdateProvider.Status>;
            updateToken: OptionalFieldType<Uint8Array>;
            userConsentNeeded: OptionalFieldType<boolean>;
        }>, any>;
    };
    id: 41;
    name: "OtaSoftwareUpdateProvider";
    revision: 1;
}>, ValuesT>
Inherited from Identity.set
- Defined in packages/types/dist/esm/cluster/mutation/MutableCluster.d.ts:41

with

with<const SelectionT>(...selection): Of<Of<{
    commands: {
        applyUpdateRequest: Command<TypeFromFields<{
            newVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, TypeFromFields<{
            action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
            delayedActionTime: FieldType<number>;
        }>, any>;
        notifyUpdateApplied: Command<TypeFromFields<{
            softwareVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, void, any>;
        queryImage: Command<TypeFromFields<{
            hardwareVersion: OptionalFieldType<number>;
            location: OptionalFieldType<string>;
            metadataForProvider: OptionalFieldType<Uint8Array>;
            productId: FieldType<number>;
            protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
            requestorCanConsent: OptionalFieldType<boolean>;
            softwareVersion: FieldType<number>;
            vendorId: FieldType<VendorId>;
        }>, TypeFromFields<{
            delayedActionTime: OptionalFieldType<number>;
            imageUri: OptionalFieldType<string>;
            metadataForRequestor: OptionalFieldType<Uint8Array>;
            softwareVersion: OptionalFieldType<number>;
            softwareVersionString: OptionalFieldType<string>;
            status: FieldType<OtaSoftwareUpdateProvider.Status>;
            updateToken: OptionalFieldType<Uint8Array>;
            userConsentNeeded: OptionalFieldType<boolean>;
        }>, any>;
    };
    id: 41;
    name: "OtaSoftwareUpdateProvider";
    revision: 1;
}>, SelectionT>
Select features using ClusterComposer.compose.
Type Parameters
- const SelectionT extends FeatureSelection<Of<{
      commands: {
          applyUpdateRequest: Command<TypeFromFields<{
              newVersion: FieldType<number>;
              updateToken: FieldType<Uint8Array>;
          }>, TypeFromFields<{
              action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
              delayedActionTime: FieldType<number>;
          }>, any>;
          notifyUpdateApplied: Command<TypeFromFields<{
              softwareVersion: FieldType<number>;
              updateToken: FieldType<Uint8Array>;
          }>, void, any>;
          queryImage: Command<TypeFromFields<{
              hardwareVersion: OptionalFieldType<number>;
              location: OptionalFieldType<string>;
              metadataForProvider: OptionalFieldType<Uint8Array>;
              productId: FieldType<number>;
              protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
              requestorCanConsent: OptionalFieldType<boolean>;
              softwareVersion: FieldType<number>;
              vendorId: FieldType<VendorId>;
          }>, TypeFromFields<{
              delayedActionTime: OptionalFieldType<number>;
              imageUri: OptionalFieldType<string>;
              metadataForRequestor: OptionalFieldType<Uint8Array>;
              softwareVersion: OptionalFieldType<number>;
              softwareVersionString: OptionalFieldType<string>;
              status: FieldType<OtaSoftwareUpdateProvider.Status>;
              updateToken: OptionalFieldType<Uint8Array>;
              userConsentNeeded: OptionalFieldType<boolean>;
          }>, any>;
      };
      id: 41;
      name: "OtaSoftwareUpdateProvider";
      revision: 1;
  }>>
Parameters
- Rest...selection: SelectionT
Returns Of<Of<{
    commands: {
        applyUpdateRequest: Command<TypeFromFields<{
            newVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, TypeFromFields<{
            action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
            delayedActionTime: FieldType<number>;
        }>, any>;
        notifyUpdateApplied: Command<TypeFromFields<{
            softwareVersion: FieldType<number>;
            updateToken: FieldType<Uint8Array>;
        }>, void, any>;
        queryImage: Command<TypeFromFields<{
            hardwareVersion: OptionalFieldType<number>;
            location: OptionalFieldType<string>;
            metadataForProvider: OptionalFieldType<Uint8Array>;
            productId: FieldType<number>;
            protocolsSupported: FieldType<OtaSoftwareUpdateProvider.DownloadProtocol[]>;
            requestorCanConsent: OptionalFieldType<boolean>;
            softwareVersion: FieldType<number>;
            vendorId: FieldType<VendorId>;
        }>, TypeFromFields<{
            delayedActionTime: OptionalFieldType<number>;
            imageUri: OptionalFieldType<string>;
            metadataForRequestor: OptionalFieldType<Uint8Array>;
            softwareVersion: OptionalFieldType<number>;
            softwareVersionString: OptionalFieldType<string>;
            status: FieldType<OtaSoftwareUpdateProvider.Status>;
            updateToken: OptionalFieldType<Uint8Array>;
            userConsentNeeded: OptionalFieldType<boolean>;
        }>, any>;
    };
    id: 41;
    name: "OtaSoftwareUpdateProvider";
    revision: 1;
}>, 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

base

commands

Type declaration

`Readonly`applyUpdateRequest: Command<TypeFromFields<{
    newVersion: FieldType<number>;
    updateToken: FieldType<Uint8Array>;
}>, TypeFromFields<{
    action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
    delayedActionTime: FieldType<number>;
}>, any>

See

`Readonly`notifyUpdateApplied: Command<TypeFromFields<{
softwareVersion: FieldType<number>;
updateToken: FieldType<Uint8Array>;
}>, void, any>

See

See

events

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

Interface Cluster

See

Hierarchy (view full)

Index

Properties

Methods

Properties

attributes

base

commands

Type declaration

ReadonlyapplyUpdateRequest: Command<TypeFromFields<{ newVersion: FieldType<number>; updateToken: FieldType<Uint8Array>; }>, TypeFromFields<{ action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>; delayedActionTime: FieldType<number>; }>, any>

See

ReadonlynotifyUpdateApplied: Command<TypeFromFields<{ softwareVersion: FieldType<number>; updateToken: FieldType<Uint8Array>; }>, void, any>

See

See

events

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`applyUpdateRequest: Command<TypeFromFields<{
newVersion: FieldType<number>;
updateToken: FieldType<Uint8Array>;
}>, TypeFromFields<{
action: FieldType<OtaSoftwareUpdateProvider.ApplyUpdateAction>;
delayedActionTime: FieldType<number>;
}>, any>

`Readonly`notifyUpdateApplied: Command<TypeFromFields<{
softwareVersion: FieldType<number>;
updateToken: FieldType<Uint8Array>;
}>, void, any>