ExStreamClient.Operations.Chat.Channels (ExStreamClient v0.1.6)
View SourceModules for interacting with the chat/channels
group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
Shared options
All functions in this module accept the following optional parameters:
api_key
- API key to use. If not provided, the default key from config will be usedapi_key_secret
- API key secret to use. If not provided, the default secret from config will be usedendpoint
- endpoint to use. If not provided, the default endpoint from config will be usedclient
- HTTP client to use. Must implementExStreamClient.Http.Behavior
. Defaults toExStreamClient.Http
req_opts
- all of these options will be forwarded to req. SeeReq.new/1
for available options
Summary
Functions
Deletes channel
Allows to delete several channels at once asynchronously
Deletes a draft
Deletes previously uploaded file
Deletes previously uploaded image
Get a draft
Returns list messages found by IDs
This Method creates a channel or returns an existing one with matching attributes
This Method creates a channel or returns an existing one with matching attributes
Marks channel as hidden for current user
Marks channels as read up to the specific message. If no channels is given, mark all channel as read
Marks channel as read up to the specific message
Marks channel as unread from a specific message
Query channels with filter query
Sends event to the channel
Sends new message to the specified channel
Shows previously hidden channel
Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.
Change channel data
Updates certain fields of the channel
Uploads file
Uploads image
Functions
@spec delete_channel(String.t(), String.t(), req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t(), hard_delete: boolean() ) :: {:ok, ExStreamClient.Model.DeleteChannelResponse.t()} | {:error, any()}
Deletes channel
Sends events:
channel.deleted
channel.deleted
Required Arguments:
type
id
Optional Arguments:
hard_delete
All options from Shared Options are supported.
Allows to delete several channels at once asynchronously
Sends events:
channel.deleted
channel.deleted
Required Arguments:
All options from Shared Options are supported.
@spec delete_draft(String.t(), String.t(), req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t(), user_id: String.t(), parent_id: String.t() ) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes a draft
Sends events:
draft.deleted
Required Arguments:
type
id
Optional Arguments:
parent_id
user_id
All options from Shared Options are supported.
@spec delete_file(String.t(), String.t(), req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t(), url: String.t() ) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes previously uploaded file
Required Arguments:
type
id
Optional Arguments:
url
All options from Shared Options are supported.
@spec delete_image(String.t(), String.t(), req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t(), url: String.t() ) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes previously uploaded image
Required Arguments:
type
id
Optional Arguments:
url
All options from Shared Options are supported.
@spec get_draft(String.t(), String.t(), req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t(), user_id: String.t(), parent_id: String.t() ) :: {:ok, ExStreamClient.Model.GetDraftResponse.t()} | {:error, any()}
Get a draft
Required Arguments:
type
id
Optional Arguments:
parent_id
user_id
All options from Shared Options are supported.
Returns list messages found by IDs
Required Arguments:
type
id
ids
All options from Shared Options are supported.
This Method creates a channel or returns an existing one with matching attributes
Sends events:
channel.created
member.added
member.removed
member.updated
user.watching.start
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.ChannelGetOrCreateRequest
All options from Shared Options are supported.
This Method creates a channel or returns an existing one with matching attributes
Sends events:
channel.created
member.added
member.removed
member.updated
user.watching.start
Required Arguments:
All options from Shared Options are supported.
Marks channel as hidden for current user
Sends events:
channel.hidden
channel.hidden
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.HideChannelRequest
All options from Shared Options are supported.
Marks channels as read up to the specific message. If no channels is given, mark all channel as read
Sends events:
message.read
message.read
Required Arguments:
All options from Shared Options are supported.
Marks channel as read up to the specific message
Sends events:
message.read
message.read
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.MarkReadRequest
All options from Shared Options are supported.
Marks channel as unread from a specific message
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.MarkUnreadRequest
All options from Shared Options are supported.
Query channels with filter query
Required Arguments:
All options from Shared Options are supported.
Sends event to the channel
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.SendEventRequest
All options from Shared Options are supported.
Sends new message to the specified channel
Sends events:
message.new
message.updated
message.new
message.updated
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.SendMessageRequest
All options from Shared Options are supported.
Shows previously hidden channel
Sends events:
channel.visible
channel.visible
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.ShowChannelRequest
All options from Shared Options are supported.
Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.
Sends events:
channel.truncated
channel.truncated
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.TruncateChannelRequest
All options from Shared Options are supported.
Change channel data
Sends events:
channel.updated
member.added
member.removed
member.updated
message.new
channel.updated
member.added
member.removed
member.updated
message.new
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.UpdateChannelRequest
All options from Shared Options are supported.
Updates certain fields of the channel
Sends events:
channel.updated
channel.updated
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.UpdateChannelPartialRequest
All options from Shared Options are supported.
@spec update_member_partial( String.t(), String.t(), ExStreamClient.Model.UpdateMemberPartialRequest.t(), req_opts: keyword(), client: module(), endpoint: String.t(), api_key: String.t(), api_key_secret: String.t(), user_id: String.t() ) :: {:ok, ExStreamClient.Model.UpdateMemberPartialResponse.t()} | {:error, any()}
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.UpdateMemberPartialRequest
Optional Arguments:
user_id
All options from Shared Options are supported.
Uploads file
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.FileUploadRequest
All options from Shared Options are supported.
Uploads image
Required Arguments:
type
id
payload
:Elixir.ExStreamClient.Model.ImageUploadRequest
All options from Shared Options are supported.