ExStreamClient.Operations.Chat.Segments (ExStreamClient v0.1.5)
View SourceModules for interacting with the chat/segments
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
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
Delete a segment
Required Arguments:
id
All options from Shared Options are supported.
Delete targets from a segment
Required Arguments:
All options from Shared Options are supported.
Get segment
Required Arguments:
id
All options from Shared Options are supported.
Query segment targets
Required Arguments:
All options from Shared Options are supported.
Query segments
Required Arguments:
All options from Shared Options are supported.
Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise
Required Arguments:
id
target_id
All options from Shared Options are supported.