overwolf.profile.subscriptions.inapp API
Provides functions and events to help with user profile subscription in-app management.
info
Please check the subscriptions API sample app that demonstrates a primary usage in the API.
Please read all the info about app subscriptions here.
- Permissions required: Subscription
Methods Reference
Events Reference
- overwolf.profile.subscriptions.inapp.onInAppSubModalOpened
- overwolf.profile.subscriptions.inapp.onInAppSubModalClosed
Types Reference
- overwolf.profile.subscriptions.inapp.InAppSubModalOpenedEvent Object
- overwolf.profile.subscriptions.inapp.InAppSubModalClosedEvent Object
- overwolf.profile.subscriptions.inapp.enums.Theme Enum
show(planId, theme)
Version added: 0.170
Permissions required: Subscription
Shows the in-app subscription page as a modal window on top of the current window.
| Parameter | Type | Description |
|---|---|---|
| planId | number | The plan Id to display |
| theme | Theme enum | Optional. "Dark" or "Light. If not defined, the default is light |
hide(callback)
Version added: 0.170
Permissions required: Subscription
Hide the current active in-app subscription modal window.
| Parameter | Type | Description |
|---|---|---|
| callback | Result => void | Returns with the result |
onInAppSubModalOpened
Version added: 0.170
Fired when a subscription in-app modal window is opened: with the following structure: InAppSubModalOpenedEvent Object
InAppSubModalOpenedEvent Object
| Parameter | Type | Description |
|---|---|---|
| status | string |
onInAppSubModalClosed
Version added: 0.170
Fired when a subscription in-app modal window is closed: with the following structure: InAppSubModalClosedEvent Object
InAppSubModalClosedEvent Object
| Parameter | Type | Description |
|---|---|---|
| status | string |
Theme enum
Version added: 0.174
| Options | Description |
|---|---|
| Light | Light |
| Dark | Dark |