Class: UNBQuerySubscribeStarAPIAction

//  NBQuerySubscribeStarAPIAction.h : 35

class NBSUBSCRIBESTARAPICLIENT_API UNBQuerySubscribeStarAPIAction
    : public UCancellableAsyncAction;

Reflection-enabled

This action can be used to submit custom queries to the SubscribeStar API. You may wish to do this if you need to access specific information about a user or their subscription which is not fetched by the simple query used in UNBSSGetUserInfoAction

For more information about queries, see: https://www.subscribestar.com/api-explorer

NOTE: You may need to enable additional scopes for your API client to support your custom queries!

These additional scopes will need to be provided to UNBSSAuthenticationAction during the initial authentication.

See here for more informaton about which scopes allow access to which data: https://www.subscribestar.com/api#integration

Properties

  • OnComplete

    public:
FNBQuerySubscribeStarAPIActionEvent OnComplete;

    Reflection-enabled

    Specifiers:

    • BlueprintAssignable
    Event fired when the task completes successfully

  • OnFail

    public:
FNBQuerySubscribeStarAPIActionEvent OnFail;

    Reflection-enabled

    Specifiers:

    • BlueprintAssignable
    Event fired if the task fails for any reason

Methods

  • Activate

    //  NBQuerySubscribeStarAPIAction.h : 67

public:
virtual void Activate() override;

    Starts the task

  • Cancel

    //  NBQuerySubscribeStarAPIAction.h : 72

public:
virtual void Cancel() override;

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

  • QueryAction

    //  NBQuerySubscribeStarAPIAction.h : 49

public:
static UNBQuerySubscribeStarAPIAction* QueryAction(
    const UObject* WorldContext,
    FNBSubscribeStarAPITokenInfo TokenInfo,
    const FString Query
);

    Reflection-enabled

    Specifiers:

    • BlueprintCallable
    • Category = NBSubscribeStarAPIClient

    Meta Specifiers:

    • DisplayName = Query SubscribeStar API
    • Keywords = SubscribeStar Query
    • WorldContext = WorldContext
    • BlueprintInternalUseOnly = true

    Performs a query on the SubscribeStar API

    Arguments

    • WorldContext

      const UObject* WorldContext

    • TokenInfo

      FNBSubscribeStarAPITokenInfo TokenInfo

      Must contain a valid unexpired access token

    • Query

      const FString Query

      Query string

    Returns

    • UNBQuerySubscribeStarAPIAction*





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