| name |
str |
Specifies the channel topic, or the name of the channel. The length is limited to 191 characters. (Default: open channel) |
[optional] |
| channel_url |
str |
Specifies the URL of the channel. Only numbers, characters, and underscores are allowed. The length is 4 to 100 characters, inclusive. If not specified, a URL is automatically generated. |
[optional] |
| cover_url |
str |
Specifies the URL of the cover image. The length is limited to 2,048 characters. |
[optional] |
| cover_file |
file_type |
Uploads a file for the channel cover image. |
[optional] |
| custom_type |
str |
Specifies the custom channel type which is used for channel grouping. The length is limited to 128 characters.<br /><br /> Custom types are also used within Sendbird's Advanced analytics to segment metrics, which enables the sub-classification of data views. |
[optional] |
| data |
str |
Specifies additional channel information such as a long description of the channel or `JSON` formatted string. |
[optional] |
| is_ephemeral |
bool |
Determines whether to preserve the messages in the channel for the purpose of retrieving chat history or not. It set to true, the messages in the channel are not saved in the Sendbird database and the chat history can't be retrieved. (Default: false) |
[optional] |
| is_dynamic_partitioned_2_how_dynamic_partitioning_works |
bool |
Determines whether the channel is an open channel with dynamic partitioning or not. If the value of this property is true, the open channel can create several subchannels in order to accommodate a massive number of usres. (Default: false)<br/><br/> For the new Sendbird applications created after December 15, 2020, this property will be automatically set to true. |
[optional] |
| operator_ids |
[str] |
Specifies an array of one or more user IDs to register as operators of the channel. The maximum allowed number of operators per channel is 100. Operators can delete any messages in the channel, and can also receive all messages that have been throttled.<br/><br/> Operators cannot view messages that have been moderated by the domain filter or profanity filter. Only the sender will be notified that the message has been blocked. |
[optional] |
| operators |
[str] |
(Deprecated) Specifies the string IDs of the users registered as channel operators. Operators can delete any messages in the channel, and can also receive all messages that have been throttled. |
[optional] |
| any string name |
bool, date, datetime, dict, float, int, list, str, none_type |
any string name can be used but the value must be the correct type |
[optional] |