bookclerk_plugin_abi::methods
Role capability method names (camelCase on the wire).
Each submodule exposes a single NAME constant equal to
the corresponding ContentSource / RemoteLibrary / Oidc /
MetadataProvider / CoverFetcher / MetadataFiles / Notifier /
NotificationRaiser / AiModels / AiRunner / Cli /
EventConsumer / EventPublisher / QueueConsumer / QueueProducer /
PluginWorker method in
schema/plugin.capnp. Prefer these constants over string literals when
dispatching or documenting capabilities.
METHOD_NAMES enumerates every known method for discovery / schema
drift tests. Flat UPPER_SNAKE aliases live under names.
shutdown: Graceful guest teardown before the host closes the transport.health: Connectivity / configuration probe.diagnose: Human-readable diagnostic lines forbookclerk plugins diagnose.start: Start background watchers (Cap'n ProtoRemoteLibrary.start).stop: Stop background watchers started bystart(Cap'n ProtoRemoteLibrary.stop).event: Deliver one ordered batch of domain events (Cap'n ProtoEventConsumer.event).publish: Append one guest event to the host outbox (Cap'n ProtoEventPublisher.publish).read: Read one page of past outbox events (Cap'n ProtoEventPublisher.read).queue: Deliver one ordered batch of queue messages (Cap'n ProtoQueueConsumer.queue).scheduled: Run one cron fire (Cap'n ProtoScheduledHandler.scheduled).send: Send one message into a granted queue (Cap'n ProtoQueueProducer.send), or deliver one notification to one destination (Cap'n ProtoNotifier.send).send_batch: Send a batch of messages into a granted queue (Cap'n ProtoQueueProducer.sendBatch).poll_events: Poll for plugin-observed external users afterstart.scan_library: Trigger an integration library scan against a remote server (e.g. ABS).sync_listening: Pull listening-progress snapshots; host upserts tagged with the plugin id.authenticate_user: Validate a username/password against a remote IdP (Cap'n ProtoOidc.authenticateUser) and return an external user.lookup: Edition records for a set of identifiers (Cap'n ProtoMetadataProvider.lookup).search: Edition records matching a title and author (Cap'n ProtoMetadataProvider.search).chapters: Chapter layout of one edition (Cap'n ProtoMetadataProvider.chapters).fetch_covers: Cover image bodies streamed into a host sink (Cap'n ProtoCoverFetcher.fetchCovers).parse: What one metadata file says (Cap'n ProtoMetadataFiles.parse).render: A metadata file's bytes with chosen fields rewritten (Cap'n ProtoMetadataFiles.render).validate_destination: Normalise and check a patron's address on a notifier (Cap'n ProtoNotifier.validateDestination).raise: Raise a notification type the plugin declared (Cap'n ProtoNotificationRaiser.raise).models: List the models a plugin serves (Cap'n ProtoAiModels.models).run: Run one model on one input (Cap'n ProtoAiModels.runon a model plugin,AiRunner.runon theAIbinding).clients: Plugin-provided OIDC client templates (Cap'n ProtoOidc.clients).describe: Return the guest's declared CLI schema (crate::CliSchema; Cap'n ProtoPluginCli.describe). Also the rootPluginWorker.describeidentity call.invoke: Invoke a declared plugin CLI command (Cap'n ProtoPluginCli.invoke).login: Password-style source login; host seals returned credentials.login_start: Begin interactive OAuth (returns browser URL + session id).login_complete: Finish interactive OAuth after the operator completes the browser flow.scan: Scan a source storefront library; host upserts returnedcrate::ScanBookrows.fetch_title: Download/decrypt one title into the host cache directory.search_catalog: Search a storefront catalog for purchase / discovery UIs.expand_candidates: Expand related catalog candidates from a seed title.purchase_hint: Resolve a purchase URL / price hint for a catalog product.purchase_hints: Resolve purchase URLs / price hints for several catalog products at once.quality_offers: Report the audio quality one account would download for several titles.list_deals: List current storefront deals / promotions.list_accounts: List source accounts known to the guest (host usually prefers DB rows).catalog_detail: Fetch rich catalog detail for one product id.revoke_account: Undo store-side state for one account before the host deletes its stored credentials (for example, deregister the login device).put: Put a small object (cover/sidecar) into an output destination.get: Read a small object from an output destination.exists: Test whether an object key exists in an output destination.list: List object keys under a prefix in an output destination.copy: Copy an object within an output destination.delete: Delete an object key from an output destination.names: FlatUPPER_SNAKEaliases matching historicalprotocol::methodsusage.
pub const METHOD_NAMES: &[&str] = _;
All known capability method names for discovery, docs, and schema checks.
Order is stable for readability; scripts/gen-plugin-abi.py --check
verifies this list against schema/plugin.capnp.
Generated from crates/bookclerk-plugin-abi at main · View as Markdown