Aigens Order.Place Core Plugin
npm install @aigens/aigens-sdk-coreAigens Order.Place Core Plugin
``bash`
npm install @aigens/aigens-sdk-core
npx cap sync
* echo(...)
* dismiss(...)
* finish(...)
* getMember(...)
* getDeeplink(...)
* openBrowser(...)
* isInstalledApp(...)
* getIsProductionEnvironment()
* openExternalUrl(...)
* checkNotificationPermissions()
* getFinishData(...)
* setTextZoom(...)
* readClipboard()
* addCalendar(...)
* makeHKFPSPayment(...)
* openSecondBrowser(...)
* setScreenName(...)
* logEvent(...)
* Interfaces
* Type Aliases
`typescript`
echo(options: any) => Promise
| Param | Type |
| ------------- | ---------------- |
| options | any |
Returns: Promise<any>
--------------------
`typescript`
dismiss(options: any) => Promise
| Param | Type |
| ------------- | ---------------- |
| options | any |
Returns: Promise<any>
--------------------
`typescript`
finish(options: any) => Promise
| Param | Type |
| ------------- | ---------------- |
| options | any |
Returns: Promise<any>
--------------------
`typescript`
getMember(options: any) => Promise<{ member: Member; }>
| Param | Type |
| ------------- | ---------------- |
| options | any |
Returns: Promise<{ member: Member; }>
--------------------
`typescript`
getDeeplink(options: any) => Promise<{ deeplink: Deeplink; }>
| Param | Type |
| ------------- | ---------------- |
| options | any |
Returns: Promise<{ deeplink: Deeplink; }>
--------------------
`typescript`
openBrowser(options: BrowserOptions) => Promise
| Param | Type |
| ------------- | --------------------------------------------------------- |
| options | BrowserOptions |
Returns: Promise<any>
--------------------
`typescript`
isInstalledApp(options: { key: string; }) => Promise<{ install: boolean; }>
| Param | Type |
| ------------- | ----------------------------- |
| options | { key: string; } |
Returns: Promise<{ install: boolean; }>
--------------------
`typescript`
getIsProductionEnvironment() => Promise<{ isPrd: boolean; }>
Returns: Promise<{ isPrd: boolean; }>
--------------------
`typescript`
openExternalUrl(options: { url: string; }) => Promise
| Param | Type |
| ------------- | ----------------------------- |
| options | { url: string; } |
Returns: Promise<any>
--------------------
`typescript`
checkNotificationPermissions() => Promise
Returns: Promise<PermissionStatus>
--------------------
`typescript`
getFinishData(options: any) => Promise<{ closedData: any; }>
| Param | Type |
| ------------- | ---------------- |
| options | any |
Returns: Promise<{ closedData: any; }>
--------------------
`typescript`
setTextZoom(options: { value: number; }) => Promise
| Param | Type |
| ------------- | ------------------------------- |
| options | { value: number; } |
Returns: Promise<any>
--------------------
`typescript`
readClipboard() => Promise
Promise<any>: { value: string, type: 'text/plain' }
Returns: Promise<any>
--------------------
`typescript`
addCalendar(options: CalendarOptions) => Promise<{ notPermission?: boolean; resultCode?: number; }>
| Param | Type |
| ------------- | ----------------------------------------------------------- |
| options | CalendarOptions |
Returns: Promise<{ notPermission?: boolean; resultCode?: number; }>
--------------------
`typescript`
makeHKFPSPayment(options: FPSPaymentOptions) => Promise
| Param | Type |
| ------------- | --------------------------------------------------------------- |
| options | FPSPaymentOptions |
Returns: Promise<FPSResultOptions>
--------------------
`typescript`
openSecondBrowser(options: YuuOptions) => Promise
| Param | Type |
| ------------- | ------------------------------------------------- |
| options | YuuOptions |
Returns: Promise<YuuResultOptions>
--------------------
`typescript`
setScreenName(options: { name: string; }) => Promise
| Param | Type |
| ------------- | ------------------------------ |
| options | { name: string; } |
Returns: Promise<any>
--------------------
`typescript`
logEvent(options: { name: string; params?: any; }) => Promise
| Param | Type |
| ------------- | -------------------------------------------- |
| options | { name: string; params?: any; } |
Returns: Promise<any>
--------------------
#### 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 |
#### PermissionState
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'