ahp-event-bird

private features of Adhd Hyper Planner App

Install

npm install ahp-event-bird
npx cap sync

API

• saveCredentials(...)
• startProgressActivity(...)
• completeProgressActivity(...)
• getFCMToken()
• clearFCMToken()
• signInWithGoogle()
• signInWithApple()
• pauseProgressActivity()
• resumeProgressActivity(...)
• syncWidgetData(...)
• resetPatchAlertShownToday()
• addListener('appUpdateRequired', ...)
• removeAllListeners()
• Interfaces

saveCredentials(...)

saveCredentials(options: Credentials) => Promise<IsSuccess>

| Param | Type | | ------------- | --------------------------------------------------- | | options | Credentials |

Returns: Promise<IsSuccess>

startProgressActivity(...)

startProgressActivity(data: ProgressActivity) => Promise<void>

| Param | Type | | ---------- | ------------------------------------------------------------- | | data | ProgressActivity |

completeProgressActivity(...)

completeProgressActivity(data: ProgressActivity) => Promise<void>

| Param | Type | | ---------- | ------------------------------------------------------------- | | data | ProgressActivity |

getFCMToken()

getFCMToken() => Promise<{ fcmToken: string; deviceId: string; }>

Returns: Promise<{ fcmToken: string; deviceId: string; }>

clearFCMToken()

clearFCMToken() => Promise<void>

signInWithGoogle()

signInWithGoogle() => Promise<GoogleSignInResult>

Returns: Promise<GoogleSignInResult>

signInWithApple()

signInWithApple() => Promise<AppleSignInResult>

Returns: Promise<AppleSignInResult>

pauseProgressActivity()

pauseProgressActivity() => Promise<void>

resumeProgressActivity(...)

resumeProgressActivity(data: { startedAt: string; }) => Promise<void>

| Param | Type | | ---------- | ----------------------------------- | | data | { startedAt: string; } |

syncWidgetData(...)

syncWidgetData(_: WidgetSyncData) => Promise<void>

| Param | Type | | ------- | --------------------------------------------------------- | | _ | WidgetSyncData |

resetPatchAlertShownToday()

resetPatchAlertShownToday() => Promise<void>

addListener('appUpdateRequired', ...)

addListener(eventName: 'appUpdateRequired', listenerFunc: (event: AppUpdateEvent) => void) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ----------------------------------------------------------------------------- | | eventName | 'appUpdateRequired' | | listenerFunc | (event: AppUpdateEvent) => void |

Returns: Promise<PluginListenerHandle>

removeAllListeners()

removeAllListeners() => Promise<void>

Interfaces

IsSuccess

| Prop | Type | | --------------- | -------------------- | | isSuccess | boolean |

Credentials

| Prop | Type | | -------------- | ------------------- | | username | string | | password | string |

ProgressActivity

| Prop | Type | | ---------------- | ------------------- | | progressId | string | | taskName | string | | startedAt | string |

GoogleSignInResult

| Prop | Type | | ----------------- | ------------------- | | idToken | string | | email | string | | displayName | string |

AppleSignInResult

| Prop | Type | | ----------------- | ------------------- | | idToken | string | | email | string | | displayName | string |

WidgetSyncData

| Prop | Type | | -------------------- | ------------------- | | tasks | string | | totalCount | number | | completedCount | number | | focusTaskName | string | | focusStartedAt | string |

PluginListenerHandle

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

AppUpdateEvent

| Prop | Type | Description | | --------------------- | ---------------------------------- | ------------------------------------------------------------------------------------- | | kind | 'blocking' | 'patch' | 'blocking' = minor/major behind (full red overlay); 'patch' = non-blocking soft alert | | currentVersion | string | | | appStoreVersion | string | | | appStoreUrl | string | App Store deep link, e.g. itms-apps://apps.apple.com/app/id6759459572 | | releaseNotes | string | |