admanagekit-billing/com.i2hammad.admanagekit.billing/BillingPeriod

BillingPeriod

data class BillingPeriod(val years: Int, val months: Int, val weeks: Int, val days: Int, val iso: String)

Parsed view over an ISO-8601 duration string as used by Google Play billing periods ("P7D", "P1W", "P1M", "P3M", "P6M", "P1Y").

Play returns raw ISO-8601 strings from com.android.billingclient.api.ProductDetails.PricingPhase.getBillingPeriod, which are not directly presentable to users and are awkward to compare. This class turns them into:

discrete components (years, months, weeks, days);
a single dominant unit + count pair, which is what you want for localized plurals (getQuantityString(R.plurals.days, count, count));
normalized totalMonths / totalDays, for price-per-month comparisons.

Obtain instances via parse. Comparisons and normalization use the average Gregorian month (30.436875 days) and year (365.2425 days), so P1Y normalizes to exactly 12.0 months and P12M does too.

val period = BillingPeriod.parse("P1Y")           // years=1
period.unit                                        // Unit.YEAR
period.count                                       // 1
period.totalMonths                                 // 12.0
period.format()                                    // "1 year"

Since

4.4.0

Constructors

constructor(years: Int, months: Int, weeks: Int, days: Int, iso: String)

Types

object Companion

enum Unit : Enum<BillingPeriod.Unit>

A single calendar unit, used together with count to render a localized period label without re-deriving it from the raw components.

Properties

The magnitude of the dominant unit. Pair these two for localized output: resources.getQuantityString(pluralFor(unit), count, count).

Days component of the duration (the nD term), or 0.

val iso: String

The original ISO-8601 string this was parsed from.

val isZero: Boolean

true when every component is zero (e.g. "P0D").

val months: Int

Months component of the duration (the nM date term), or 0.

val totalDays: Int

The whole duration expressed in days, rounded to the nearest whole day. P1Y → 365, P1M → 30, P1W → 7.

val totalMonths: Double

The whole duration expressed in months, using the average Gregorian month. P1Y → 12.0, P1M → 1.0, P1W → ≈0.23, P7D → ≈0.23.

val totalWeeks: Double

The whole duration expressed in weeks, using the average Gregorian month.

val unit: BillingPeriod.Unit

The dominant unit of this period — the largest non-zero component. A period of "P1M15D" reports Unit.MONTH; "P0D" reports Unit.DAY.

Weeks component of the duration (the nW term), or 0.

Years component of the duration (the nY term), or 0.

Functions

fun format(abbreviated: Boolean = false): String

Renders an English label such as "7 days", "1 month", "3 months".

open override fun toString(): String