Skip to content

Variable: LocalNotificationSchemas

Makaio Framework


Makaio Framework / services-core/local-notification/schemas / LocalNotificationSchemas

const LocalNotificationSchemas: object

Defined in: ../../../packages/services/core/src/local-notification/schemas.ts:107

Local notification domain schemas.

Local notifications are platform-native notifications (Electron, iOS, Android, Web). Unlike push notifications, only one provider is active per platform.

getProvider: object

Get the current platform’s notification provider info.

request: ZodObject<{ }, $strip>

response: ZodObject<{ provider: ZodNullable<ZodObject<{ available: ZodBoolean; displayName: ZodString; id: ZodString; }, $strip>>; }, $strip>

notify: object

Show a local notification on the current platform.

request: ZodObject<{ body: ZodString; icon: ZodOptional<ZodString>; title: ZodString; url: ZodOptional<ZodString>; }, $strip> = LocalNotificationSchema

response: ZodDiscriminatedUnion<[ZodObject<{ success: ZodLiteral<true>; }, $strict>, ZodObject<{ error: ZodString; success: ZodLiteral<false>; }, $strict>], "success"> = NotifyResponseSchema