platform
platform
Section titled “platform”| Field | Value |
|---|---|
| Prefix | platform |
| Namespace constant | PlatformNamespace |
| Subjects constant | PlatformSubjects |
| Kind | bus |
| Schema record | PlatformSchemas |
| Tier | framework |
| Package | @makaio/contracts |
| Defined in | packages/contracts/src/platform/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
autoLaunch.disable | platform.autoLaunch.disable | rpc | schemas.ts |
autoLaunch.enable | platform.autoLaunch.enable | rpc | schemas.ts |
autoLaunch.getStatus | platform.autoLaunch.getStatus | rpc | schemas.ts |
Subject Details
Section titled “Subject Details”platform.autoLaunch.disable (rpc)
Section titled “platform.autoLaunch.disable (rpc)”Disable auto-launch at login.
Subject: platform.autoLaunch.disable
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
disabled | boolean | yes |
error | string | undefined | no |
platform.autoLaunch.enable (rpc)
Section titled “platform.autoLaunch.enable (rpc)”Enable auto-launch at login.
The platform provider registers the application as a login item (macOS), autostart entry (Linux), or Run key (Windows).
Subject: platform.autoLaunch.enable
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
hidden | boolean | yes |
Response:
| Field | Type | Required |
|---|---|---|
enabled | boolean | yes |
error | string | undefined | no |
platform.autoLaunch.getStatus (rpc)
Section titled “platform.autoLaunch.getStatus (rpc)”Query auto-launch status.
Subject: platform.autoLaunch.getStatus
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
enabled | boolean | yes |
error | string | undefined | no |
supported | boolean | yes |
Auto-generated by yarn docs:bus. Do not edit manually.