Skip to content

Interface: IntegrationPluginParams<T>

T extends ClaimIntegrationPluginType

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:961

Extended by

Type Parameters

T

T extends ClaimIntegrationPluginType

Properties

instanceId

instanceId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:969

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.

metadata?

optional metadata?: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:982

Custom display metadata for the plugin. This will override the default metadata for the plugin.

description

description: string

image?

optional image?: string

name

name: string

pluginId

pluginId: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:974

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.

privateParams

privateParams: ClaimIntegrationPrivateParamsType<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:980

The parameters of the plugin that are not visible to the public. These are custom per plugin type.

publicParams

publicParams: ClaimIntegrationPublicParamsType<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:978

The parameters of the plugin that are visible to the public. These are custom per plugin type.

version

version: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:976

The version of the plugin

Edit this page on GitHub