bitbadgesjs-sdk - v0.22.7
    Preparing search index...

    Interface iClaimDetails<T>

    interface iClaimDetails<T extends NumberType> {
        _includesPrivateParams: boolean;
        _templateInfo?: {
            completedTemplateStep?: boolean;
            pluginId?: string;
            supportedApproaches?: string[];
        };
        approach?: string;
        assignMethod?: string;
        cachePolicy?: iClaimCachePolicy<T>;
        categories?: string[];
        claimId: string;
        collectionId?: string;
        createdBy?: string;
        estimatedCost?: string;
        estimatedTime?: string;
        lastUpdated?: T;
        managedBy?: string;
        manualDistribution?: boolean;
        metadata?: iMetadata<T>;
        plugins: IntegrationPluginDetails<string>[];
        rewards?: iClaimReward<T>[];
        satisfyMethod?: iSatisfyMethod;
        seedCode?: string;
        showInSearchResults?: boolean;
        standaloneClaim?: boolean;
        trackerDetails?: iChallengeTrackerIdDetails<T>;
        version: T;
    }

    Type Parameters

    Implemented by

    Index

    Properties

    _includesPrivateParams _templateInfo? approach? assignMethod? cachePolicy? categories? claimId collectionId? createdBy? estimatedCost? estimatedTime? lastUpdated? managedBy? manualDistribution? metadata? plugins rewards? satisfyMethod? seedCode? showInSearchResults? standaloneClaim? trackerDetails? version

    Properties

    _includesPrivateParams

    _includesPrivateParams: boolean

    Whether the claim fetch includes private params

    Optional Internal_templateInfo

    _templateInfo?: {
        completedTemplateStep?: boolean;
        pluginId?: string;
        supportedApproaches?: string[];
    }

    For internal use by the frontend.

    approach?: string

    How the claim is expected to be completed. This is for display purposes for the frontend.

    Available options:

    • in-site (default): The claim is expected to be completed in-site.
    • api: The claim is expected to be completed via an API call.
    • zapier: The claim is expected to be completed via Zapier auto-completion.

    Typically, you will use the in-site approach

    assignMethod?: string

    Algorithm to determine the claim number order. Blank is just incrementing claim numbers.

    For most cases, you will not need to specify this.

    cachePolicy?: iClaimCachePolicy<T>

    Cache policy for the claim. Only needed for on-demand claims.

    categories?: string[]

    The categories of the claim

    claimId: string

    Unique claim ID.

    collectionId?: string

    Collection ID that the claim is for (if applicable - collection claims).

    createdBy?: string

    The original creator of the claim

    estimatedCost?: string

    Estimated cost for the claim.

    estimatedTime?: string

    Estimated time to satisfy the claim's requirements.

    lastUpdated?: T

    Last updated timestamp for the claim.

    managedBy?: string

    The BitBadges address of the user who is currently managing this

    manualDistribution?: boolean

    If manual distribution is enabled, we do not handle any distribution of claim codes. We leave that up to the claim creator.

    Only applicable for on-chain token claims. This is only used in advanced self-hosted cases.

    metadata?: iMetadata<T>

    Metadata for the claim.

    plugins: IntegrationPluginDetails<string>[]

    Claim plugins. These are the criteria that must pass for a user to claim.

    rewards?: iClaimReward<T>[]

    Rewards for the claim.

    satisfyMethod?: iSatisfyMethod

    Custom satisfaction logic.

    If left blank, all plugins must pass for the claim to be satisfied. Otherwise, you can specify a custom method to determine if the claim is satisfied.

    seedCode?: string

    Seed code for the claim. Only used for on-chain token claims.

    This is how we produce all reserved codes for the on-chain merkle challenge / proofs.

    showInSearchResults?: boolean

    If true, the claim will be shown in search results

    standaloneClaim?: boolean

    Standalone claims are not linked with a token or list.

    trackerDetails?: iChallengeTrackerIdDetails<T>

    The tracker details for the claim (if applicable - collection claims).

    version: T

    The version of the claim.

    Settings

    Member Visibility

    On This Page

    Properties