Interface iClaimBuilderDoc<T>

interface iClaimBuilderDoc<T> {
    _docId: string;
    _id?: string;
    action: {
        balancesToSet?: iPredeterminedBalances<T>;
        codes?: string[];
        listId?: string;
        seedCode?: string;
    };
    approach?: string;
    assignMethod?: string;
    cid: string;
    collectionId: T;
    createdAt: T;
    createdBy: string;
    deletedAt?: T;
    docClaimed: boolean;
    lastUpdated: T;
    manualDistribution?: boolean;
    metadata?: iMetadata<T>;
    plugins: IntegrationPluginParams<string>[];
    state: {
        [pluginId: string]: any;
    };
    trackerDetails?: iChallengeTrackerIdDetails<T>;
}

Type Parameters

Hierarchy (view full)

  • Doc
    • iClaimBuilderDoc

Implemented by

Properties

_docId _id? action approach? assignMethod? cid collectionId createdAt createdBy deletedAt? docClaimed lastUpdated manualDistribution? metadata? plugins state trackerDetails?

Properties

_docId

_docId: string

A unique stringified document ID

Optional _id

_id?: string

A unique document ID (Mongo DB ObjectID)

action

action: {
    balancesToSet?: iPredeterminedBalances<T>;
    codes?: string[];
    listId?: string;
    seedCode?: string;
}

Details for the action to perform if the criteria is correct

Type declaration

  • Optional balancesToSet?: iPredeterminedBalances<T>
  • Optional codes?: string[]
  • Optional listId?: string
  • Optional seedCode?: string

Optional approach

approach?: string

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

Optional assignMethod

assignMethod?: string

Algorithm to determine the claaim number indices

cid

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

collectionId: T

The collection ID of the document

createdAt

createdAt: T

createdBy

createdBy: string

The cosmos address of the user who created this password

Optional deletedAt

deletedAt?: T

Deleted at timestamp

docClaimed

docClaimed: boolean

True if the document is claimed by the collection

lastUpdated

lastUpdated: T

Optional manualDistribution

manualDistribution?: boolean

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

Optional metadata

metadata?: iMetadata<T>

Metadata for the claim

plugins

plugins: IntegrationPluginParams<string>[]

Dynamic checks to run in the form of plugins

state

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

The current state of each plugin

Type declaration

  • [pluginId: string]: any

Optional trackerDetails

trackerDetails?: iChallengeTrackerIdDetails<T>

Which challenge tracker is it tied to

Settings

Member Visibility

Theme

On This Page

_docId_idactionapproachassignMethodcidcollectionIdcreatedAtcreatedBydeletedAtdocClaimedlastUpdatedmanualDistributionmetadatapluginsstatetrackerDetails