Interface iClaimReward<T>

interface iClaimReward<T> {
    automatic?: boolean;
    gatedContent: iClaimGatedContent;
    instanceId: string;
    metadata?: {
        description: string;
        image: string;
        name: string;
    };
    rewardId: string;
}

Type Parameters

Implemented by

Properties

automatic? gatedContent instanceId metadata? rewardId

Properties

Optionalautomatic

automatic?: boolean

If true, the reward is automatically given to the user upon completion.

gatedContent

gatedContent: iClaimGatedContent

The gated content to display upon completion.

instanceId

instanceId: string

The instance ID of the reward

Optionalmetadata

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

Metadata for the reward. This is public-facing, so do not include any gated content here. By default, we use the associated rewardId.

rewardId

rewardId: string

The ID of the reward (either a pre-configured one or "custom")

Settings

Member Visibility

On This Page

Properties