# bookclerk_plugin_abi::methods

Role capability method names (camelCase on the wire).

Each submodule exposes a single [`NAME`](/docs/internals/crates/bookclerk_plugin_abi/methods/health/index.md#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`](#method_names) enumerates every known method for discovery / schema
drift tests. Flat `UPPER_SNAKE` aliases live under [`names`](/docs/internals/crates/bookclerk_plugin_abi/methods/names/index.md).

## Modules

- [`shutdown`](/docs/internals/crates/bookclerk_plugin_abi/methods/shutdown/index.md): Graceful guest teardown before the host closes the transport.
- [`health`](/docs/internals/crates/bookclerk_plugin_abi/methods/health/index.md): Connectivity / configuration probe.
- [`diagnose`](/docs/internals/crates/bookclerk_plugin_abi/methods/diagnose/index.md): Human-readable diagnostic lines for `bookclerk plugins diagnose`.
- [`start`](/docs/internals/crates/bookclerk_plugin_abi/methods/start/index.md): Start background watchers (Cap'n Proto `RemoteLibrary.start`).
- [`stop`](/docs/internals/crates/bookclerk_plugin_abi/methods/stop/index.md): Stop background watchers started by `start` (Cap'n Proto `RemoteLibrary.stop`).
- [`event`](/docs/internals/crates/bookclerk_plugin_abi/methods/event/index.md): Deliver one ordered batch of domain events (Cap'n Proto `EventConsumer.event`).
- [`publish`](/docs/internals/crates/bookclerk_plugin_abi/methods/publish/index.md): Append one guest event to the host outbox (Cap'n Proto `EventPublisher.publish`).
- [`read`](/docs/internals/crates/bookclerk_plugin_abi/methods/read/index.md): Read one page of past outbox events (Cap'n Proto `EventPublisher.read`).
- [`queue`](/docs/internals/crates/bookclerk_plugin_abi/methods/queue/index.md): Deliver one ordered batch of queue messages (Cap'n Proto `QueueConsumer.queue`).
- [`scheduled`](/docs/internals/crates/bookclerk_plugin_abi/methods/scheduled/index.md): Run one cron fire (Cap'n Proto `ScheduledHandler.scheduled`).
- [`send`](/docs/internals/crates/bookclerk_plugin_abi/methods/send/index.md): Send one message into a granted queue (Cap'n Proto `QueueProducer.send`), or deliver one notification to one destination (Cap'n Proto `Notifier.send`).
- [`send_batch`](/docs/internals/crates/bookclerk_plugin_abi/methods/send_batch/index.md): Send a batch of messages into a granted queue (Cap'n Proto `QueueProducer.sendBatch`).
- [`poll_events`](/docs/internals/crates/bookclerk_plugin_abi/methods/poll_events/index.md): Poll for plugin-observed external users after `start`.
- [`scan_library`](/docs/internals/crates/bookclerk_plugin_abi/methods/scan_library/index.md): Trigger an integration library scan against a remote server (e.g. ABS).
- [`sync_listening`](/docs/internals/crates/bookclerk_plugin_abi/methods/sync_listening/index.md): Pull listening-progress snapshots; host upserts tagged with the plugin id.
- [`authenticate_user`](/docs/internals/crates/bookclerk_plugin_abi/methods/authenticate_user/index.md): Validate a username/password against a remote IdP (Cap'n Proto `Oidc.authenticateUser`) and return an external user.
- [`lookup`](/docs/internals/crates/bookclerk_plugin_abi/methods/lookup/index.md): Edition records for a set of identifiers (Cap'n Proto `MetadataProvider.lookup`).
- [`search`](/docs/internals/crates/bookclerk_plugin_abi/methods/search/index.md): Edition records matching a title and author (Cap'n Proto `MetadataProvider.search`).
- [`chapters`](/docs/internals/crates/bookclerk_plugin_abi/methods/chapters/index.md): Chapter layout of one edition (Cap'n Proto `MetadataProvider.chapters`).
- [`fetch_covers`](/docs/internals/crates/bookclerk_plugin_abi/methods/fetch_covers/index.md): Cover image bodies streamed into a host sink (Cap'n Proto `CoverFetcher.fetchCovers`).
- [`parse`](/docs/internals/crates/bookclerk_plugin_abi/methods/parse/index.md): What one metadata file says (Cap'n Proto `MetadataFiles.parse`).
- [`render`](/docs/internals/crates/bookclerk_plugin_abi/methods/render/index.md): A metadata file's bytes with chosen fields rewritten (Cap'n Proto `MetadataFiles.render`).
- [`validate_destination`](/docs/internals/crates/bookclerk_plugin_abi/methods/validate_destination/index.md): Normalise and check a patron's address on a notifier (Cap'n Proto `Notifier.validateDestination`).
- [`raise`](/docs/internals/crates/bookclerk_plugin_abi/methods/raise/index.md): Raise a notification type the plugin declared (Cap'n Proto `NotificationRaiser.raise`).
- [`models`](/docs/internals/crates/bookclerk_plugin_abi/methods/models/index.md): List the models a plugin serves (Cap'n Proto `AiModels.models`).
- [`run`](/docs/internals/crates/bookclerk_plugin_abi/methods/run/index.md): Run one model on one input (Cap'n Proto `AiModels.run` on a model plugin, `AiRunner.run` on the `AI` binding).
- [`clients`](/docs/internals/crates/bookclerk_plugin_abi/methods/clients/index.md): Plugin-provided OIDC client templates (Cap'n Proto `Oidc.clients`).
- [`describe`](/docs/internals/crates/bookclerk_plugin_abi/methods/describe/index.md): Return the guest's declared CLI schema (`crate::CliSchema`; Cap'n Proto `PluginCli.describe`). Also the root `PluginWorker.describe` identity call.
- [`invoke`](/docs/internals/crates/bookclerk_plugin_abi/methods/invoke/index.md): Invoke a declared plugin CLI command (Cap'n Proto `PluginCli.invoke`).
- [`login`](/docs/internals/crates/bookclerk_plugin_abi/methods/login/index.md): Password-style source login; host seals returned credentials.
- [`login_start`](/docs/internals/crates/bookclerk_plugin_abi/methods/login_start/index.md): Begin interactive OAuth (returns browser URL + session id).
- [`login_complete`](/docs/internals/crates/bookclerk_plugin_abi/methods/login_complete/index.md): Finish interactive OAuth after the operator completes the browser flow.
- [`scan`](/docs/internals/crates/bookclerk_plugin_abi/methods/scan/index.md): Scan a source storefront library; host upserts returned `crate::ScanBook` rows.
- [`fetch_title`](/docs/internals/crates/bookclerk_plugin_abi/methods/fetch_title/index.md): Download/decrypt one title into the host cache directory.
- [`search_catalog`](/docs/internals/crates/bookclerk_plugin_abi/methods/search_catalog/index.md): Search a storefront catalog for purchase / discovery UIs.
- [`expand_candidates`](/docs/internals/crates/bookclerk_plugin_abi/methods/expand_candidates/index.md): Expand related catalog candidates from a seed title.
- [`purchase_hint`](/docs/internals/crates/bookclerk_plugin_abi/methods/purchase_hint/index.md): Resolve a purchase URL / price hint for a catalog product.
- [`purchase_hints`](/docs/internals/crates/bookclerk_plugin_abi/methods/purchase_hints/index.md): Resolve purchase URLs / price hints for several catalog products at once.
- [`quality_offers`](/docs/internals/crates/bookclerk_plugin_abi/methods/quality_offers/index.md): Report the audio quality one account would download for several titles.
- [`list_deals`](/docs/internals/crates/bookclerk_plugin_abi/methods/list_deals/index.md): List current storefront deals / promotions.
- [`list_accounts`](/docs/internals/crates/bookclerk_plugin_abi/methods/list_accounts/index.md): List source accounts known to the guest (host usually prefers DB rows).
- [`catalog_detail`](/docs/internals/crates/bookclerk_plugin_abi/methods/catalog_detail/index.md): Fetch rich catalog detail for one product id.
- [`revoke_account`](/docs/internals/crates/bookclerk_plugin_abi/methods/revoke_account/index.md): Undo store-side state for one account before the host deletes its stored credentials (for example, deregister the login device).
- [`put`](/docs/internals/crates/bookclerk_plugin_abi/methods/put/index.md): Put a small object (cover/sidecar) into an output destination.
- [`get`](/docs/internals/crates/bookclerk_plugin_abi/methods/get/index.md): Read a small object from an output destination.
- [`exists`](/docs/internals/crates/bookclerk_plugin_abi/methods/exists/index.md): Test whether an object key exists in an output destination.
- [`list`](/docs/internals/crates/bookclerk_plugin_abi/methods/list/index.md): List object keys under a prefix in an output destination.
- [`copy`](/docs/internals/crates/bookclerk_plugin_abi/methods/copy/index.md): Copy an object within an output destination.
- [`delete`](/docs/internals/crates/bookclerk_plugin_abi/methods/delete/index.md): Delete an object key from an output destination.
- [`names`](/docs/internals/crates/bookclerk_plugin_abi/methods/names/index.md): Flat `UPPER_SNAKE` aliases matching historical `protocol::methods` usage.

## Constants

### METHOD_NAMES

```rust
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`.
