ClaudeAgentSDK.SessionStore.Helpers (claude_agent_sdk v0.18.0)

Copy Markdown View Source

Session helper APIs backed by a SessionStore adapter.

Summary

Functions

delete_session_via_store(session_id, store, opts \\ [])

@spec delete_session_via_store(String.t(), term(), keyword()) ::
  :ok | {:error, term()}

fork_session_via_store(session_id, store, opts \\ [])

@spec fork_session_via_store(String.t(), term(), keyword()) ::
  ClaudeAgentSDK.Session.ForkResult.t() | {:error, term()}

get_session_info_from_store(session_id, store, opts \\ [])

@spec get_session_info_from_store(String.t(), term(), keyword()) ::
  ClaudeAgentSDK.Session.SessionInfo.t() | nil

get_session_messages_from_store(session_id, store, opts \\ [])

@spec get_session_messages_from_store(String.t(), term(), keyword()) :: [
  ClaudeAgentSDK.Session.SessionMessage.t()
]

get_subagent_messages_from_store(session_id, agent_id, store, opts \\ [])

@spec get_subagent_messages_from_store(String.t(), String.t(), term(), keyword()) :: [
  ClaudeAgentSDK.Session.SessionMessage.t()
]

list_sessions_from_store(store, opts \\ [])

@spec list_sessions_from_store(
  term(),
  keyword()
) :: [ClaudeAgentSDK.Session.SessionInfo.t()]

list_subagents_from_store(session_id, store, opts \\ [])

@spec list_subagents_from_store(String.t(), term(), keyword()) :: [String.t()]

rename_session_via_store(session_id, title, store, opts \\ [])

@spec rename_session_via_store(String.t(), String.t(), term(), keyword()) ::
  :ok | {:error, term()}

tag_session_via_store(session_id, tag, store, opts \\ [])

@spec tag_session_via_store(String.t(), String.t() | nil, term(), keyword()) ::
  :ok | {:error, term()}