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

View Source

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

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

Summary

Functions

Mutes channel for user

Find and filter message flags

Unmutes channel for user

Functions

mute_channel(payload, opts \\ [])

@spec mute_channel(ExStreamClient.Model.MuteChannelRequest.t(), [{:client, module()}]) ::
  {: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(
  client: module(),
  payload: ExStreamClient.Model.QueryMessageFlagsPayload.t()
) ::
  {: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(), [
  {:client, module()}
]) ::
  {:ok, ExStreamClient.Model.UnmuteResponse.t()} | {:error, any()}

Unmutes channel for user

Sends events:

  • channel.unmuted
  • channel.unmuted

Required Arguments:

Optional Arguments: