PFGroup

Objective-C

@interface PFGroup : NSObject

Swift

class PFGroup : NSObject

Contains information about the product group. This has all necessary information about the subscription status.

  • id

    Identifier for product group.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable id;

    Swift

    var id: String? { get }

  • Name of the product group.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull name;

    Swift

    var name: String { get }

  • Current status of the group which shows the status of the subscription. Possible values are in PFGroupStatus.

    Declaration

    Objective-C

    @property (readonly) PFGroupStatus status;

    Swift

    var status: PFGroupStatus { get }

  • If subscription is active for the product group, this returns the active package for the group.

    Declaration

    Objective-C

    @property (nonatomic, readonly) PFPackageInfo *_Nonnull activePackage;

    Swift

    var activePackage: PFPackageInfo { get }

  • This returns all the packages that this group has.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<PFPackageInfo *> *_Nonnull allPackages;

    Swift

    var allPackages: [PFPackageInfo] { get }

  • If the group is active. Group becomes active when there’s an active subscription by any of the products that the group is consisted of.

    Declaration

    Objective-C

    @property (readonly) Boolean isActive;

    Swift

    var isActive: Bool { get }

  • If the group’s active subscription is from sandbox environment.

    Declaration

    Objective-C

    @property (readonly) Boolean isSandbox;

    Swift

    var isSandbox: Bool { get }

  • If the group’s active subscription is in trial state.

    Declaration

    Objective-C

    @property (readonly) Boolean trial;

    Swift

    var trial: Bool { get }

  • If the group has active subscription, it’s the id of that.

    Declaration

    Objective-C

    @property (readonly) NSString *_Nullable subscriptionId;

    Swift

    var subscriptionId: String? { get }

  • If the group’s active subscription will renew.

    Declaration

    Objective-C

    @property (readonly) Boolean willRenew;

    Swift

    var willRenew: Bool { get }

  • If the group’s active subscription has a discount period.

    Declaration

    Objective-C

    @property (nonatomic, readonly) PFDiscount *_Nonnull discount;

    Swift

    var discount: PFDiscount { get }

  • All the packages of this group in a dictionary keyed with package’s names.

    Declaration

    Objective-C

    @property (readonly) PFPackageByName *_Nonnull packageByName;

    Swift

    var packageByName: [String : PFPackageInfo] { get }

  • When the group’s active subscription will expire.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDate *_Nonnull expirationDate;

    Swift

    var expirationDate: Date { get }

  • When the group’s active subscription was purchased for first time.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDate *_Nonnull originalPurchaseDate;

    Swift

    var originalPurchaseDate: Date { get }

  • When the group’s active subscription was purchased/renewed/upgraded/downgraded latest.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSDate *_Nonnull latestPurchaseDate;

    Swift

    var latestPurchaseDate: Date { get }