Class: UGetPatreonUserPledgesAsyncAction

//  GetPatreonUserPledgesAsyncAction.h : 20

class NBPATREONAPICLIENT_API UGetPatreonUserPledgesAsyncAction
    : public UCancellableAsyncAction;

Reflection-enabled

Properties

  • OnComplete

    public:
FGetPatreonUserPledgesAsyncActionEvent OnComplete;

    Reflection-enabled

    Specifiers:

    • BlueprintAssignable
    Event invoked when pledge history is successfully retrieved

  • OnFail

    public:
FGetPatreonUserPledgesAsyncActionFailedEvent OnFail;

    Reflection-enabled

    Specifiers:

    • BlueprintAssignable
    Event invoked if fetching the pledge history fails for any reason

Methods

  • Activate

    //  GetPatreonUserPledgesAsyncAction.h : 67

public:
virtual void Activate() override;

    Starts the task

  • Cancel

    //  GetPatreonUserPledgesAsyncAction.h : 72

public:
virtual void Cancel() override;

    Can be called to cancel the task and prevent callbacks from being called

  • GetPatreonUserPledgesAfterAsyncAction

    //  GetPatreonUserPledgesAsyncAction.h : 49

public:
static UGetPatreonUserPledgesAsyncAction* GetPatreonUserPledgesAfterAsyncAction(
    const UObject* WorldContext,
    const FAPITokenInfo TokenInfo,
    const FDateTime& StartDate,
    bool DiscardUnpaid = true,
    const FString CampaignID = TEXT("")
);

    Reflection-enabled

    Specifiers:

    • BlueprintCallable
    • Category = NBPatreonAPIClient|Pledge History

    Meta Specifiers:

    • DisplayName = Get Pledge History After
    • Keywords = NBPatreonAPIClient
    • WorldContext = WorldContext
    • BlueprintInternalUseOnly = true

    Fetches a user's pledge history after a specified date. If you are only interested in a small recent time range you may wan to use this to avoid processing unneeded pledge history entries later (e.g. when searching for a previously-pledged tier). It is recommended to still request a little more than you need (e.g. if you are only interested in pledges in June you may want to request pledges starting in May to capture cases where a user started their pledge on May 30 and was entitled to that tier during June).

    Arguments

    • WorldContext

      const UObject* WorldContext

    • TokenInfo

      const FAPITokenInfo TokenInfo

      Valid TokenInfo from the user to fetch pledge history for

    • StartDate

      const FDateTime& StartDate

      Pledge events with timestamps earlier than this date will not be included in the results

    • DiscardUnpaid

      bool DiscardUnpaid = true

      If true, pledge events with invalid payment states (e.g. declined payments) will not be included in the results

    • CampaignID

      const FString CampaignID = TEXT("")

      If not empty, will only process pledge events with a matching campaign ID and discard others

    Returns

    • UGetPatreonUserPledgesAsyncAction*

  • GetPatreonUserPledgesAsyncAction

    //  GetPatreonUserPledgesAsyncAction.h : 34

public:
static UGetPatreonUserPledgesAsyncAction* GetPatreonUserPledgesAsyncAction(
    const UObject* WorldContext,
    const FAPITokenInfo TokenInfo,
    bool DiscardUnpaid = true,
    const FString CampaignID = TEXT("")
);

    Reflection-enabled

    Specifiers:

    • BlueprintCallable
    • Category = NBPatreonAPIClient|Pledge History

    Meta Specifiers:

    • DisplayName = Get Pledge History
    • Keywords = NBPatreonAPIClient
    • WorldContext = WorldContext
    • BlueprintInternalUseOnly = true

    Fetches a user's pledge history. This can be used to check if they were previously pledged to a tier (even if they may have since unsubscribed), find out when they started their subscription to their current tier, etc.

    Arguments

    • WorldContext

      const UObject* WorldContext

    • TokenInfo

      const FAPITokenInfo TokenInfo

      Valid TokenInfo from the user to fetch pledge history for

    • DiscardUnpaid

      bool DiscardUnpaid = true

      If true, pledge events with invalid payment states (e.g. declined payments) will not be included in the results

    • CampaignID

      const FString CampaignID = TEXT("")

      If not empty, will only process pledge events with a matching campaign ID and discard others

    Returns

    • UGetPatreonUserPledgesAsyncAction*





For any questions, help, suggestions or feature requests, please feel free to contact me at nbpsup@gmail.com