capacitor-plugin-glassfy v4.0.0

Warning These plugin is for Capacitor 6. For Capacitor 5, use the 3.x version.

CapacitorJS Glassfy Plugin

Glassfy is a subscription revenue optimisation infrastructure for mobile applications.

Getting Started

Check the documentation at docs.glassfy.io to learn details on implementing and using Glassfy SDK.

Plugin Install

npm install capacitor-plugin-glassfy
npx cap sync

Build plugin and example

be sure to have ionic cli installed following instructions here

npm install
npm run build
cd example
npm install
ionic capacitor sync ios
ionic capacitor open ios

API

• sdkVersion()
• initialize(...)
• setLogLevel(...)
• offerings()
• purchaseHistory()
• permissions()
• skuWithId(...)
• skuWithIdAndStore(...)
• connectCustomSubscriber(...)
• connectPaddleLicenseKey(...)
• connectGlassfyUniversalCode(...)
• setEmailUserProperty(...)
• setDeviceToken(...)
• setExtraUserProperty(...)
• getUserProperty()
• purchaseSku(...)
• restorePurchases()
• storeInfo()
• setAttribution(...)
• setAttributions(...)
• _paywall(...)
• _closePaywall()
• _openUrl(...)
• Interfaces
• Type Aliases
• Enums

sdkVersion()

sdkVersion() => Promise<GlassfyVersion>

Returns: Promise<GlassfyVersion>

initialize(...)

initialize(options: { apiKey: string; watcherMode: boolean; }) => Promise<void>

For more details, follow instruction at https://docs.glassfy.io/get-started/configuration

setLogLevel(...)

setLogLevel(options: { logLevel: GLASSFY_LOGLEVEL; }) => Promise<void>

offerings()

offerings() => Promise<GlassfyOfferings>

For more details, check the documentation https://docs.glassfy.io/dashboard/configure-offerings

Returns: Promise<GlassfyOfferings>

purchaseHistory()

purchaseHistory() => Promise<GlassfyPurchasesHistory>

For more details, check the documentation https://docs.glassfy.io/dashboard/configure-offerings

Returns: Promise<GlassfyPurchasesHistory>

permissions()

permissions() => Promise<GlassfyPermissions>

For more details, check the documentation https://docs.glassfy.io/dashboard/configure-permissions.html

Returns: Promise<GlassfyPermissions>

skuWithId(...)

skuWithId(options: { identifier: string; }) => Promise<GlassfySku>

For more details, check the documentation https://docs.glassfy.io/dashboard/configure-products

Returns: Promise<GlassfySku>

skuWithIdAndStore(...)

skuWithIdAndStore(options: { identifier: string; store: GLASSFY_STORE; }) => Promise<GlassfySkuBase>

Returns: Promise<GlassfySkuBase>

connectCustomSubscriber(...)

connectCustomSubscriber(options: { subscriberId: string; }) => Promise<void>

connectPaddleLicenseKey(...)

connectPaddleLicenseKey(options: { licenseKey: string; force: boolean; }) => Promise<void>

connectGlassfyUniversalCode(...)

connectGlassfyUniversalCode(options: { universalCode: string; force: boolean; }) => Promise<void>

setEmailUserProperty(...)

setEmailUserProperty(options: { email: string; }) => Promise<void>

setDeviceToken(...)

setDeviceToken(options: { token: string; }) => Promise<void>

setExtraUserProperty(...)

setExtraUserProperty(options: { extra: GlassfyExtraProperty; }) => Promise<void>

getUserProperty()

getUserProperty() => Promise<GlassfyUserProperties>

Returns: Promise<GlassfyUserProperties>

purchaseSku(...)

purchaseSku(options: { sku: GlassfySku; skuToUpgrade?: GlassfySku; replacementMode?: GLASSFY_REPLACEMENT_MODE; }) => Promise<GlassfyTransaction>

Returns: Promise<GlassfyTransaction>

restorePurchases()

restorePurchases() => Promise<GlassfyPermissions>

Returns: Promise<GlassfyPermissions>

storeInfo()

storeInfo() => Promise<GlassfyStoresInfo>

Returns: Promise<GlassfyStoresInfo>

setAttribution(...)

setAttribution(options: { type: GLASSFY_ATTRIBUTION; value: string; }) => Promise<void>

setAttributions(...)

setAttributions(options: { items: GlassfyAttributionItem[]; }) => Promise<void>

_paywall(...)

_paywall(options: { remoteConfig: string; awaitLoading: boolean; }) => Promise<void>

_closePaywall()

_closePaywall() => Promise<void>

_openUrl(...)

_openUrl(options: { url: string; }) => Promise<void>

Interfaces

GlassfyVersion

GlassfyOfferings

GlassfyOffering

GlassfySku

GlassfyProduct

GlassfyProductDiscount

GlassfyPurchasesHistory

GlassfyPurchaseHistory

GlassfyPermissions

GlassfyPermission

GlassfyAccountableSku

GlassfySkuBase

GlassfyUserProperties

GlassfyTransaction

GlassfyStoresInfo

GlassfyStoreInfo

GlassfyPaddleStoreInfo

GlassfyAttributionItem

Type Aliases

GlassfyExtraProperty

{ key: string: string }

Exclude

Exclude from T those types that are assignable to U

T extends U ? never : T

Enums

GLASSFY_LOGLEVEL

GLASSFY_ELEGIBILITY

GLASSFY_EVENT_TYPE

GLASSFY_STORE

GLASSFY_ENTITLEMENT

GLASSFY_REPLACEMENT_MODE

GLASSFY_ATTRIBUTION