ExStreamClient.Operations.Chat.Channeltypes (ExStreamClient v0.1.3)
View SourceModules for interacting with the chat/channeltypes
group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
Summary
Functions
Creates new channel type
Deletes channel type
Gets channel type
Lists all available channel types
Updates channel type
Functions
@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:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec delete_channel_type(String.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes channel type
Required Arguments:
name
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec get_channel_type(String.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.GetChannelTypeResponse.t()} | {:error, any()}
Gets channel type
Required Arguments:
name
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec list_channel_types([{:client, module()}]) :: {:ok, ExStreamClient.Model.ListChannelTypesResponse.t()} | {:error, any()}
Lists all available channel types
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec update_channel_type( String.t(), ExStreamClient.Model.UpdateChannelTypeRequest.t(), [ {:client, module()} ] ) :: {:ok, ExStreamClient.Model.UpdateChannelTypeResponse.t()} | {:error, any()}
Updates channel type
Required Arguments:
name
payload
:Elixir.ExStreamClient.Model.UpdateChannelTypeRequest
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)