Interface: ILocalNotificationProvider
Makaio Framework / services-core/local-notification / ILocalNotificationProvider
Interface: ILocalNotificationProvider
Section titled “Interface: ILocalNotificationProvider”Defined in: ../../../packages/services/core/src/local-notification/types.ts:10
Local notification provider interface.
Each platform (Electron, iOS, Android, Web) implements this interface to show native notifications.
Extends
Section titled “Extends”Properties
Section titled “Properties”displayName
Section titled “displayName”
readonlydisplayName:string
Defined in: ../../../packages/contracts/src/capability/types.ts:11
Human-readable name for display in UI
Inherited from
Section titled “Inherited from”ICapabilityProvider.displayName
readonlyid:string
Defined in: ../../../packages/contracts/src/capability/types.ts:9
Unique identifier for this provider instance
Inherited from
Section titled “Inherited from”providerKey?
Section titled “providerKey?”
readonlyoptionalproviderKey?:string
Defined in: ../../../packages/contracts/src/capability/types.ts:17
Stable provider identity used for joins across registries.
Unlike id, this should remain stable across runtime re-registration.
Inherited from
Section titled “Inherited from”ICapabilityProvider.providerKey
Methods
Section titled “Methods”isAvailable()
Section titled “isAvailable()”isAvailable():
boolean
Defined in: ../../../packages/services/core/src/local-notification/types.ts:22
Check if the provider is available and has permission.
Returns
Section titled “Returns”boolean
Whether notifications can be shown
notify()
Section titled “notify()”notify(
notification):Promise<NotifyResponse>
Defined in: ../../../packages/services/core/src/local-notification/types.ts:16
Show a notification using the platform’s native API.
Parameters
Section titled “Parameters”notification
Section titled “notification”The notification payload
Returns
Section titled “Returns”Promise<NotifyResponse>
Result indicating success or failure
validate()?
Section titled “validate()?”
optionalvalidate():Promise<{error?:string;valid:boolean; }>
Defined in: ../../../packages/contracts/src/capability/types.ts:22
Optional validation method to check provider configuration/credentials.
Returns
Section titled “Returns”Promise<{ error?: string; valid: boolean; }>
Validation result with optional error message