@aigens/aigens-sdk-core

@aigens/aigens-sdk-core

Aigens Order.Place Core Plugin

Install

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(...)
• Interfaces
• Type Aliases

echo(...)

echo(options: any) => Promise<any>

Param	Type
options	any

Returns: Promise<any>

---

dismiss(...)

dismiss(options: any) => Promise<any>

Param	Type
options	any

Returns: Promise<any>

---

finish(...)

finish(options: any) => Promise<any>

Param	Type
options	any

Returns: Promise<any>

---

getMember(...)

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

Param	Type
options	any

Returns: Promise<{ member: Member; }>

---

getDeeplink(...)

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

Param	Type
options	any

Returns: Promise<{ deeplink: Deeplink; }>

---

openBrowser(...)

openBrowser(options: BrowserOptions) => Promise<any>

Param	Type
options	BrowserOptions

Returns: Promise<any>

---

isInstalledApp(...)

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

Param	Type
options	{ key: string; }

Returns: Promise<{ install: boolean; }>

---

getIsProductionEnvironment()

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

Returns: Promise<{ isPrd: boolean; }>

---

openExternalUrl(...)

openExternalUrl(options: { url: string; }) => Promise<any>

Param	Type
options	{ url: string; }

Returns: Promise<any>

---

checkNotificationPermissions()

checkNotificationPermissions() => Promise<PermissionStatus>

Returns: Promise<PermissionStatus>

---

getFinishData(...)

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

Param	Type
options	any

Returns: Promise<{ closedData: any; }>

---

setTextZoom(...)

setTextZoom(options: { value: number; }) => Promise<any>

Param	Type
options	{ value: number; }

Returns: Promise<any>

---

readClipboard()

readClipboard() => Promise<any>

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

Returns: Promise<any>

---

addCalendar(...)

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

Param	Type
options	CalendarOptions

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

---

makeHKFPSPayment(...)

makeHKFPSPayment(options: FPSPaymentOptions) => Promise<FPSResultOptions>

Param	Type
options	FPSPaymentOptions

Returns: Promise<FPSResultOptions>

---

Interfaces

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

Type Aliases

PermissionState

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