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

    Interface iQueueDoc<T>

    interface iQueueDoc<T extends NumberType> {
        _docId: string;
        _id?: string;
        actionConfig?: any;
        activityDocId?: string;
        claimInfo?: {
            bitbadgesAddress: string;
            body: any;
            claimId: string;
            ip: undefined | string;
            session: any;
            [key: string]: any;
        };
        collectionId: string;
        deletedAt?: T;
        emailMessage?: string;
        error?: string;
        faucetInfo?: {
            amount: NumberType;
            denom: string;
            recipient: string;
            txHash: string;
        };
        initiatedBy?: string;
        lastFetchedAt?: T;
        loadBalanceId: T;
        nextFetchTime?: T;
        notificationType?: string;
        numRetries: T;
        pending?: boolean;
        recipientAddress?: string;
        refreshRequestTime: T;
        uri: string;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    _docId _id? actionConfig? activityDocId? claimInfo? collectionId deletedAt? emailMessage? error? faucetInfo? initiatedBy? lastFetchedAt? loadBalanceId nextFetchTime? notificationType? numRetries pending? recipientAddress? refreshRequestTime uri

    Properties

    _docId

    _docId: string

    A unique stringified document ID

    Optional_id

    _id?: string

    A unique document ID (Mongo DB ObjectID)

    actionConfig?: any

    For use for post-claim actions

    activityDocId?: string
    claimInfo?: {
        bitbadgesAddress: string;
        body: any;
        claimId: string;
        ip: undefined | string;
        session: any;
        [key: string]: any;
    }

    For use for claim completion

    collectionId: string

    The collection ID of the metadata to be fetched

    deletedAt?: T

    The timestamp of when this document was deleted (milliseconds since epoch)

    emailMessage?: string
    error?: string

    The error message if this metadata failed to be fetched

    faucetInfo?: {
        amount: NumberType;
        denom: string;
        recipient: string;
        txHash: string;
    }

    For use for airdrops

    initiatedBy?: string

    The BitBadges address of the user who initiated this fetch

    lastFetchedAt?: T

    The timestamp of when this metadata was last fetched (milliseconds since epoch)

    loadBalanceId: T

    The load balance ID of the metadata to be fetched. Only the node with the same load balance ID will fetch this metadata

    nextFetchTime?: T

    The timestamp of when this document should be fetched next (milliseconds since epoch)

    notificationType?: string

    Type of the doc / purpose

    numRetries: T

    The number of times this metadata has been tried to be fetched but failed

    pending?: boolean

    Whether this document is pending to be fetched or not

    recipientAddress?: string
    refreshRequestTime: T

    The timestamp of when this metadata was requested to be refreshed (milliseconds since epoch)

    uri: string

    The URI of the metadata to be fetched. If {id} is present, it will be replaced with each individual ID in tokenIds

    Settings

    Member Visibility

    On This Page

    Properties