@aigens/aigens-sdk-core

Aigens Order.Place Core Plugin

Install

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

API

* echo(...)
* dismiss(...)
* finish(...)
* getMember(...)
* getDeeplink(...)
* openBrowser(...)
* isInstalledApp(...)
* getIsProductionEnvironment()
* openExternalUrl(...)
* checkNotificationPermissions()
* getFinishData(...)
* setTextZoom(...)
* readClipboard()
* addCalendar(...)
* makeHKFPSPayment(...)
* openSecondBrowser(...)
* setScreenName(...)
* logEvent(...)
* Interfaces
* Type Aliases

$3

`typescript
echo(options: any) => Promise
`

| Param | Type |
| ------------- | ---------------- |
| options | any |

Returns: Promise<any>

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

$3

`typescript
dismiss(options: any) => Promise
`

| Param | Type |
| ------------- | ---------------- |
| options | any |

Returns: Promise<any>

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

$3

`typescript
finish(options: any) => Promise
`

| Param | Type |
| ------------- | ---------------- |
| options | any |

Returns: Promise<any>

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

$3

`typescript
getMember(options: any) => Promise<{ member: Member; }>
`

| Param | Type |
| ------------- | ---------------- |
| options | any |

Returns: Promise<{ member: Member; }>

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

$3

`typescript
getDeeplink(options: any) => Promise<{ deeplink: Deeplink; }>
`

| Param | Type |
| ------------- | ---------------- |
| options | any |

Returns: Promise<{ deeplink: Deeplink; }>

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

$3

`typescript
openBrowser(options: BrowserOptions) => Promise
`

| Param | Type |
| ------------- | --------------------------------------------------------- |
| options | BrowserOptions |

Returns: Promise<any>

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

$3

`typescript
isInstalledApp(options: { key: string; }) => Promise<{ install: boolean; }>
`

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

Returns: Promise<{ install: boolean; }>

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

$3

`typescript
getIsProductionEnvironment() => Promise<{ isPrd: boolean; }>
`

Returns: Promise<{ isPrd: boolean; }>

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

$3

`typescript
openExternalUrl(options: { url: string; }) => Promise
`

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

Returns: Promise<any>

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

$3

`typescript
checkNotificationPermissions() => Promise
`

Returns: Promise<PermissionStatus>

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

$3

`typescript
getFinishData(options: any) => Promise<{ closedData: any; }>
`

| Param | Type |
| ------------- | ---------------- |
| options | any |

Returns: Promise<{ closedData: any; }>

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

$3

`typescript
setTextZoom(options: { value: number; }) => Promise
`

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

Returns: Promise<any>

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

$3

`typescript
readClipboard() => Promise
`

Promise<any>: { value: string, type: 'text/plain' }

Returns: Promise<any>

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

$3

`typescript
addCalendar(options: CalendarOptions) => Promise<{ notPermission?: boolean; resultCode?: number; }>
`

| Param | Type |
| ------------- | ----------------------------------------------------------- |
| options | CalendarOptions |

Returns: Promise<{ notPermission?: boolean; resultCode?: number; }>

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

$3

`typescript
makeHKFPSPayment(options: FPSPaymentOptions) => Promise
`

| Param | Type |
| ------------- | --------------------------------------------------------------- |
| options | FPSPaymentOptions |

Returns: Promise<FPSResultOptions>

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

$3

`typescript
openSecondBrowser(options: YuuOptions) => Promise
`

| Param | Type |
| ------------- | ------------------------------------------------- |
| options | YuuOptions |

Returns: Promise<YuuResultOptions>

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

$3

`typescript
setScreenName(options: { name: string; }) => Promise
`

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

Returns: Promise<any>

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

$3

`typescript
logEvent(options: { name: string; params?: any; }) => Promise
`

| Param | Type |
| ------------- | -------------------------------------------- |
| options | { name: string; params?: any; } |

Returns: Promise<any>

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

$3


#### Member

| Prop | Type |
| -------------------------- | -------------------- |
| "memberCode" | string |
| "source" | string |
| "sessionId" | string |
| "pushId" | string |
| "deviceId" | string |
| "universalLink" | string |
| "appleMerchantId" | string |
| "cachedOrderContext" | boolean |
| "name" | string |
| "email" | string |
| "phone" | string |


#### Deeplink

| Prop | Type |
| ----------------------- | ------------------- |
| "addItemId" | string |
| "addDiscountCode" | string |
| "addOfferId" | string |


#### BrowserOptions

| Prop | Type |
| ---------------------------- | --------------------------------------------- |
| url | string |
| member | Member |
| deeplink | Deeplink |
| externalProtocols | string[] |
| addPaddingProtocols | string[] |
| excludedUniversalLinks | string[] |


#### PermissionStatus

| Prop | Type |
| ------------- | ----------------------------------------------------------- |
| display | PermissionState |


#### CalendarOptions

| Prop | Type |
| --------------- | -------------------- |
| title | string |
| isAllDay | boolean |
| beginTime | number |
| endTime | number |
| location | string |
| notes | string |


#### FPSResultOptions

| Prop | Type |
| ------------ | -------------------- |
| result | boolean |
| url | string |
| intent | string |


#### FPSPaymentOptions

| Prop | Type |
| ----------------------- | ------------------- |
| paymentRequestUrl | string |
| callbackUrl | string |
| typeIdentifier | string |
| title | string |


#### YuuResultOptions

| Prop | Type |
| -------------- | -------------------- |
| cancel | boolean |
| yuuToken | string |
| cardNo | string |
| warning | string |
| status | string |


#### YuuOptions

| Prop | Type |
| ----------------- | ------------------- |
| url | string |
| serviceName` | string |

$3

#### PermissionState

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