ExStreamClient.Operations.Blocklists (ExStreamClient v0.1.3)
View SourceModules for interacting with the blocklists
group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
Summary
Functions
Creates a new application blocklist, once created the blocklist can be used by any channel type
Deletes previously created application blocklist
Returns block list by given name
Returns all available block lists
Updates contents of the block list
Functions
@spec create_block_list(ExStreamClient.Model.CreateBlockListRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.CreateBlockListResponse.t()} | {:error, any()}
Creates a new application blocklist, once created the blocklist can be used by any channel type
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec delete_block_list(String.t(), client: module(), team: String.t()) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes previously created application blocklist
Required Arguments:
name
Optional Arguments:
team
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec get_block_list(String.t(), client: module(), team: String.t()) :: {:ok, ExStreamClient.Model.GetBlockListResponse.t()} | {:error, any()}
Returns block list by given name
Required Arguments:
name
Optional Arguments:
team
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec list_block_lists(client: module(), team: String.t()) :: {:ok, ExStreamClient.Model.ListBlockListResponse.t()} | {:error, any()}
Returns all available block lists
Optional Arguments:
team
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec update_block_list(String.t(), ExStreamClient.Model.UpdateBlockListRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.UpdateBlockListResponse.t()} | {:error, any()}
Updates contents of the block list
Required Arguments:
name
payload
:Elixir.ExStreamClient.Model.UpdateBlockListRequest
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)