Skip to content

Latest commit

 

History

History
16 lines (8 loc) · 2.04 KB

File metadata and controls

16 lines (8 loc) · 2.04 KB

HideAChannelRequest

Properties

Name Type Description Notes
allowAutoUnhide Boolean Determines the state and operating behavior of the channel in a channel list. If set to true, the channel is hidden from a user's channel list but it will reappear when there is a new message. If set to false, the channel is hidden from a user's channel list and it will remain hidden unless the value of the property changes to true through unarchiving. (Default: true)<br /><br /> When a user who has hidden the channel sends a message in that channel through the Platform API, the `allow_auto_unhide` property is changed to true, making the channel reappear in the channel list. [optional]
hidePreviousMessages Boolean When the channel gets appeared back in either the list of the user in the user_id property or the lists of all channel members (should_hide_all = true), determines whether to conceal the messages sent and received before hiding or archiving the channel. (Default: false)<br /><br /> This property is effective only when the value of the global application settings resource's display_past_message property is false. [optional]
shouldHideAll Boolean Determines whether to make the specified channel disappear from the channel list of all channel members. When this is set to true, the user_id property isn't effective and doesn't need to be specified in the request. (Default: false) [optional]
userId String Specifies the unique ID of the user whose channel will be hidden or archived from the list. This property is required when should_hide_all is set to false, which is the default value. However, when should_hide_all is set to true, this property isn't effective.