Class: UNBSSGetUserInfoAction

//  NBSSGetUserInfoAction.h : 26

class NBSUBSCRIBESTARAPICLIENT_API UNBSSGetUserInfoAction
    : public UCancellableAsyncAction;

Reflection-enabled

Retrieves information about a SubscribeStar user. Can be used to check if they are subscribed to a specific tier in order to unlock content, display information about their subscription, etc.

Requires an access token obtained by some authentication method.

If you need additional information about a user not provided by this action, you can use UNBQuerySubscribeStarAPIAction to submit a custom query to the API.

Properties

  • OnComplete

    public:
FGetSubscribeStarUserInfoActionEvent OnComplete;

    Reflection-enabled

    Specifiers:

    • BlueprintAssignable
    Event fired when the task completes successfully

  • OnFail

    public:
FGetSubscribeStarUserInfoActionFailedEvent OnFail;

    Reflection-enabled

    Specifiers:

    • BlueprintAssignable
    Event fired if the task fails for any reason

Methods

  • Activate

    //  NBSSGetUserInfoAction.h : 58

public:
virtual void Activate() override;

    Starts the task

  • Cancel

    //  NBSSGetUserInfoAction.h : 63

public:
virtual void Cancel() override;

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

  • GetSubscribeStarUserInfoAsyncAction

    //  NBSSGetUserInfoAction.h : 40

public:
static UNBSSGetUserInfoAction* GetSubscribeStarUserInfoAsyncAction(
    const UObject* WorldContext,
    FNBSubscribeStarAPITokenInfo TokenInfo
);

    Reflection-enabled

    Specifiers:

    • BlueprintCallable
    • Category = NBSubscribeStarAPIClient

    Meta Specifiers:

    • DisplayName = Get User Info
    • Keywords = SubscribeStar
    • WorldContext = WorldContext
    • BlueprintInternalUseOnly = true

    Retrieves basic information about the user and their subscription (if they have one)

    Will fail if the access token is empty, invalid, or expired.

    Arguments

    • WorldContext

      const UObject* WorldContext

    • TokenInfo

      FNBSubscribeStarAPITokenInfo TokenInfo

      Token information for the user

    Returns

    • UNBSSGetUserInfoAction*





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