ExStreamClient.Operations.Chat.Threads (ExStreamClient v0.1.3)

View Source

Modules for interacting with the chat/threads group of Stream APIs

API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2

Summary

Functions

Return a specific thread

Returns the list of threads for specific user

Updates certain fields of the thread

Functions

get_thread(message_id, opts \\ [])

@spec get_thread(String.t(),
  client: module(),
  member_limit: integer(),
  participant_limit: integer(),
  reply_limit: integer()
) :: {:ok, ExStreamClient.Model.GetThreadResponse.t()} | {:error, any()}

Return a specific thread

Required Arguments:

  • message_id

Optional Arguments:

query_threads(payload, opts \\ [])

@spec query_threads(ExStreamClient.Model.QueryThreadsRequest.t(), [
  {:client, module()}
]) ::
  {:ok, ExStreamClient.Model.QueryThreadsResponse.t()} | {:error, any()}

Returns the list of threads for specific user

Required Arguments:

Optional Arguments:

update_thread_partial(message_id, payload, opts \\ [])

@spec update_thread_partial(
  String.t(),
  ExStreamClient.Model.UpdateThreadPartialRequest.t(),
  [
    {:client, module()}
  ]
) ::
  {:ok, ExStreamClient.Model.UpdateThreadPartialResponse.t()} | {:error, any()}

Updates certain fields of the thread

Sends events:

  • thread.updated
  • thread.updated

Required Arguments:

Optional Arguments: