ExStreamClient.Operations.Chat.Segments (ExStreamClient v0.1.5)

View Source

Modules 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 used
  • api_key_secret - API key secret to use. If not provided, the default secret from config will be used
  • endpoint - endpoint to use. If not provided, the default endpoint from config will be used
  • client - HTTP client to use. Must implement ExStreamClient.Http.Behavior. Defaults to ExStreamClient.Http
  • req_opts - all of these options will be forwarded to req. See Req.new/1 for available options

Summary

Functions

Delete targets from a segment

Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise

Functions

delete_segment(id, opts \\ [])

Delete a segment

Required Arguments:

  • id

All options from Shared Options are supported.

delete_segment_targets(id, payload, opts \\ [])

Delete targets from a segment

Required Arguments:

All options from Shared Options are supported.

get_segment(id, opts \\ [])

Get segment

Required Arguments:

  • id

All options from Shared Options are supported.

query_segment_targets(id, payload, opts \\ [])

Query segment targets

Required Arguments:

All options from Shared Options are supported.

query_segments(payload, opts \\ [])

Query segments

Required Arguments:

All options from Shared Options are supported.

segment_target_exists(id, target_id, opts \\ [])

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.