Overview

Almost all API requests are specific to a channel (e.g. add a message to channel “livestream:rockets”) and as we saw already, channels are organized in groups called channel types. All applications start with five default channel types, each have different name and are preconfigured to best fit one use-case.

Channel types can be configured with specific permissions and features.

The five default channel types come with good default permission policies. You can find more information on how to manage permissions in theChannel Types section.

There are five built-in channel types:

• Livestream: Sensible defaults in case you want to build chat like YouTube or Twitch.
• Messaging: Configured for apps such as WhatsApp or Facebook Messenger.
• Team: If you want to build your own version of Slack or something similar, start here.
• Commerce: Good defaults for building something like your own version of Intercom or Drift.
• Gaming: Defaults for adding chat to video games.

As you can see in the examples below, you can define your own Channel types and configure them to fit your needs. The Channel type allows you to configure these features:

• typing_events : Controls if typing indicators are shown.
• read_events : Controls whether the chat shows how far you’ve read.
• connect_events : Determines if events are fired for connecting and disconnecting to a chat.
• search : Controls if messages should be searchable.
• reactions : If users are allowed to add reactions to messages.
• replies : Enables message threads and replies.
• mutes : Determines if users are able to mute other users.
• push_notifications : If messages are allowed to generate push notifications.
• uploads : Allows image and file uploads within messages.
• url_enrichment : When enabled, messages containing URLs will be enriched automatically with image and text related to the message. This is disabled by default for the livestream channel type and we do not recommend enabling it for performance reasons.
• skip_last_msg_update_for_system_msgs : Allows to not update the last_message_at timestamp of a channel in the case of system messages.

Channel Types Fields

Creating a Channel Type

import { DenyAll, AnyRole } from 'stream-chat';

await client.createChannelType({
	name: 'public',
	mutes: false,
	reactions: false,
});

client.create_channel_type(
  {
    "name": "public",
    "mutes": False,
    "reactions": False,
  }
)

client.create_channel_type({
  'name' => 'public',
  'mutes' => false,
  'reactions' => false
})

$channelConf = [
  'name' => 'public',
  'mutes' => false,
  'reactions' => false
];

$type = $client->createChannelType($channelConf);

ChannelType.create().name(channelName).mutes(false).reactions(false).request();

await channelTypeClient.CreateChannelTypeAsync(new ChannelTypeWithStringCommandsRequest
{
  Name = "public",
  Reactions = false,
  Mutes = false
});

newChannelType := &ChannelType{
		// Copy the default settings.
		ChannelConfig: DefaultChannelConfig,
}

newChannelType.Name = "public"
newChannelType.Mutes = false
newChannelType.Reactions = false

client.CreateChannelType(newChannelType)

Please note that applications have a hard limit of 50 channel types. If you need more than this please have a look at the Multi-tenant & Teams section.

List Channel Types

You can retrieve the list of all channel types defined for your application.

const channelTypes = await client.listChannelTypes();

$types = $client->listChannelTypes();

client.list_channel_types()

client.ListChannelTypes()

client.list_channel_types()

ChannelType.list().request();

await channelTypeClient.ListChannelTypesAsync();

Get a Channel Type

You can retrieve a channel type definition with this endpoint.

const channelType = await client.getChannelType('public');

$type = $client->getChannelType('public');

client.get_channel_type("public")

client.GetChannelType("public")

client.get_channel_type('public')

ChannelType.get("public").request();

await _channelTypeClient.GetChannelTypeAsync("public");

Edit a Channel Type

Channel type features, commands and permissions can be changed. Only the fields that must change need to be provided, fields that are not provided to this API will remain unchanged.

const update = await client.updateChannelType('public', {
  replies: false,
  commands: ["all"]
});

$update = $client->updateChannelType('public', [
  'replies' => false,
  'commands' => ['all']
]);

client.update_channel_type(
  "public",
  replies=False,
  commands=["all"],
)

client.UpdateChannelType("public", map[string]interface{}{
	"replies": false,
	"commands": []string{"all"},
})

client.update_channel_type(
  "public",
  replies: false,
  commands: ["all"],
)

ChannelType.update("public")
  .replies(false)
  .commands(List.of("all"))
  .request();

await channelTypeClient.UpdateChannelTypeAsync("public", new ChannelTypeWithStringCommandsRequest
{
  Replies = false,
  Commands = new List<string> { "all" }
});

Features of a channel can be updated by passing the boolean flags:

const update = await client.updateChannelType("public", {
  typing_events: false,
  read_events: true,
  connect_events: true,
  search: false,
  reactions: true,
  replies: false,
  mutes: true
});

$update = $client->updateChannelType('public', [
  'typing_events' => false,
  'read_events' => true,
  'connect_events' => true,
  'search' => false,
  'reactions' => true,
  'replies' => false,
  'mutes' => true,
  'replies' => false
]);

client.update_channel_type("public", 
  typing_events=False,
  read_events=True,
  connect_events=True,
  search=False,
  reactions=True,
  replies=False,
  mutes=True
)

client.UpdateChannelType("public", map[string]interface{}{
	"typing_events": false,
	"read_events":  true,
	"connect_events": true,
	"search":     false,
	"reactions":   true,
	"replies":    false,
	"mutes":     true,
})

client.update_channel_type("public", 
  typing_events: false,
  read_events: true,
  connect_events: true,
  search: false,
  reactions: true,
  replies: false,
  mutes: true
)

ChannelType.update(channelName)
    .typingEvents(false)
    .readEvents(true)
    .connectEvents(true)
    .search(false)
    .reactions(true)
    .replies(false)
    .mutes(true)
    .request();

await _channelTypeClient.UpdateChannelTypeAsync("public", new ChannelTypeWithStringCommandsRequest
{
  TypingEvents = false,
  ReadEvents = true,
  ConnectEvents = true,
  Search = false,
  Reactions = true,
  Replies = false,
  Mutes = true,
});

Settings can also be updated by passing in the desired new values:

const update = await client.updateChannelType("public", {
  automod: "disabled",
  max_message_length: 140,
  commands: ["giphy", "ban"]
});

$update = $client->updateChannelType('public', [
  'automod' => 'disabled',
  'max_message_length' => 140,
  'commands' => [ 'giphy', 'ban']
]);

client.update_channel_type(
  "public",
  automod="disabled",
  max_message_length=140,
  commands=["ban", "unban"],
)

client.UpdateChannelType(
	"public",
	map[string]interface{}{
		"automod":      "disabled",
		"max_message_length": 140,
		"commands":      []interface{}{"ban", "unban"},
	},
)

client.update_channel_type(
  "public",
  automod: "disabled",
  max_message_length: 140,
  commands: ["ban", "unban"]
)

ChannelType.update(channelName)
    .automod(AutoMod.DISABLED)
    .maxMessageLength(140)
    .commands(List.of("ban", "unban"))
    .request();

await channelTypeClient.UpdateChannelTypeAsync(_channelType.Name, new ChannelTypeWithStringCommandsRequest
{
  Automod = Automod.Disabled,
  MaxMessageLength = 140,
  Commands = new List<string> { "ban", "unban" },
});

Remove a Channel Type

const destroy = await client.deleteChannelType('public');

$client->deleteChannelType('public');

client.delete_channel_type("public")

client.DeleteChannelType("public")

client.delete_channel_type('public')

ChannelType.delete("public").request();

await channelTypeClient.DeleteChannelTypeAsync("public");