Chat / Flutter
Chat Flutter v3
Chat Flutter
Chat
Flutter
Version 3
Home
/
Chat
/
Flutter
/
Channel

Hide or archive a group channel

You can hide or archive a specific group channel from the channel list UI using the code below.

try {
    await groupChannel.hideChannel(hidePreviousMessage: false, allowAutoUnhide: true);
} catch (e) {
    // Handle error.
}
// The channel is successfully hidden from the list.
// The current user's channel view should be refreshed to reflect the change.

try {
    await groupChannel.unhideChannel();
} catch (e) {
    // Handle error.
}
// The channel is successfully unhidden from the list.
// The current user's channel view should be refreshed to reflect the change.

List of parameters

Parameter nameTypeDescription

hidePreviousMessage

bool

Determines whether to show the messages sent and received before hiding or archiving the channel on the channel list. If set to true, previous messages aren't displayed in the channel. (Default: false)

allowAutoUnhide

bool

Determines the state and operating behavior of a channel. If set to true, the channel is hidden from the channel list, but when a new message arrives, the hidden channel will show up again on the channel list. If set to false, the channel is archived and stays hidden from the channel list unless the unhideChannel() method is called. (Default: true)

You can check the channel state on the channel list by using the hiddenState property of a GroupChannel object.

/// Represents channel's visibility state.
enum GroupChannelHiddenState {
unhidden,

@JsonValue('allow_auto_unhide')
allowAutoUnhide,

@JsonValue('prevent_auto_unhide')
preventAutoUnhide,
}

You can also filter channels by their state by following the code below.

 final query = GroupChannelListQuery();
      query.channelHiddenStateFilter = ChannelHiddenStateFilter.all;
      final results = await query.loadNext();