Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
6 changes: 6 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@ products:
availability: deprecated
slug: v2

- display-name: SDK Reference
slug: sdk-reference
path: products/sdk-reference/sdk-reference.yml
icon: fa-regular fa-books
subtitle: Auto-generated reference for every SignalWire SDK

# Column 3 (APIs)
- display-name: APIs
slug: apis
Expand Down
10 changes: 10 additions & 0 deletions fern/products/sdk-reference/cpp/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"language": "cpp",
"sdk_name": "cpp-sdk",
"version": null,
"source_repo": "https://github.com/signalwire/signalwire-cpp",
"format": "mdx",
"platform": "fern",
"base_slug": "/reference/cpp",
"item_count": 1633
}
32 changes: 32 additions & 0 deletions fern/products/sdk-reference/cpp/c-tool-context/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
slug: "/reference/cpp/c-tool-context"
title: "CToolContext"
sdk_label: "C++ SDK"
icon: "cpp"
lustri:
auto_generated: true
kind: "class"
language: "cpp"
qualified_name: "CToolContext"
source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/c_api/signalwire_c.cpp"
visibility: "public"
---
# `CToolContext`

## Signature

```cpp
struct CToolContext
```

## Properties

<ParamField path="handler" type="sw_tool_handler_t handler" required />

<ParamField path="user_data" type="void * user_data" required />

## Source

[`src/c_api/signalwire_c.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/c_api/signalwire_c.cpp)

Line 83.
25 changes: 25 additions & 0 deletions fern/products/sdk-reference/cpp/httplib/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
slug: "/reference/cpp/httplib"
title: "httplib"
sdk_label: "C++ SDK"
icon: "cpp"
lustri:
auto_generated: true
kind: "module"
language: "cpp"
qualified_name: "httplib"
source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp"
---
# `httplib`

## Signature

```cpp
namespace httplib
```

## Source

[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp)

Line 26.
16 changes: 16 additions & 0 deletions fern/products/sdk-reference/cpp/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "C++ SDK"
slug: "/reference/cpp"
lustri:
auto_generated: true
language: "cpp"
kind: "sdk"
---
# C++ SDK Reference

## Modules

- [`httplib`](/reference/cpp/httplib)
- [`signalwire`](/reference/cpp/signalwire)
- [`std`](/reference/cpp/std)

42 changes: 42 additions & 0 deletions fern/products/sdk-reference/cpp/signalwire/add-skill-directory.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
slug: "/reference/cpp/signalwire/add-skill-directory"
title: "add_skill_directory"
sdk_label: "C++ SDK"
icon: "cpp"
lustri:
auto_generated: true
kind: "function"
language: "cpp"
qualified_name: "signalwire::add_skill_directory"
parent: "signalwire"
source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp"
visibility: "public"
---
# `add_skill_directory`

Add a directory to search for skills.
Mirrors Python's signalwire.add\_skill\_directory(path) — delegates to the singleton skills::SkillRegistry instance so third-party skill collections can be registered by path.

std::invalid\_argument

when the path doesn't exist or isn't a directory.

## Signature

```cpp
void add_skill_directory(const std::string & path)
```

## Parameters

<ParamField path="path" type="const std::string &" required />

## Throws

- `std::invalid_argument` — when the path doesn't exist or isn't a directory.

## Source

[`src/signalwire.cpp`](https://github.com/signalwire/signalwire-cpp/blob/main/src/signalwire.cpp)

Line 94.
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
slug: "/reference/cpp/signalwire/agent/agent-base/add-answer-verb"
title: "add_answer_verb"
sdk_label: "C++ SDK"
icon: "cpp"
lustri:
auto_generated: true
kind: "method"
language: "cpp"
qualified_name: "signalwire::agent::AgentBase::add_answer_verb"
parent: "signalwire::agent::AgentBase"
module: "signalwire.agent"
source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp"
visibility: "public"
---
# `add_answer_verb`

## Signature

```cpp
AgentBase & add_answer_verb(const std::string & verb_name, const json & params)
```

## Parameters

<ParamField path="verb_name" type="const std::string &" required />

<ParamField path="params" type="const json &" required />

## Returns

`AgentBase &`

## Source

[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp)

Line 379.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
slug: "/reference/cpp/signalwire/agent/agent-base/add-context"
title: "add_context"
sdk_label: "C++ SDK"
icon: "cpp"
lustri:
auto_generated: true
kind: "method"
language: "cpp"
qualified_name: "signalwire::agent::AgentBase::add_context"
parent: "signalwire::agent::AgentBase"
module: "signalwire.agent"
source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp"
visibility: "public"
---
# `add_context`

## Signature

```cpp
contexts::Context & add_context(const std::string & name)
```

## Parameters

<ParamField path="name" type="const std::string &" required />

## Returns

`contexts::Context &`

## Source

[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp)

Line 391.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
slug: "/reference/cpp/signalwire/agent/agent-base/add-function-include"
title: "add_function_include"
sdk_label: "C++ SDK"
icon: "cpp"
lustri:
auto_generated: true
kind: "method"
language: "cpp"
qualified_name: "signalwire::agent::AgentBase::add_function_include"
parent: "signalwire::agent::AgentBase"
module: "signalwire.agent"
source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp"
visibility: "public"
---
# `add_function_include`

## Signature

```cpp
AgentBase & add_function_include(const json & include)
```

## Parameters

<ParamField path="include" type="const json &" required />

## Returns

`AgentBase &`

## Source

[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp)

Line 369.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
slug: "/reference/cpp/signalwire/agent/agent-base/add-hint"
title: "add_hint"
sdk_label: "C++ SDK"
icon: "cpp"
lustri:
auto_generated: true
kind: "method"
language: "cpp"
qualified_name: "signalwire::agent::AgentBase::add_hint"
parent: "signalwire::agent::AgentBase"
module: "signalwire.agent"
source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp"
visibility: "public"
---
# `add_hint`

## Signature

```cpp
AgentBase & add_hint(const std::string & hint)
```

## Parameters

<ParamField path="hint" type="const std::string &" required />

## Returns

`AgentBase &`

## Source

[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp)

Line 290.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
slug: "/reference/cpp/signalwire/agent/agent-base/add-hints"
title: "add_hints"
sdk_label: "C++ SDK"
icon: "cpp"
lustri:
auto_generated: true
kind: "method"
language: "cpp"
qualified_name: "signalwire::agent::AgentBase::add_hints"
parent: "signalwire::agent::AgentBase"
module: "signalwire.agent"
source_url: "https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp"
visibility: "public"
---
# `add_hints`

## Signature

```cpp
AgentBase & add_hints(const std::vector< std::string > & hints)
```

## Parameters

<ParamField path="hints" type="const std::vector< std::string > &" required />

## Returns

`AgentBase &`

## Source

[`include/signalwire/agent/agent_base.hpp`](https://github.com/signalwire/signalwire-cpp/blob/main/include/signalwire/agent/agent_base.hpp)

Line 291.
Loading
Loading