ExStreamClient.Operations.Chat.Moderation (ExStreamClient v0.1.7)

View Source

Modules for interacting with the chat/moderation group of Stream APIs

API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2

Shared options

All functions in this module accept the following optional parameters:

  • api_key - API key to use. If not provided, the default key from config will be used
  • api_key_secret - API key secret to use. If not provided, the default secret from config will be used
  • endpoint - endpoint to use. If not provided, the default endpoint from config will be used
  • client - HTTP client to use. Must implement ExStreamClient.Http.Behavior. Defaults to ExStreamClient.Http
  • req_opts - all of these options will be forwarded to req. See Req.new/1 for available options

Summary

Types

shared_opts()

Functions

mute_channel(payload, opts \\ [])

Mutes channel for user

query_message_flags(opts \\ [])

Find and filter message flags

unmute_channel(payload, opts \\ [])

Unmutes channel for user

Types

shared_opts()

@type shared_opts() :: [
  api_key: String.t(),
  api_key_secret: String.t(),
  client: module(),
  endpoint: String.t(),
  req_opts: keyword()
]

Functions

mute_channel(payload, opts \\ [])

@spec mute_channel(ExStreamClient.Model.MuteChannelRequest.t(), shared_opts()) ::
  {:ok, ExStreamClient.Model.MuteChannelResponse.t()} | {:error, any()}

Mutes channel for user

Sends events:

  • channel.muted
  • channel.muted

Required Arguments:

Optional Arguments:

query_message_flags(opts \\ [])

@spec query_message_flags([
  {:payload, ExStreamClient.Model.QueryMessageFlagsPayload.t()} | shared_opts()
]) ::
  {:ok, ExStreamClient.Model.QueryMessageFlagsResponse.t()} | {:error, any()}

Find and filter message flags

Optional Arguments:

unmute_channel(payload, opts \\ [])

@spec unmute_channel(ExStreamClient.Model.UnmuteChannelRequest.t(), shared_opts()) ::
  {:ok, ExStreamClient.Model.UnmuteResponse.t()} | {:error, any()}

Unmutes channel for user

Sends events:

  • channel.unmuted
  • channel.unmuted

Required Arguments:

Optional Arguments: