ChannelClient.Plugs.FilterEvents (channel_client v0.2.0)

Copy Markdown

Halts the pipeline for messages whose event does not match the configured event list — a blocklist via :events, or an allowlist via :only.

Typical uses are keeping noisy server events away from your processes:

inbound_plugs: [{ChannelClient.Plugs.FilterEvents, events: ["phx_reply"]}]

or subscribing to just the events you care about:

inbound_plugs: [{ChannelClient.Plugs.FilterEvents, only: ["presence_diff"]}]

Give either :events or :only, never both.

Options

  • :events - list of event names to filter out (blocklist)
  • :only - list of event names to let through (allowlist)
  • :reason - halt reason, defaults to :filtered