Class ClaimBuilderDoc<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_docId: string

A unique stringified document ID

_id?: string

A unique document ID (Mongo DB ObjectID)

action: {
    balancesToSet?: PredeterminedBalances<T>;
    listId?: string;
    seedCode?: string;
    siwbbClaim?: boolean;
}

Details for the action to perform if the criteria is correct

approach?: string

If the claim has been designated to be completed automatically for users.

assignMethod?: string

Algorithm to determine the claaim number indices

categories?: string[]

The categories of the claim

cid: string

The CID (content ID) of the document. This is used behind the scenes to handle off-chain vs on-chain data races.

collectionId: T

The collection ID of the document

createdAt: T
createdBy: string

The BitBadges address of the user who created this password

deletedAt?: T

Deleted at timestamp

docClaimed: boolean

True if the document is claimed by the collection

estimatedCost?: string

Estimated cost for the user

estimatedTime?: string

Estimated time to satisfy the claim's requirements

lastUpdated: T
manualDistribution?: boolean

If true, the claim codes are to be distributed manually. This doc will only be used for storage purposes.

metadata?: Metadata<T>

Metadata for the claim

pluginIds?: string[]

For query purposes, the plugin IDs

plugins: IntegrationPluginParams<string>[]

Dynamic checks to run in the form of plugins

rewards?: ClaimReward<T>[]

Rewards to be shown upon a successful claim. If you need further gating, you can do this in two-steps.

satisfyMethod?: SatisfyMethod

Custom success logic. If not provided, we will default to AND logic with all plugins.

showInSearchResults?: boolean

If true, the claim will be shown in search results

state: {
    [pluginId: string]: any;
}

The current state of each plugin

testOnly?: boolean
trackerDetails?: ChallengeTrackerIdDetails<T>

Which challenge tracker is it tied to

version: T

Methods

  • Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

    If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

    Type Parameters

    Parameters

    • other: undefined | null | CustomType<U>
    • OptionalnormalizeNumberTypes: boolean

    Returns boolean