The ID of the plugin instance. This is a unique identifier for referencing this instance of the plugin within this claim (e.g. differentiate between duplicates of the same plugin type).
This is different from the pluginId, which is a unique identifier for the plugin itself. All instances of the same plugin will have the same pluginId.
OptionalmetadataCustom display metadata for the plugin. This will override the default metadata for the plugin.
OptionalnewIf newState is present, we will set the state to the new state. Incompatible with resetState. Can be used alongside onlyUpdateProvidedNewState. By default, we will overwrite the whole state. If onlyUpdateProvidedNewState is true, we will only update the specific provided fields.
Warning: This is an advanced feature and should be used with caution. Misconfiguring this can lead to unexpected behavior of this plugin.
Note: Each plugin may have different state schemas. Please refer to the documentation of the plugin you are updating for more information.
OptionalonlyIf true, we will only update the specific fields provided in newState. If falsy, we will overwrite the whole state with newState.
Only applicable if newState is present.
Note that we do this on a recursive level. If you have nested objects, we will only update the specific fields provided for those nested objects and leave all else as-is.
The ID of the plugin (e.g. "numUses"). This is the reusable plugin ID. Do not use this as a unique identifier for the plugin instance as there could be duplicate pluginIds. Use instanceId instead.
The parameters of the plugin that are not visible to the public. These are custom per plugin type.
The parameters of the plugin that are visible to the public. These are custom per plugin type.
OptionalresetIf resetState = true, we will reset the state of the plugin back to default. If false, we will keep the current state. Incompatible with newState.
The version of the plugin