aigens-sdk-octopus

Aigens SDK Octopus

Install

npm install aigens-sdk-octopus
npx cap sync

API

• init()
• hasStoragePermission()
• connect(...)
• disconnect()
• sendCommand(...)
• getConfig()
• deduct(...)
• addValue(...)
• cardEnquiry(...)
• settle()
• cancel()
• addListener('errorMessageEvent', ...)
• log(...)
• deleteLog(...)
• setSDKLogDirName(...)
• Interfaces

init()

init() => Promise<void>

hasStoragePermission()

hasStoragePermission() => Promise<{ ret: boolean; }>

Returns: Promise<{ ret: boolean; }>

connect(...)

connect(options?: { comm?: string | undefined; } | undefined) => Promise<KioskOctopusResult>

| Param | Type | | ------------- | ------------------------------- | | options | { comm?: string; } |

Returns: Promise<KioskOctopusResult>

disconnect()

disconnect() => Promise<void>

sendCommand(...)

sendCommand(options: { command: string; }) => Promise<KioskOctopusResult>

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

Returns: Promise<KioskOctopusResult>

getConfig()

getConfig() => Promise<KioskOctopusResult>

Returns: Promise<KioskOctopusResult>

deduct(...)

deduct(options: { amount: number; receiptNumber: string; loopStatus?: string[]; }) => Promise<KioskOctopusResult>

| Param | Type | Description | | ------------- | ------------------------------------------------------------------------------ | ---------------------------------------------------------- | | options | { amount: number; receiptNumber: string; loopStatus?: string[]; } | loopStatus: default ["processing"] ["processing", "faild"] |

Returns: Promise<KioskOctopusResult>

addValue(...)

addValue(options: { amount: number; receiptNumber: string; loopStatus?: string[]; }) => Promise<KioskOctopusResult>

| Param | Type | | ------------- | ------------------------------------------------------------------------------ | | options | { amount: number; receiptNumber: string; loopStatus?: string[]; } |

Returns: Promise<KioskOctopusResult>

cardEnquiry(...)

cardEnquiry(options: { receiptNumber: string; loopStatus?: string[]; }) => Promise<KioskOctopusResult>

| Param | Type | | ------------- | -------------------------------------------------------------- | | options | { receiptNumber: string; loopStatus?: string[]; } |

Returns: Promise<KioskOctopusResult>

settle()

settle() => Promise<KioskOctopusResult>

Returns: Promise<KioskOctopusResult>

cancel()

cancel() => Promise<void>

addListener('errorMessageEvent', ...)

addListener(eventName: 'errorMessageEvent', listenerFunc: (res: { messages: string[]; }) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ------------------------------------------------------ | | eventName | 'errorMessageEvent' | | listenerFunc | (res: { messages: string[]; }) => void |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

log(...)

log(options: { log: string; logDirName?: string; toTop?: boolean; }) => Promise<{ result: number; message?: string; }>

| Param | Type | | ------------- | ------------------------------------------------------------------- | | options | { log: string; logDirName?: string; toTop?: boolean; } |

Returns: Promise<{ result: number; message?: string; }>

deleteLog(...)

deleteLog(options?: { keepMonths?: number | undefined; logDirName?: string | undefined; } | undefined) => Promise<void>

| Param | Type | | ------------- | ---------------------------------------------------------- | | options | { keepMonths?: number; logDirName?: string; } |

setSDKLogDirName(...)

setSDKLogDirName(options?: { logDirName?: string | undefined; } | undefined) => Promise<void>

| Param | Type | | ------------- | ------------------------------------- | | options | { logDirName?: string; } |

Interfaces

KioskOctopusResult

| Prop | Type | Description | | ------------- | -------------------- | --------------------------------------------------------------------- | | ret | number | ret = 0 means success, ret = -1 means error , ret = -11 means cancel; | | message | string | | | result | boolean | |

PluginListenerHandle

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