Struct SlackPlugin 

pub struct SlackPlugin { /* private fields */ }

Slack plugin.

autumn_web::app()
    .plugin(
        SlackPlugin::new()
            .on_event("app_mention", on_mention)
            .command("/deploy", deploy),
    )
    .run()
    .await;

Implementations

impl SlackPlugin

pub fn new() -> Self

Makes the plugin. It reads [slack] at startup.

pub fn with_config(config: SlackConfig) -> Self

Makes the plugin with this config. It reads no files.

pub fn base_path(self, path: &str) -> Self

Sets the base path of the routes. Default: /slack.

autumn mounts routes before it loads config. So this is a builder setting, not a config key.

pub const fn readiness(self, on: bool) -> Self

Puts the health indicator in /ready too. Default: only in /actuator/health.

pub fn with_signing_secret(self, secret: impl Into<String>) -> Self

Uses this signing secret, not the env var.

pub fn with_previous_signing_secret(self, secret: impl Into<String>) -> Self

Also accepts this old signing secret. Use during rotation.

pub fn with_bot_token(self, token: impl Into<String>) -> Self

Uses this bot token, not the env var.

pub fn with_transport(self, transport: impl HttpTransport) -> Self

Uses this transport. Default: crate::transport::ReqwestTransport.

pub fn with_transport_arc(self, transport: Arc<dyn HttpTransport>) -> Self

Uses this shared transport.

pub fn with_clock(self, clock: Arc<dyn ClockSource>) -> Self

Uses this clock for the timestamp check. Default: the system clock.

pub fn with_replay_store(self, store: Arc<dyn WebhookReplayStore>) -> Self

Uses this store to drop event retries. Default: in memory, per process. Use a Redis store for many replicas.

pub fn on_event<F, Fut>(self, event_type: &str, handler: F) -> Self

where F: Fn(SlackContext, EventCallback) -> Fut + Send + Sync + 'static, Fut: Future<Output = HandlerResult<()>> + Send + 'static,

Runs handler for Events API events of event_type, after the ack.

pub fn command<F, Fut>(self, name: &str, handler: F) -> Self

where F: Fn(SlackContext, SlashCommand) -> Fut + Send + Sync + 'static, Fut: Future<Output = HandlerResult<CommandResponse>> + Send + 'static,

Runs handler for the slash command name, for example /deploy.

pub fn action<F, Fut>(self, action_id: &str, handler: F) -> Self

where F: Fn(SlackContext, BlockAction) -> Fut + Send + Sync + 'static, Fut: Future<Output = HandlerResult<Option<Message>>> + Send + 'static,

Runs handler for a block action with this action_id, after the ack. A returned message goes to the response_url.

pub fn view_submission<F, Fut>(self, callback_id: &str, handler: F) -> Self

where F: Fn(SlackContext, ViewPayload) -> Fut + Send + Sync + 'static, Fut: Future<Output = HandlerResult<ViewResponse>> + Send + 'static,

Runs handler for a modal submit with this callback_id.

pub fn view_closed<F, Fut>(self, callback_id: &str, handler: F) -> Self

where F: Fn(SlackContext, ViewPayload) -> Fut + Send + Sync + 'static, Fut: Future<Output = HandlerResult<()>> + Send + 'static,

Runs handler when a user closes a modal with this callback_id. The modal must set notify_on_close.

pub fn shortcut<F, Fut>(self, callback_id: &str, handler: F) -> Self

where F: Fn(SlackContext, Shortcut) -> Fut + Send + Sync + 'static, Fut: Future<Output = HandlerResult<()>> + Send + 'static,

Runs handler for a global or message shortcut with this callback_id, after the ack.

pub fn metrics(&self) -> Arc<SlackMetrics>

The metrics. They are shared with the started runtime.

pub fn start(self, state: &AppState) -> Result<SlackRuntime, SlackError>

Starts the plugin outside an app build. Use it in tests, with SlackRuntime::router. Plugin::build does the same at startup.

Errors

Returns a config error.

pub fn start_with_role( self, state: &AppState, role: impl Into<Role>, ) -> Result<SlackRuntime, SlackError>

Starts the plugin as if the process has role. A role that serves no HTTP (worker, or a preset without HTTP) needs no signing secret and no CSRF exemption. A ProcessRole converts into a Role.

Errors

Same as Self::start.

Trait Implementations

impl Debug for SlackPlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SlackPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for SlackPlugin

fn name(&self) -> Cow<'static, str>

Stable identifier used for duplicate-registration detection.

fn contract(&self) -> Option<PluginContract>

Declare which autumn-web versions this plugin supports, and any experimental surface it knowingly depends on.

fn build(self, app: AppBuilder) -> AppBuilder

Apply this plugin’s configuration to the builder.

fn route_group(&self) -> Cow<'static, str>

The route group of the routes this plugin adds (#3544).