You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**channel_url** | **str** | Specifies the URL of the channel to update. |
8
-
**name** | **str** | Specifies the name of the channel, or the channel topic. The length is limited to 191 characters. |
9
-
**cover_url** | **str** | Specifies the unique URL of the cover image. The length is limited to 2,048 characters. |
10
-
**cover_file** | **file_type** | Uploads the cover image file for the channel. |
11
-
**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](/docs/chat/v3/platform-api/guides/advanced-analytics) to segment metrics, which enables the sub-classification of data views. |
12
-
**data** | **str** | Specifies additional channel information such as a long description of the channel or `JSON` formatted string. |
13
-
**is_distinct** | **bool** | Determines whether to reuse an existing channel or create a new channel. If set to true, returns a channel with the current channel members users or creates a new channel if no match is found. Sendbird server can also use the custom channel type in the custom_type property if specified along with the users to return the corresponding channel. If set to false, Sendbird server always creates a new channel with a combination of the users as well as the channel custom type if specified. (Default: false)<br /><br /> Under this property, Sendbird server does not distinguish channels based on other properties such as channel URL or channel name. |
14
-
**is_public** | **bool** | Determines whether to allow a user to join the channel without an invitation. (Default: false) |
15
-
**access_code** | **str** | This property can be used only when the channel operator wants to set an access code for a public group channel. If specified, the is_access_code_required property of the channel resource is then set to true, and the channel begins to require the specified access code to a user who attempts to join. |
16
-
**operator_ids** | **[str]** | Specifies an array of one or more IDs of users to register as operators of the channel. If the operators are not members of the channel yet, they need an [invitation](#2-invite-as-members) to [join](#2-join-a-channel) a privte group channel while they don't need any to join a [public](#-3-private-vs-public) group channel. The maximum allowed number of operators per channel is 100. |
8
+
**name** | **str** | Specifies the name of the channel, or the channel topic. The length is limited to 191 characters. | [optional]
9
+
**cover_url** | **str** | Specifies the unique URL of the cover image. The length is limited to 2,048 characters. | [optional]
10
+
**cover_file** | **file_type** | Uploads the cover image file for the channel. | [optional]
11
+
**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](/docs/chat/v3/platform-api/guides/advanced-analytics) to segment metrics, which enables the sub-classification of data views. | [optional]
12
+
**data** | **str** | Specifies additional channel information such as a long description of the channel or `JSON` formatted string. | [optional]
13
+
**is_distinct** | **bool** | Determines whether to reuse an existing channel or create a new channel. If set to true, returns a channel with the current channel members users or creates a new channel if no match is found. Sendbird server can also use the custom channel type in the custom_type property if specified along with the users to return the corresponding channel. If set to false, Sendbird server always creates a new channel with a combination of the users as well as the channel custom type if specified. (Default: false)<br /><br /> Under this property, Sendbird server does not distinguish channels based on other properties such as channel URL or channel name. | [optional]
14
+
**is_public** | **bool** | Determines whether to allow a user to join the channel without an invitation. (Default: false) | [optional]
15
+
**access_code** | **str** | This property can be used only when the channel operator wants to set an access code for a public group channel. If specified, the is_access_code_required property of the channel resource is then set to true, and the channel begins to require the specified access code to a user who attempts to join. | [optional]
16
+
**operator_ids** | **[str]** | Specifies an array of one or more IDs of users to register as operators of the channel. If the operators are not members of the channel yet, they need an [invitation](#2-invite-as-members) to [join](#2-join-a-channel) a privte group channel while they don't need any to join a [public](#-3-private-vs-public) group channel. The maximum allowed number of operators per channel is 100. | [optional]
17
17
**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]
18
18
19
19
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**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]
12
12
13
13
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**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]
Copy file name to clipboardExpand all lines: docs/SendBirdBaseChannel.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,6 @@ Name | Type | Description | Notes
10
10
**custom_type** | **str** | | [optional]
11
11
**data** | **str** | | [optional]
12
12
**is_ephemeral** | **bool** | | [optional]
13
-
**is_frozen** | **bool** | | [optional]
14
13
**name** | **str** | | [optional]
15
14
**url** | **str** | | [optional]
16
15
**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]
0 commit comments