local-notification
local-notification
Section titled “local-notification”| Field | Value |
|---|---|
| Prefix | local-notification |
| Namespace constant | LocalNotificationNamespace |
| Subjects constant | LocalNotificationSubjects |
| Kind | bus |
| Schema record | LocalNotificationSchemas |
| Tier | framework |
| Package | @makaio/services-core |
| Defined in | packages/services/core/src/local-notification/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
getProvider | local-notification.getProvider | rpc | schemas.ts |
notify | local-notification.notify | rpc | schemas.ts |
Subject Details
Section titled “Subject Details”local-notification.getProvider (rpc)
Section titled “local-notification.getProvider (rpc)”Get the current platform’s notification provider info.
Subject: local-notification.getProvider
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
provider | { id: string; displayName: string; available: boolean; } | null | yes |
local-notification.notify (rpc)
Section titled “local-notification.notify (rpc)”Show a local notification on the current platform.
Subject: local-notification.notify
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
body | string | yes |
icon | string | undefined | no |
title | string | yes |
url | string | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
success | boolean | yes |
Auto-generated by yarn docs:bus. Do not edit manually.