Files
kumomta/docs/reference/events/get_queue_config.md
T
Wez Furlong 42bf5c5e61 docs: adjust reference to improve search terms
We've been hoping that mkdocs-material will ship the much anticipated
search enhancements for some time, but it's time to recognize that
we need to do something to improve the search results with how
things work right now.

This is a big commit that changes the titles of the various pages
from the code-annotated synopsis to just the name of the function.

This makes it much easier now to match things like `kumo.reject`
directly, but `reject` remains awkward to find.

I think this is the best that we can do at this time.

A few functions have been annotated with the `status: deprecated` to
show as deprecated in the toc/nav (shows with a little trash can next
to the name).
2025-05-16 14:02:19 -07:00

35 lines
1.0 KiB
Markdown

# get_queue_config
```lua
kumo.on(
'get_queue_config',
function(domain, tenant, campaign, routing_domain) end
)
```
The parameters correspond to the `domain`, `tenant`, `campaign` and `routing_domain`
fields from the *scheduled queue* name, as discussed in [Queues](../queues.md).
```lua
kumo.on(
'get_queue_config',
function(domain_name, tenant, campaign, routing_domain)
return kumo.make_queue_config {
max_retry_interval = '20 minutes',
}
end
)
```
See also [kumo.make_queue_config](../kumo/make_queue_config/index.md).
{{since('2023.11.28-b5252a41', indent=True)}}
It is now possible to use `kumo.on` to register multiple handlers for
this event. The handlers will be called in the order that they were
registered. If a handler returns `nil` then the next handler will be
called. Conversely, if a handler returns a queue configuration object,
no further handlers will be called.
This behavior is intended to make it easier to compose multiple helpers
or lua modules together.