ExStreamClient.Operations.Chat.Segments (ExStreamClient v0.1.3)
View SourceModules for interacting with the chat/segments
group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
Summary
Functions
Delete a segment
Delete targets from a segment
Get segment
Query segment targets
Query segments
Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise
Functions
@spec delete_segment(String.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Delete a segment
Required Arguments:
id
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec delete_segment_targets( String.t(), ExStreamClient.Model.DeleteSegmentTargetsRequest.t(), [ {:client, module()} ] ) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Delete targets from a segment
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec get_segment(String.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.GetSegmentResponse.t()} | {:error, any()}
Get segment
Required Arguments:
id
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec query_segment_targets( String.t(), ExStreamClient.Model.QuerySegmentTargetsRequest.t(), [ {:client, module()} ] ) :: {:ok, ExStreamClient.Model.QuerySegmentTargetsResponse.t()} | {:error, any()}
Query segment targets
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec query_segments(ExStreamClient.Model.QuerySegmentsRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.QuerySegmentsResponse.t()} | {:error, any()}
Query segments
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec segment_target_exists(String.t(), String.t(), [{:client, module()}]) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise
Required Arguments:
id
target_id
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)