Interface IntegrationPluginParams<T>

interface IntegrationPluginParams<T> {
    instanceId: string;
    metadata?: {
        description: string;
        name: string;
    };
    pluginId: T;
    privateParams: ClaimIntegrationPrivateParamsType<T>;
    publicParams: ClaimIntegrationPublicParamsType<T>;
}

Type Parameters

Hierarchy (view full)

Properties

instanceId metadata? pluginId privateParams publicParams

Properties

instanceId

instanceId: string

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.

Optional metadata

metadata?: {
    description: string;
    name: string;
}

Custom display metadata for the plugin

Type declaration

  • description: string
  • name: string

pluginId

pluginId: T

The type of the plugin

privateParams

privateParams: ClaimIntegrationPrivateParamsType<T>

The parameters of the plugin that are not visible to the public

publicParams

publicParams: ClaimIntegrationPublicParamsType<T>

The parameters of the plugin that are visible to the public

Settings

Member Visibility

Theme

On This Page

instanceIdmetadatapluginIdprivateParamspublicParams