@aigens/aigens-sdk-appboy

Aigens Order.Place Core Plugin

Install

``bash
npm install @aigens/aigens-sdk-appboy
npx cap sync
`

API

* checkPermissions()
* requestPermissions()
* registerForRemoteNotifications()
* setRegisteredPushToken(...)
* changeUser(...)
* logCustomEvent(...)
* logPurchase(...)
* disableSdk()
* enableSdk()
* wipeData()
* requestImmediateDataFlush()
* setAppboyMember(...)
* setFirstName(...)
* setLastName(...)
* setEmail(...)
* setGender(...)
* setDateOfBirth(...)
* setCountry(...)
* setHomeCity(...)
* setPhoneNumber(...)
* setPushNotificationSubscriptionType(...)
* setEmailNotificationSubscriptionType(...)
* setUserAttributionData(...)
* setBoolCustomUserAttribute(...)
* setStringCustomUserAttribute(...)
* setDoubleCustomUserAttribute(...)
* setDateCustomUserAttribute(...)
* setIntCustomUserAttribute(...)
* setCustomUserAttributeArray(...)
* unsetCustomUserAttribute(...)
* incrementCustomUserAttribute(...)
* addToCustomAttributeArray(...)
* removeFromCustomAttributeArray(...)
* addAlias(...)
* setLanguage(...)
* addToSubscriptionGroup(...)
* removeFromSubscriptionGroup(...)
* getDeviceId()
* addListener('afterInAppMessageViewClosed', ...)
* addListener('afterInAppMessageViewOpened', ...)
* addListener('beforeInAppMessageViewClosed', ...)
* addListener('beforeInAppMessageViewOpened', ...)
* addListener('onInAppMessageButtonClicked', ...)
* addListener('onInAppMessageClicked', ...)
* addListener('onInAppMessageDismissed', ...)
* Interfaces
* Type Aliases

$3

`typescript
checkPermissions() => Promise
`

Returns: Promise<PermissionStatus>

--------------------

$3

`typescript
requestPermissions() => Promise
`

Returns: Promise<PermissionStatus>

--------------------

$3

`typescript
registerForRemoteNotifications() => Promise
`

Returns: Promise<any>

--------------------

$3

`typescript
setRegisteredPushToken(options: { token: string; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------- |
| options | { token: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
changeUser(options: { userId: string; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------- |
| options | { userId: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
logCustomEvent(options: { eventName: string; properties?: object; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------------------- |
| options | { eventName: string; properties?: object; } |

Returns: Promise<any>

--------------------

$3

`typescript
logPurchase(options: { productId: string; price: string; quantity: number; currency: string; properties?: object; }) => Promise
`

| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------- |
| options | { productId: string; price: string; quantity: number; currency: string; properties?: object; } |

Returns: Promise<any>

--------------------

$3

`typescript
disableSdk() => Promise
`

Returns: Promise<any>

--------------------

$3

`typescript
enableSdk() => Promise
`

Returns: Promise<any>

--------------------

$3

`typescript
wipeData() => Promise
`

Returns: Promise<any>

--------------------

$3

`typescript
requestImmediateDataFlush() => Promise
`

Returns: Promise<any>

--------------------

$3

`typescript
setAppboyMember(options: AppboyMember) => Promise
`

| Param | Type |
| ------------- | ----------------------------------------------------- |
| options | AppboyMember |

Returns: Promise<any>

--------------------

$3

`typescript
setFirstName(options: { firstName: string; }) => Promise
`

| Param | Type |
| ------------- | ----------------------------------- |
| options | { firstName: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
setLastName(options: { lastName: string; }) => Promise
`

| Param | Type |
| ------------- | ---------------------------------- |
| options | { lastName: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
setEmail(options: { email: string; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------- |
| options | { email: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
setGender(options: { gender: 'f' | 'm' | 'o' | 'u'; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------------- |
| options | { gender: 'f' \| 'm' \| 'o' \| 'u'; } |

Returns: Promise<any>

--------------------

$3

`typescript
setDateOfBirth(options: { year: number; month: number; day: number; }) => Promise
`

| Param | Type |
| ------------- | ---------------------------------------------------------- |
| options | { year: number; month: number; day: number; } |

Returns: Promise<any>

--------------------

$3

`typescript
setCountry(options: { country: string; }) => Promise
`

| Param | Type |
| ------------- | --------------------------------- |
| options | { country: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
setHomeCity(options: { homeCity: string; }) => Promise
`

| Param | Type |
| ------------- | ---------------------------------- |
| options | { homeCity: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
setPhoneNumber(options: { phoneNumber: string; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------------- |
| options | { phoneNumber: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
setPushNotificationSubscriptionType(options: { subscriptionState: 'optedIn' | 'subscribed' | 'unsubscribed'; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------------------------------------------- |
| options | { subscriptionState: 'optedIn' \| 'subscribed' \| 'unsubscribed'; } |

Returns: Promise<any>

--------------------

$3

`typescript
setEmailNotificationSubscriptionType(options: { subscriptionState: 'optedIn' | 'subscribed' | 'unsubscribed'; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------------------------------------------- |
| options | { subscriptionState: 'optedIn' \| 'subscribed' \| 'unsubscribed'; } |

Returns: Promise<any>

--------------------

$3

`typescript
setUserAttributionData(options: { network: string; campaign: string; adGroup: string; creative: string; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------------------------------------------------- |
| options | { network: string; campaign: string; adGroup: string; creative: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
setBoolCustomUserAttribute(options: { key: string; value: boolean; }) => Promise
`

| Param | Type |
| ------------- | --------------------------------------------- |
| options | { key: string; value: boolean; } |

Returns: Promise<any>

--------------------

$3

`typescript
setStringCustomUserAttribute(options: { key: string; value: string; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------- |
| options | { key: string; value: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
setDoubleCustomUserAttribute(options: { key: string; value: number; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------- |
| options | { key: string; value: number; } |

Returns: Promise<any>

--------------------

$3

`typescript
setDateCustomUserAttribute(options: { key: string; value: number; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------- |
| options | { key: string; value: number; } |

Returns: Promise<any>

--------------------

$3

`typescript
setIntCustomUserAttribute(options: { key: string; value: number; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------- |
| options | { key: string; value: number; } |

Returns: Promise<any>

--------------------

$3

`typescript
setCustomUserAttributeArray(options: { key: string; value: string[]; }) => Promise
`

| Param | Type |
| ------------- | ---------------------------------------------- |
| options | { key: string; value: string[]; } |

Returns: Promise<any>

--------------------

$3

`typescript
unsetCustomUserAttribute(options: { key: string; }) => Promise
`

| Param | Type |
| ------------- | ----------------------------- |
| options | { key: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
incrementCustomUserAttribute(options: { key: string; value: number; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------- |
| options | { key: string; value: number; } |

Returns: Promise<any>

--------------------

$3

`typescript
addToCustomAttributeArray(options: { key: string; value: string; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------- |
| options | { key: string; value: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
removeFromCustomAttributeArray(options: { key: string; value: string; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------- |
| options | { key: string; value: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
addAlias(options: { aliasName: string; aliasLabel: string; }) => Promise
`

| Param | Type |
| ------------- | ------------------------------------------------------- |
| options | { aliasName: string; aliasLabel: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
setLanguage(options: { language: string; }) => Promise
`

| Param | Type |
| ------------- | ---------------------------------- |
| options | { language: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
addToSubscriptionGroup(options: { groupId: string; }) => Promise
`

| Param | Type |
| ------------- | --------------------------------- |
| options | { groupId: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
removeFromSubscriptionGroup(options: { groupId: string; }) => Promise
`

| Param | Type |
| ------------- | --------------------------------- |
| options | { groupId: string; } |

Returns: Promise<any>

--------------------

$3

`typescript
getDeviceId() => Promise
`

Returns: Promise<any>

--------------------

$3

`typescript
addListener(eventName: 'afterInAppMessageViewClosed', listenerFunc: (res: any) => void) => Promise & PluginListenerHandle
`

| Param | Type |
| ------------------ | ------------------------------------------ |
| eventName | 'afterInAppMessageViewClosed' |
| listenerFunc | (res: any) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

--------------------

$3

`typescript
addListener(eventName: 'afterInAppMessageViewOpened', listenerFunc: (res: any) => void) => Promise & PluginListenerHandle
`

| Param | Type |
| ------------------ | ------------------------------------------ |
| eventName | 'afterInAppMessageViewOpened' |
| listenerFunc | (res: any) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

--------------------

$3

`typescript
addListener(eventName: 'beforeInAppMessageViewClosed', listenerFunc: (res: any) => void) => Promise & PluginListenerHandle
`

| Param | Type |
| ------------------ | ------------------------------------------- |
| eventName | 'beforeInAppMessageViewClosed' |
| listenerFunc | (res: any) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

--------------------

$3

`typescript
addListener(eventName: 'beforeInAppMessageViewOpened', listenerFunc: (res: any) => void) => Promise & PluginListenerHandle
`

| Param | Type |
| ------------------ | ------------------------------------------- |
| eventName | 'beforeInAppMessageViewOpened' |
| listenerFunc | (res: any) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

--------------------

$3

`typescript
addListener(eventName: 'onInAppMessageButtonClicked', listenerFunc: (res: any) => void) => Promise & PluginListenerHandle
`

| Param | Type |
| ------------------ | ------------------------------------------ |
| eventName | 'onInAppMessageButtonClicked' |
| listenerFunc | (res: any) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

--------------------

$3

`typescript
addListener(eventName: 'onInAppMessageClicked', listenerFunc: (res: any) => void) => Promise & PluginListenerHandle
`

| Param | Type |
| ------------------ | ------------------------------------ |
| eventName | 'onInAppMessageClicked' |
| listenerFunc | (res: any) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

--------------------

$3

`typescript
addListener(eventName: 'onInAppMessageDismissed', listenerFunc: (res: any) => void) => Promise & PluginListenerHandle
`

| Param | Type |
| ------------------ | -------------------------------------- |
| eventName | 'onInAppMessageDismissed' |
| listenerFunc | (res: any) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

--------------------

$3


#### PermissionStatus

| Prop | Type | Description | Since |
| ------------- | ----------------------------------------------------------- | -------------------------------------------- | ----- |
| receive | PermissionState | Permission state of receiving notifications. | 1.0.0 |


#### AppboyMember

| Prop | Type |
| ----------------- | ---------------------------------------------------------- |
| firstName | string |
| lastName | string |
| email | string |
| gender | 'f' \| 'm' \| 'o' \| 'u' |
| dateOfBirth | { year: number; month: number; day: number; } |
| country | string |
| homeCity | string |
| phoneNumber | string |


#### PluginListenerHandle

| Prop | Type |
| ------------ | ----------------------------------------- |
| remove` | () => Promise<void> |

$3

#### PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'