ExStreamClient.Operations.Chat.Channeltypes (ExStreamClient v0.1.3)

View Source

Modules for interacting with the chat/channeltypes group of Stream APIs

API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2

Summary

Functions

create_channel_type(payload, opts \\ [])

@spec create_channel_type(ExStreamClient.Model.CreateChannelTypeRequest.t(), [
  {:client, module()}
]) ::
  {:ok, ExStreamClient.Model.CreateChannelTypeResponse.t()} | {:error, any()}

Creates new channel type

Required Arguments:

Optional Arguments:

delete_channel_type(name, opts \\ [])

@spec delete_channel_type(String.t(), [{:client, module()}]) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}

Deletes channel type

Required Arguments:

  • name

Optional Arguments:

get_channel_type(name, opts \\ [])

@spec get_channel_type(String.t(), [{:client, module()}]) ::
  {:ok, ExStreamClient.Model.GetChannelTypeResponse.t()} | {:error, any()}

Gets channel type

Required Arguments:

  • name

Optional Arguments:

list_channel_types(opts \\ [])

@spec list_channel_types([{:client, module()}]) ::
  {:ok, ExStreamClient.Model.ListChannelTypesResponse.t()} | {:error, any()}

Lists all available channel types

Optional Arguments:

update_channel_type(name, payload, opts \\ [])

@spec update_channel_type(
  String.t(),
  ExStreamClient.Model.UpdateChannelTypeRequest.t(),
  [
    {:client, module()}
  ]
) :: {:ok, ExStreamClient.Model.UpdateChannelTypeResponse.t()} | {:error, any()}

Updates channel type

Required Arguments:

Optional Arguments: