Slackblocks.Objects.ConversationFilter (slackblocks v2.8.0)

View Source

Limits which conversations a conversation menu offers.

Slack reference: https://docs.slack.dev/reference/block-kit/composition-objects/conversation-filter-object

Fields

  • include — Adds conversation types to offer: im, mpim, private, or public. Optional; nil omits the field.
  • exclude_external_shared_channels — Sets whether externally shared channels are excluded. Optional; nil omits the field.
  • exclude_bot_users — Sets whether bot users are excluded. Optional; nil omits the field.

Summary

Types

t()

Functions

change(value, options)

Atomically replaces supplied fields; omitted fields retain their values.

change!(value, options)

Replaces fields or raises Slackblocks.ValidationError.

new(options)

Constructs and validates a value. Text conveniences apply to keyword input.

new!(options)

Constructs a value or raises Slackblocks.ValidationError.

Types

t()

@type t() :: %Slackblocks.Objects.ConversationFilter{
  exclude_bot_users: boolean() | nil,
  exclude_external_shared_channels: boolean() | nil,
  include: [binary()] | nil
}

Functions

change(value, options)

@spec change(
  t(),
  keyword()
) :: {:ok, t()} | {:error, Slackblocks.ValidationError.t()}

Atomically replaces supplied fields; omitted fields retain their values.

change!(value, options)

@spec change!(
  t(),
  keyword()
) :: t()

Replaces fields or raises Slackblocks.ValidationError.

new(options)

@spec new(keyword()) :: {:ok, t()} | {:error, Slackblocks.ValidationError.t()}

Constructs and validates a value. Text conveniences apply to keyword input.

new!(options)

@spec new!(keyword()) :: t()

Constructs a value or raises Slackblocks.ValidationError.