Truncate Channel

Truncating a channel removes all messages but preserves the channel data and members. To delete both the channel and its messages, use Delete Channel instead.

Truncation can be performed client-side or server-side. Client-side truncation requires the TruncateChannel permission.

On server-side calls, use the user_id field to identify who performed the truncation.

By default, truncation hides messages. To permanently delete messages, set hard_delete to true.

Truncate a Channel

require 'getstream_ruby'

Models = GetStream::Generated::Models

client.chat.truncate_channel("messaging", "general", Models::TruncateChannelRequest.new)

# Or with parameters:
client.chat.truncate_channel("messaging", "general", Models::TruncateChannelRequest.new(
  skip_push: true,
  hard_delete: true,
  message: Models::MessageRequest.new(
    text: "Dear Everyone. The channel has been truncated.",
    user_id: user_id
  )
))

Truncate Options