Struct: FNBSubscribeStarUserInfo

//  NBSubscribeStarUserInfo.h : 20

struct NBSUBSCRIBESTARAPICLIENT_API FNBSubscribeStarUserInfo;

Reflection-enabled

Specifiers:

  • BlueprintType

Contains basic information about a user from the SubscribeStar API. This is meant as a convenience to cover the information most applications might need (e.g. to unlock specific content for users subscribed to a particular tier or to display information about their subscription to a user).

If the information contained here doesn't cover your needs, please feel free to contact me at nbpsup@gmail.com

Additionally, you can send a custom query to the SubscribeStar API to get any other data you need with the UNBQuerySubscribeStarAPIAction.

Properties

  • AvatarURL

    public:
FString AvatarURL;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • BlueprintReadWrite
    • Category = NBSubscribeStarAPIClient|User
    URL to download the user's avatar image

  • HasActiveSubscription

    public:
bool HasActiveSubscription;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • BlueprintReadWrite
    • Category = NBSubscribeStarAPIClient|User
    Indicates whether this user is currently subscribed to your campaign or not.

    If this is false, then either the user has never subscribed to your campaign before, or their subscription is currently inactive for some reason (e.g. payment processing problems).

    If this is false, fields related to subscription details should not be used.

  • Name

    public:
FString Name;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • BlueprintReadWrite
    • Category = NBSubscribeStarAPIClient|User
    User's SubscribeStar nickname (may not be their real name)

  • SubscriptionPrice

    public:
int32 SubscriptionPrice;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • BlueprintReadWrite
    • Category = NBSubscribeStarAPIClient|User
    Price of the user's current subscription, in cents. May be different from the user's **tier** price.

  • TierID

    public:
FString TierID;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • BlueprintReadWrite
    • Category = NBSubscribeStarAPIClient|User
    If the user is subscribed to a specific tier, contains the ID of the tier they are subscribed to.

Constructors

  • FNBSubscribeStarUserInfo

    //  NBSubscribeStarUserInfo.h : 25

public:
FNBSubscribeStarUserInfo();

  • FNBSubscribeStarUserInfo

    //  NBSubscribeStarUserInfo.h : 33

public:
FNBSubscribeStarUserInfo(
    const FString& json
);

    Constructs NBSubscribeStarUserInfo from a JSON string. Populates any fields it can find in the provided JSON. If the provided json string cannot be parsed for any reason, the result will be uninitialized.

    Arguments

    • json

      const FString& json





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