Type Alias iAddressListCreateObject<T>

iAddressListCreateObject<T>: iAddressList & {
    claims: {
        approach?: string;
        categories?: string[];
        claimId: string;
        estimatedCost?: string;
        estimatedTime?: string;
        plugins: IntegrationPluginDetails<ClaimIntegrationPluginType>[];
        rewards?: ClaimReward<T>[];
        showInSearchResults?: boolean;
    }[];
    private?: boolean;
    updateAddresses?: boolean;
    viewableWithLink?: boolean;
}

Type Parameters

Type declaration

  • claims: {
        approach?: string;
        categories?: string[];
        claimId: string;
        estimatedCost?: string;
        estimatedTime?: string;
        plugins: IntegrationPluginDetails<ClaimIntegrationPluginType>[];
        rewards?: ClaimReward<T>[];
        showInSearchResults?: boolean;
    }[]

    The claims of the address list. Use resetState on updates for resetting individual plugin state (if applicable).

  • Optionalprivate?: boolean

    Private lists will not show up in any search results.

  • OptionalupdateAddresses?: boolean

    Flag to update addresses?

  • OptionalviewableWithLink?: boolean

    If the list is viewable with a link, anyone with the list ID can view details. Only applicable if private = true as well. If not viewable with a link, only the creator can view the list.