host:tray
host:tray
Section titled “host:tray”| Field | Value |
|---|---|
| Prefix | host:tray |
| Namespace constant | TrayMenuNamespace |
| Subjects constant | TrayMenuSubjects |
| Kind | bus |
| Schema record | TrayMenuSchemas |
| Tier | framework |
| Package | @makaio/services-core |
| Defined in | packages/services/core/src/tray-menu/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
changed | host:tray.changed | event | schemas.ts |
group.register | host:tray.group.register | rpc | schemas.ts |
group.unregister | host:tray.group.unregister | rpc | schemas.ts |
item.clicked | host:tray.item.clicked | event | schemas.ts |
list | host:tray.list | rpc | schemas.ts |
register | host:tray.register | rpc | schemas.ts |
unregister | host:tray.unregister | rpc | schemas.ts |
Subject Details
Section titled “Subject Details”host:tray.changed (event)
Section titled “host:tray.changed (event)”Subject: host:tray.changed
Type: Event
Empty object.
host:tray.group.register (rpc)
Section titled “host:tray.group.register (rpc)”Subject: host:tray.group.register
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
group | { packageName: string; groupId: string; entries: { enabled: boolean; priority: number; label: string; entryId: string; metadata?: Record<string, unknown> | undefined; }[]; section: "tools" | "utilities" | "views"; priority: number; } | yes |
Response:
| Field | Type | Required |
|---|---|---|
groupId | string | yes |
host:tray.group.unregister (rpc)
Section titled “host:tray.group.unregister (rpc)”Subject: host:tray.group.unregister
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
groupId | string | yes |
packageName | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
removed | boolean | yes |
host:tray.item.clicked (event)
Section titled “host:tray.item.clicked (event)”Payload emitted when a tray entry is clicked.
Subject: host:tray.item.clicked
Type: Event
| Field | Type | Required |
|---|---|---|
entryId | string | yes |
groupId | string | undefined | no |
metadata | Record<string, unknown> | undefined | no |
packageName | string | yes |
host:tray.list (rpc)
Section titled “host:tray.list (rpc)”Subject: host:tray.list
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
entries | { packageName: string; entryId: string; label: string; section: "tools" | "utilities" | "views"; priority: number; enabled: boolean; metadata?: Record<string, unknown> | undefined; groupId?: string | undefined; }[] | yes |
host:tray.register (rpc)
Section titled “host:tray.register (rpc)”Subject: host:tray.register
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
entry | { packageName: string; entryId: string; label: string; section: "tools" | "utilities" | "views"; priority: number; enabled: boolean; metadata?: Record<string, unknown> | undefined; } | yes |
Response:
| Field | Type | Required |
|---|---|---|
entryId | string | yes |
host:tray.unregister (rpc)
Section titled “host:tray.unregister (rpc)”Subject: host:tray.unregister
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
entryId | string | yes |
packageName | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
removed | boolean | yes |
Auto-generated by yarn docs:bus. Do not edit manually.