Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introductory Price parsing (#186) #196

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Introductory Price parsing (#186) #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fdfd29
Parsing SKProductDiscount inside SKProduct (#186)
whtlnv Sep 22, 2018
4295077
Readme updated for the introductoryPrice property
whtlnv Sep 22, 2018
898af47
Merge branch 'introductory-price'
whtlnv Sep 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions InAppUtils/InAppUtils.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ - (void)productsRequest:(SKProductsRequest *)request
products = [NSMutableArray arrayWithArray:response.products];
NSMutableArray *productsArrayForJS = [NSMutableArray array];
for(SKProduct *item in response.products) {
NSDictionary *introductoryPrice = [InAppUtils parseIntroductoryPrice: item];
NSDictionary *product = @{
@"identifier": item.productIdentifier,
@"price": item.price,
Expand All @@ -223,6 +224,7 @@ - (void)productsRequest:(SKProductsRequest *)request
@"downloadable": item.downloadable ? @"true" : @"false" ,
@"description": item.localizedDescription ? item.localizedDescription : @"",
@"title": item.localizedTitle ? item.localizedTitle : @"",
@"introductoryPrice": (introductoryPrice == nil) ? [NSNull null] : introductoryPrice,
};
[productsArrayForJS addObject:product];
}
Expand Down Expand Up @@ -265,6 +267,66 @@ - (void)dealloc
[[SKPaymentQueue defaultQueue] removeTransactionObserver:self];
}

#pragma mark Static

+ (NSDictionary *)parseIntroductoryPrice: (SKProduct *)product {
if(@available(iOS 11.2, *)) {
if (product != nil && product.introductoryPrice != nil) {
// paymentMode: Returning as string for ease of use and code resilience
NSString *paymentMode;
switch (product.introductoryPrice.paymentMode) {
case SKProductDiscountPaymentModeFreeTrial:
paymentMode = @"freeTrial";
break;
case SKProductDiscountPaymentModePayAsYouGo:
paymentMode = @"payAsYouGo";
break;
case SKProductDiscountPaymentModePayUpFront:
paymentMode = @"payUpFront";
break;
default:
paymentMode = @"unavailable";
break;
}

// subscriptionPeriod: Returning as Dictionary { unit: NSString, numberOfUnits: NSNumber }
NSString *subscriptionPeriodUnit;
switch (product.introductoryPrice.subscriptionPeriod.unit) {
case SKProductPeriodUnitDay:
subscriptionPeriodUnit = @"day";
break;
case SKProductPeriodUnitWeek:
subscriptionPeriodUnit = @"week";
break;
case SKProductPeriodUnitMonth:
subscriptionPeriodUnit = @"month";
break;
case SKProductPeriodUnitYear:
subscriptionPeriodUnit = @"year";
break;
default:
subscriptionPeriodUnit = @"unavailable";
break;
}

NSDictionary *subscriptionPeriod = @{
@"unit": subscriptionPeriodUnit,
@"numberOfUnits": [[NSNumber alloc] initWithLong:product.introductoryPrice.subscriptionPeriod.numberOfUnits],
};

NSDictionary *introductoryPrice = @{
@"price": product.introductoryPrice.price,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to get the localized price string here. Similar to the product implementation.

Copy link

@YannickDot YannickDot May 2, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't add my commits in this PR so I made new one with the changes you requested (#206)

@"numberOfPeriods": [[NSNumber alloc] initWithLong:product.introductoryPrice.numberOfPeriods],
@"paymentMode": paymentMode,
@"subscriptionPeriod": subscriptionPeriod,
};
return introductoryPrice;
}
}

return nil;
}

#pragma mark Private

static NSString *RCTKeyForInstance(id instance)
Expand Down
49 changes: 38 additions & 11 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,47 @@ InAppUtils.loadProducts(identifiers, (error, products) => {

**Response:** An array of product objects with the following fields:

| Field | Type | Description |
| -------------- | ------- | ------------------------------------------- |
| identifier | string | The product identifier |
| price | number | The price as a number |
| currencySymbol | string | The currency symbol, i.e. "$" or "SEK" |
| currencyCode | string | The currency code, i.e. "USD" of "SEK" |
| priceString | string | Localised string of price, i.e. "$1,234.00" |
| countryCode | string | Country code of the price, i.e. "GB" or "FR"|
| downloadable | boolean | Whether the purchase is downloadable |
| description | string | Description string |
| title | string | Title string |
| Field | Type | Description |
| ----------------- | ------- | ------------------------------------------- |
| identifier | string | The product identifier |
| price | number | The price as a number |
| currencySymbol | string | The currency symbol, i.e. "$" or "SEK" |
| currencyCode | string | The currency code, i.e. "USD" of "SEK" |
| priceString | string | Localised string of price, i.e. "$1,234.00" |
| countryCode | string | Country code of the price, i.e. "GB" or "FR"|
| downloadable | boolean | Whether the purchase is downloadable |
| description | string | Description string |
| title | string | Title string |
| introductoryPrice | object | Introductory price definition (iOS 11.2+) |

**Troubleshooting:** If you do not get back your product(s) then there's a good chance that something in your iTunes Connect or Xcode is not properly configured. Take a look at this [StackOverflow Answer](http://stackoverflow.com/a/11707704/293280) to determine what might be the issue(s).

#### Introductory Price

If an `SKProduct` returned by the store contains an `SKProductDiscount` it'll be described inside `introductoryPrice` as follows:

| Field | Type | Description |
| ------------------ | ------- | --------------------------------------------------- |
| price | number | The price as a number |
| numberOfPeriods | number | Number of periods the product discount is available |
| paymentMode | string | The payment mode for this product discount |
| subscriptionPeriod | object | Defines the period for the product discount |

Where `paymentMode` can be any of `['freeTrial', 'payAsYouGo', 'payUpFront', 'unavailable']`.

And `subscriptionPeriod` contains:

| Field | Type | Description |
| ------------------ | ------- | ----------------------------------------------------------------- |
| unit | string | The number of units per subscription period |
| numberOfUnits | number | The increment of time that a subscription period is specified in. |

Where `numberOfUnits` can be any of `['day', 'week', 'month', 'year', 'unavailable']`;

If the product has no `SKProductDiscount` associated, `introductoryPrice` will be set to `null`.

**Note:** Introductory Price is only available in iOS 11.2+, if ran in another version `introductoryPrice` will be set to `null`.

### Checking if payments are allowed

```javascript
Expand Down