storage:extension:pin-message
storage:extension:pin-message
Section titled “storage:extension:pin-message”| Field | Value |
|---|---|
| Prefix | storage:extension:pin-message |
| Namespace constant | PinStorageNamespace |
| Subjects constant | PinStorageSubjects |
| Kind | extension-storage |
| Schema record | <inline> |
| Tier | extension |
| Package | @makaio/extension-pin-message |
| Defined in | extensions/pin-message/src/storage.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
add | storage:extension:pin-message.add | rpc | — |
check | storage:extension:pin-message.check | rpc | — |
clear | storage:extension:pin-message.clear | rpc | — |
list | storage:extension:pin-message.list | rpc | — |
remove | storage:extension:pin-message.remove | rpc | — |
Subject Details
Section titled “Subject Details”storage:extension:pin-message.add (rpc)
Section titled “storage:extension:pin-message.add (rpc)”Add a pin to a message.
Subject: storage:extension:pin-message.add Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
messageId | string | yes |
sessionId | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
success | boolean | yes |
storage:extension:pin-message.check (rpc)
Section titled “storage:extension:pin-message.check (rpc)”Check if a message is pinned.
Subject: storage:extension:pin-message.check Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
messageId | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
isPinned | boolean | yes |
storage:extension:pin-message.clear (rpc)
Section titled “storage:extension:pin-message.clear (rpc)”Clear all pins for a session.
Subject: storage:extension:pin-message.clear Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
sessionId | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
success | boolean | yes |
storage:extension:pin-message.list (rpc)
Section titled “storage:extension:pin-message.list (rpc)”List all pinned messages for a session.
Subject: storage:extension:pin-message.list Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
sessionId | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
pinnedMessageIds | string[] | yes |
storage:extension:pin-message.remove (rpc)
Section titled “storage:extension:pin-message.remove (rpc)”Remove a pin from a message.
Subject: storage:extension:pin-message.remove Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
messageId | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
success | boolean | yes |
Auto-generated by yarn docs:bus. Do not edit manually.