libkazv

https://kazv.chat/libkazv/api/
Admin
libkazv is a matrix client SDK built upon lager and the value-oriented design it enables, providing...
Tokens:1,134,435
Snippets:13,754
Trust Score:5.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### start()

Source: https://kazv.chat/libkazv/api/functions_func_s.html

Starts various job types, returning their respective JobResponse objects.

```APIDOC
## start()

### Description
Initiates the execution of various job types, returning their specific JobResponse objects.

### Method
N/A (Function call)

### Endpoint
N/A (Function call)

### Parameters
None

### Response
- **JobResponse**: An object of type Kazv::Api::GetEventContextJob::JobResponse, Kazv::Api::GetEventsJob::JobResponse, Kazv::Api::GetRoomEventsJob::JobResponse, or Kazv::Api::PeekEventsJob::JobResponse.
```

--------------------------------

### Create Kazv SDK Instance

Source: https://kazv.chat/libkazv/api/md_tutorials_2tutorial0.html

Initializes the Kazv SDK with necessary components like io_context, job handler, event emitter, and promise handler. Ensure io_context is set up for the event loop.

```cpp
auto io = ...;
auto jh = Kazv::CprJobHandler{...};
auto ee = Kazv::LagerStoreEventEmitter{...};
auto sdk = Kazv::makeSdk(
Kazv::SdkModel{},
jh,
ee,
Kazv::AsioPromiseHandler{io.get_executor()},
zug::identity
);
```

--------------------------------

### Get start token from GetEventsJob::JobResponse

Source: https://kazv.chat/libkazv/api/old__sync_8hpp_source.html

Retrieves the start token from a GetEventsJob response. This token correlates to the start of a chunk.

```cpp
std::optional< std::string > start() const
```

--------------------------------

### Include Headers for libkazv Tutorial

Source: https://kazv.chat/libkazv/api/tutorial0_8cpp.html

This snippet includes essential headers for the libkazv library and Boost.Asio, required for the tutorial's functionality.

```cpp
#include <libkazv-config.hpp>
#include <sdk.hpp>
#include <cprjobhandler.hpp>
#include <lagerstoreeventemitter.hpp>
#include <asio-promise-handler.hpp>
#include <iostream>
#include <cstdlib>
#include <lager/store.hpp>
#include <lager/event_loop/boost_asio.hpp>
#include <boost/asio.hpp>
```

--------------------------------

### GET

Source: https://kazv.chat/libkazv/api/classKazv_1_1BaseJob.html

Represents the GET HTTP method for BaseJob.

```APIDOC
## ◆ GET

Represents the GET HTTP method for BaseJob.

### Type
static member
```

--------------------------------

### startSyncing

Source: https://kazv.chat/libkazv/api/classKazv_1_1Client-members.html

Initiates the synchronization process with the Matrix homeserver.

```APIDOC
## startSyncing

### Description
Starts the client synchronization process.
```

--------------------------------

### Get Pushers Job

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1GetPushersJob.html

Gets the current pushers for the authenticated user.

```APIDOC
## Get Pushers Job

### Description
Gets the current pushers for the authenticated user.

### Method
GET (assumed, as it retrieves data)

### Endpoint
/pushers (assumed, based on common API patterns for retrieving resources)

### Parameters
No specific parameters are documented in the provided text.

### Request Example
No request example is provided.

### Response
#### Success Response
- pushers (array) - A list of pusher objects.

#### Response Example
No response example is provided.
```

--------------------------------

### mLoginTokenLogin()

Source: https://kazv.chat/libkazv/api/classKazv_1_1Client.html

Logs in using a login token, creating a new session on the homeserver. If successful, it automatically calls `startSyncing()`.

```APIDOC
## mLoginTokenLogin()

Logs in using a login token. This will create a new session on the homeserver. If the returned Promise resolves successfully, this will call `startSyncing()`.

### Parameters
- **homeserver** (std::string) - The base url of the homeserver. E.g. `https://tusooa.xyz`.
- **loginToken** (std::string) - The login token.
- **deviceName** (std::optional<std::string>) - Optionally, a custom device name. If empty, `libkazv` will be used.

### Returns
A Promise that resolves when logging in successfully, or when there is an error.
```

--------------------------------

### CJoinRoomJob

Source: https://kazv.chat/libkazv/api/annotated.html

Start the requesting user participating in a particular room.

```APIDOC
## CJoinRoomJob

### Description
Start the requesting user participating in a particular room.

### Method
POST (Assumed based on 'Join' action)

### Endpoint
/join_room (Assumed based on job name)

### Parameters
#### Request Body
- **room_id** (string) - Required - The ID of the room to join.
```

--------------------------------

### startSyncing()

Source: https://kazv.chat/libkazv/api/functions_func_s.html

Initiates the synchronization process for the client.

```APIDOC
## startSyncing()

### Description
Initiates the synchronization process for the client to fetch updates.

### Method
N/A (Function call)

### Endpoint
N/A (Function call)

### Parameters
None

### Response
- **Client**: The updated Kazv::Client object.
```

--------------------------------

### Cursor Get Operator

Source: https://kazv.chat/libkazv/api/cursorutil_8hpp_source.html

The '+' operator on a cursor first makes the cursor and then gets its value.

```cpp
namespace CursorOp
{
template<class Cursor>
inline auto operator+(Cursor &&c)
{
return (~std::forward<Cursor>(c)).get();
}
}
```

--------------------------------

### CJoinRoomByIdJob

Source: https://kazv.chat/libkazv/api/annotated.html

Start the requesting user participating in a particular room.

```APIDOC
## CJoinRoomByIdJob

### Description
Start the requesting user participating in a particular room.

### Method
POST (Assumed based on 'Join' action)

### Endpoint
/join_room_by_id (Assumed based on job name)

### Parameters
#### Request Body
- **room_id** (string) - Required - The ID of the room to join.
```

--------------------------------

### withData

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1GetDevicesJob-members.html

Sets the data for the get devices job.

```APIDOC
## withData(JsonWrap j) &&

### Description
Sets the data for the job. This is the move-assignment version.

### Parameters
* **j** (JsonWrap) - The JSON data to set.
```

```APIDOC
## withData(JsonWrap j) const &

### Description
Sets the data for the job. This is the copy-assignment version.

### Parameters
* **j** (JsonWrap) - The JSON data to set.
```

--------------------------------

### Variables starting with 'k'

Source: https://kazv.chat/libkazv/api/functions_vars_k.html

This section details variables that start with the letter 'k', along with the classes they are associated with.

```APIDOC
## Variables starting with 'k'

### key
- **Classes**: Kazv::AES256CTRDesc::Private, Kazv::Api::PushCondition, Kazv::Api::SearchJob::Group, Kazv::EncryptedFileDesc::Private

### keyRaw
- **Classes**: Kazv::AES256CTRDesc::Private

### keys
- **Classes**: Kazv::Api::CrossSigningKey, Kazv::Api::DeviceKeys, Kazv::Api::SearchJob::RoomEventsCriteria

### keySize
- **Classes**: Kazv::AES256CTRDesc

### kind
- **Classes**: Kazv::Api::GetPushersJob::Pusher, Kazv::Api::PushCondition

### knock
- **Classes**: Kazv::Api::SyncJob::Rooms

### knockState
- **Classes**: Kazv::Api::SyncJob::KnockedRoom

### knownSessions
- **Classes**: Kazv::CryptoPrivate
```

--------------------------------

### Variables starting with 'h'

Source: https://kazv.chat/libkazv/api/functions_vars_h.html

This section details variables that start with the letter 'h', along with the classes they are associated with.

```APIDOC
## Variables

### - h -

* **header** : Kazv::BaseJob::Private, Kazv::Response
* **height** : Kazv::DownloadThumbnailAction
* **heroIds** : Kazv::RoomModel, Kazv::SetHeroIdsAction
* **highlightCount** : Kazv::Api::SyncJob::UnreadNotificationCounts
* **highlights** : Kazv::Api::SearchJob::ResultRoomEvents
* **homeserver** : Kazv::Api::DiscoveryInformation
```

--------------------------------

### passwordLogin()

Source: https://kazv.chat/libkazv/api/classKazv_1_1Client.html

Logs in using a username and password, creating a new session on the homeserver. If successful, it automatically calls `startSyncing()`.

```APIDOC
## passwordLogin()

Login using the password. This will create a new session on the homeserver. If the returned Promise resolves successfully, this will call `startSyncing()`.

### Parameters
- **homeserver** (std::string) - The base url of the homeserver. E.g. `https://tusooa.xyz`.
- **username** (std::string) - The username. This can be the full user id or just the local part. E.g. `tusooa`, `@tusooa:tusooa.xyz`.
- **password** (std::string) - The password.
- **deviceName** (std::string) - Optionally, a custom device name. If empty, `libkazv` will be used.

### Returns
A Promise that resolves when logging in successfully, or when there is an error.
```

--------------------------------

### Functions starting with 'h'

Source: https://kazv.chat/libkazv/api/functions_func_h.html

This section details functions in libkazv that start with the letter 'h'. Each function is listed with the class it belongs to.

```APIDOC
## Functions starting with 'h'

### handle()

- **Belongs to**: Kazv::PushRulesDesc

### handleNotification()

- **Belongs to**: Kazv::NotificationHandler

### handleRule()

- **Belongs to**: Kazv::PushRulesDescPrivate

### has()

- **Belongs to**: Kazv::RoomListModel

### hasInboundGroupSession()

- **Belongs to**: Kazv::Crypto

### hasUser()

- **Belongs to**: Kazv::RoomModel

### heroDisplayNames()

- **Belongs to**: Kazv::Room

### heroIds()

- **Belongs to**: Kazv::Room

### heroMemberEvents()

- **Belongs to**: Kazv::Room, Kazv::RoomModel

### homeServer()

- **Belongs to**: Kazv::Api::LoginJob::JobResponse, Kazv::Api::RegisterJob::JobResponse
```

--------------------------------

### Create Store with Event Loop and Dependencies

Source: https://kazv.chat/libkazv/api/md_design-docs_2architecture.html

Constructs a store with an initial model, an event loop, and optional dependencies. Dependencies are accessible within the context for effects.

```cpp
auto initialModel = ...;
auto eventLoop = ...;
auto store = makeStore(
initialModel,
withEventLoop(eventLoop),
...);
```

```cpp
auto store = makeStore(..., lager::with_deps(depA, depB));
```

--------------------------------

### Namespace Members starting with 'v'

Source: https://kazv.chat/libkazv/api/namespacemembers_v.html

This section details the namespace members that start with the letter 'v', including functions, types, and enumerations.

```APIDOC
## v

### Description
Members within the namespace starting with 'v'.

### Members
- **validateFormat()** : Kazv::VerificationUtils
  * Description: Validates the format of a given input.
- **validatePushRules()** : Kazv
  * Description: Validates push rules.
- **validateRule()** : Kazv
  * Description: Validates a specific rule.
- **Variant** : Kazv
  * Description: Represents a variant type.
- **VerificationProcessState** : Kazv
  * Description: Represents the state of a verification process.
- **Verified** : Kazv
  * Description: Indicates a verified status.
- **voidOutputHelper** : Kazv::detail
  * Description: A helper for void output in the detail namespace.
```

--------------------------------

### Start Syncing

Source: https://kazv.chat/libkazv/api/classKazv_1_1Client.html

Initiates synchronization if the client is not already syncing. Synchronization continues until `stopSyncing()` is called or an error occurs during preparation. Returns a Promise that resolves when syncing is active or if there's a preparation error.

```cpp
client.startSyncing();
```

--------------------------------

### Namespace Members starting with 'i'

Source: https://kazv.chat/libkazv/api/namespacemembers_i.html

This section details various members within the libkazv namespace, including functions, types, and constants, all starting with the letter 'i'.

```APIDOC
## Namespace Members - i

This page lists all members of the libkazv namespace whose names start with 'i'.

### identValidate()

- **Namespace:** Kazv
- **Description:** Validates an identifier.

### immerPushBackOrInsert

- **Namespace:** Kazv::detail
- **Description:** Function or type related to 'immer' operations, likely for adding elements to a collection.

### increaseTxnId()

- **Namespace:** Kazv
- **Description:** Increments a transaction ID.

### INFO

- **Namespace:** Kazv::detail
- **Description:** A constant or enum value representing informational logging level.

### InitialSyncResponse

- **Namespace:** Kazv::Api
- **Description:** Represents the response structure for an initial synchronization operation.

### intoImmer

- **Namespace:** Kazv
- **Description:** Function or type related to converting data into an 'immer' compatible format.

### invalidMessage

- **Namespace:** Kazv::VerificationCancelCodes
- **Description:** An enumerator indicating an invalid message during verification.

### Invite

- **Namespace:** Kazv
- **Description:** Represents an invitation entity.

### InviteBy3PIDResponse

- **Namespace:** Kazv::Api
- **Description:** Response structure for inviting a user via a 3rd Party ID.

### InviteUserResponse

- **Namespace:** Kazv::Api
- **Description:** Response structure for inviting a user.

### isBodyJson()

- **Namespace:** Kazv
- **Description:** Checks if the request body is in JSON format.

### isJsonWrap

- **Namespace:** Kazv::detail
- **Description:** A flag or function indicating if a JSON structure is wrapped.

### isNonCompoundCanonicalJsonValue()

- **Namespace:** Kazv
- **Description:** Checks if a JSON value is non-compound and canonical.

### isPromise

- **Namespace:** Kazv
- **Description:** Checks if a value is a Promise.

### IsPushRuleEnabledResponse

- **Namespace:** Kazv::Api
- **Description:** Response structure indicating the status of a push rule.

### isToDevice() : Kazv::VerificationUtils

- **Namespace:** Kazv::VerificationUtils
- **Description:** Checks if a message is a to-device message.
```

--------------------------------

### AsioStdFileProvider Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1AsioStdFileProvider.html

Initializes an AsioStdFileProvider with a Boost.Asio executor and a filename.

```APIDOC
## AsioStdFileProvider()

### Description
Constructor for AsioStdFileProvider.

### Parameters
- **exec** (Exec) - Required - A boost::asio executor. It should run actions sequentially.
- **filename** (std::string) - Required - The file name of this FileProvider.
```

--------------------------------

### Class Definitions for Graph Example

Source: https://kazv.chat/libkazv/api/graph_legend.html

These C++ class definitions are used to generate an example inheritance graph. They demonstrate various inheritance types and template usage.

```cpp
/*! Invisible class because of truncation */
class Invisible { };
/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };
/* Class not documented with doxygen comments */
class Undocumented { };
/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };
/*! A template class */
template<class T> class Templ { };
/*! Class that is inherited using protected inheritance */
class ProtectedBase { };
/*! Class that is inherited using private inheritance */
class PrivateBase { };
/*! Class that is used by the Inherited class */
class Used { };
/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
protected ProtectedBase,
private PrivateBase,
public Undocumented,
public Templ<int>
{
private:
Used *m_usedClass;
};
```

--------------------------------

### Create ClientModel with Attributes

Source: https://kazv.chat/libkazv/api/factory_8hpp_source.html

Use `makeClient` to create a ClientModel. Modifiers like `withRoom`, `withAccountData`, `withCrypto`, and `withDevice` can be chained to set specific client properties.

```cpp
ClientModel makeClient(const ComposedModifier<ClientModel> &mod = {});
ComposedModifier<ClientModel> withRoom(RoomModel room);
ComposedModifier<ClientModel> withAccountData(immer::flex_vector<Event> accountDataEvent);
ComposedModifier<ClientModel> withCrypto(const Crypto &crypto);
ComposedModifier<ClientModel> withDevice(std::string userId, DeviceKeyInfo info);
```

--------------------------------

### Sdk()

Source: https://kazv.chat/libkazv/api/functions_func_s.html

Initializes or returns the Kazv SDK instance with specified template parameters for EventLoop, Xform, and Enhancers.

```APIDOC
## Sdk() < EventLoop, Xform, Enhancers >

### Description
Initializes or returns the Kazv SDK instance, parameterized by EventLoop, Xform, and Enhancers.

### Method
N/A (Function call)

### Endpoint
N/A (Function call)

### Parameters
None

### Response
- **Sdk**: An object of type Kazv::Sdk< EventLoop, Xform, Enhancers >.
```

--------------------------------

### Namespace Functions starting with 'g'

Source: https://kazv.chat/libkazv/api/namespacemembers_func_g.html

This section lists all functions within the libkazv namespace that start with the letter 'g'. Each entry provides the function name and the namespace it is associated with.

```APIDOC
## Namespace Functions (g)

### Description
Provides a list of functions within the libkazv namespace that start with the letter 'g'.

### Functions

- **genRandom()** : Kazv
  - Description: Generates a random value within the Kazv namespace.

- **genRandomData()** : Kazv
  - Description: Generates random data within the Kazv namespace.

- **getEventEmitter()** : Kazv
  - Description: Retrieves the event emitter instance from the Kazv namespace.

- **getIn()** : Kazv
  - Description: Gets a value from the Kazv namespace.

- **getInJson()** : Kazv
  - Description: Gets a JSON value from the Kazv namespace.

- **getJobHandler()** : Kazv
  - Description: Retrieves the job handler from the Kazv namespace.

- **getRoomIdByAliasJob()** : Kazv
  - Description: Gets the room ID by alias job from the Kazv namespace.

- **getTxnId()** : Kazv
  - Description: Retrieves the transaction ID from the Kazv namespace.
```

--------------------------------

### Namespace Members starting with 'n'

Source: https://kazv.chat/libkazv/api/namespacemembers_n.html

This section details namespace members that start with the letter 'n'. It includes 'none' which is an alias for Kazv::Base64Opts and 'NONE' which is part of Kazv::detail.

```APIDOC
## Namespace Members - n

### Description
This section lists namespace members starting with 'n'.

### Members
- **none** : Kazv::Base64Opts
- **NONE** : Kazv::detail
```

--------------------------------

### Kazv::Api::GetCapabilitiesJob Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1GetCapabilitiesJob-members.html

Initializes a new instance of the GetCapabilitiesJob class.

```APIDOC
## GetCapabilitiesJob(std::string serverUrl, std::string _accessToken)

### Description
Initializes a new instance of the GetCapabilitiesJob class with the specified server URL and access token.

### Parameters
* **serverUrl** (std::string) - The URL of the server.
* **_accessToken** (std::string) - The access token for authentication.
```

--------------------------------

### Kazv::Client::startSyncing

Source: https://kazv.chat/libkazv/api/client_8hpp_source.html

Initiates the synchronization process if the client is not already syncing.

```APIDOC
## startSyncing

### Description
Start syncing if the Client is not syncing.

### Method
(Not specified, likely a client method)

### Parameters
None.
```

--------------------------------

### Namespace Functions starting with 'd'

Source: https://kazv.chat/libkazv/api/namespacemembers_func_d.html

This section details the functions available in the Kazv namespace whose names start with 'd'. Each function is listed with its return type and a link to its specific documentation.

```APIDOC
## Namespace Functions - d

### Description
Provides a list of functions within the Kazv namespace that start with the letter 'd'. These functions cover various data manipulation and cryptographic operations.

### Functions

- **dataCombine()** : Kazv
  * Description: Combines data, likely for processing or storage.

- **dataCombineNone()** : Kazv
  * Description: A variation of dataCombine, possibly with default or no specific parameters.

- **declref()** : Kazv::detail
  * Description: Declares a reference, likely an internal helper function within the 'detail' namespace.

- **decodeBase64()** : Kazv
  * Description: Decodes a Base64 encoded string.

- **decryptKeyExport()** : Kazv
  * Description: Decrypts an exported key.

- **deriveKeyExportKey()** : Kazv
  * Description: Derives a key used for exporting other keys.
```

--------------------------------

### getRoomIdByAliasJob

Source: https://kazv.chat/libkazv/api/classKazv_1_1Client.html

Get a GetRoomIdByAliasJob.

```APIDOC
## getRoomIdByAliasJob

### Description
Get a GetRoomIdByAliasJob.

### Method
`getRoomIdByAliasJob(std::string roomAlias)`

### Parameters
#### Path Parameters
- **roomAlias** (std::string) - Required - The alias of the room.

### Returns
`BaseJob` - A GetRoomIdByAliasJob instance.
```

--------------------------------

### tokenLogin()

Source: https://kazv.chat/libkazv/api/functions_t.html

Initiates a login process using a token, returning a Kazv::Client.

```APIDOC
## tokenLogin()

### Description
Performs a login operation using a token.

### Method
N/A (Function Call)

### Returns
- Kazv::Client
```

--------------------------------

### Namespace Members starting with 'l'

Source: https://kazv.chat/libkazv/api/namespacemembers_l.html

This section details members within the libkazv API namespaces that start with the letter 'l'. It covers various entities like functions, responses, and internal details.

```APIDOC
## Namespace Members - l

### Description
Provides a list of namespace members starting with 'l'.

### Members
- **Leave** : Kazv
  * Description: Represents the action of leaving a Kazv entity.
- **LeaveRoomResponse** : Kazv::Api
  * Description: Response object for leaving a room in the Kazv API.
- **load()** : boost::serialization
  * Description: Function to load data, likely for serialization purposes.
- **LoginResponse** : Kazv::Api
  * Description: Response object for a successful login operation in the Kazv API.
- **LogoutAllResponse** : Kazv::Api
  * Description: Response object for logging out all active sessions in the Kazv API.
- **LogoutResponse** : Kazv::Api
  * Description: Response object for a single logout operation in the Kazv API.
- **looksLikeImmer** : Kazv::detail
  * Description: Internal detail function to check if something resembles an 'Immer' type.
```

--------------------------------

### makeSdk

Source: https://kazv.chat/libkazv/api/namespacemembers_func_m.html

Initializes and returns a Kazv SDK instance.

```APIDOC
## makeSdk()

### Description
Initializes and returns a Kazv SDK instance.

### Returns
Kazv - The initialized Kazv SDK.
```

--------------------------------

### nameOpt

Source: https://kazv.chat/libkazv/api/room_8hpp_source.html

Get the name of this room.

```APIDOC
## nameOpt

### Description
Get the name of this room.

### Method
auto

### Endpoint
nameOpt()

### Parameters
None

### Response
#### Success Response (200)
- **name** (std::optional<std::string>) - The name of the room, if available.
```

--------------------------------

### Create DeviceKeyInfo with Attributes

Source: https://kazv.chat/libkazv/api/factory_8hpp_source.html

Use `makeDeviceKeyInfo` to create a DeviceKeyInfo object. Chain modifiers such as `withDeviceId`, `withDeviceDisplayName`, and `withDeviceTrustLevel` to configure the device details.

```cpp
DeviceKeyInfo makeDeviceKeyInfo(const ComposedModifier<DeviceKeyInfo> &mod = {});
ComposedModifier<DeviceKeyInfo> withDeviceId(std::string deviceId);
ComposedModifier<DeviceKeyInfo> withDeviceDisplayName(std::string displayName);
ComposedModifier<DeviceKeyInfo> withDeviceTrustLevel(DeviceTrustLevel trustLevel);
```

--------------------------------

### GetAccountDataPerRoomJob

Source: https://kazv.chat/libkazv/api/namespaceKazv_1_1Api.html

Get some account_data for the user.

```APIDOC
## GetAccountDataPerRoomJob

### Description
Retrieves account data for a specific room for the authenticated user.

### Method
GET

### Endpoint
/_matrix/client/r0/rooms/:roomId/account_data/:data_type

### Parameters
#### Path Parameters
- **roomId** (string) - Required - The ID of the room.
- **data_type** (string) - Required - The type of account data to retrieve (e.g., "m.room.tags").

### Response
#### Success Response (200)
- **content** (object) - The account data payload for the specified room.

#### Response Example
```json
{
  "content": {
    "tags": {
      "!roomid1:example.com": {
        "favorite": {}
      }
    }
  }
}
```
```

--------------------------------

### Kazv::CreateRoomPreset

Source: https://kazv.chat/libkazv/api/namespacemembers_enum.html

Presets for creating rooms.

```APIDOC
## Enum: CreateRoomPreset

### Description
Presets for creating rooms.

### Namespace
Kazv
```

--------------------------------

### GetCapabilitiesJob Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1GetCapabilitiesJob.html

Initializes a new GetCapabilitiesJob instance to fetch server capabilities. Requires the server URL and an access token.

```APIDOC
## GetCapabilitiesJob()

### Description
Initializes a new instance of the `GetCapabilitiesJob` class. This job is responsible for retrieving information about the server's capabilities.

### Parameters
- **_serverUrl** (std::string) - The URL of the server to connect to.
- **__accessToken_** (std::string) - The access token for authentication.
```

--------------------------------

### GetAccountDataJob

Source: https://kazv.chat/libkazv/api/namespaceKazv_1_1Api.html

Get some account_data for the user.

```APIDOC
## GetAccountDataJob

### Description
Retrieves account data for the authenticated user. Account data is arbitrary data stored on a per-user basis.

### Method
GET

### Endpoint
/_matrix/client/r0/user/:user_id/account_data/:data_type

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The user ID for whom to retrieve account data.
- **data_type** (string) - Required - The type of account data to retrieve (e.g., "m.direct", "m.settings.v1.e2e").

### Response
#### Success Response (200)
- **content** (object) - The account data payload.

#### Response Example
```json
{
  "content": {
    "m.direct": {
      "!roomid1:example.com": ["@alice:example.com"]
    }
  }
}
```
```

--------------------------------

### begin() Member Function

Source: https://kazv.chat/libkazv/api/classRangeT.html

Returns an iterator pointing to the beginning of the range.

```APIDOC
## ◆ begin()

```cpp
template<class T >
auto RangeT< T >::begin() const;
```

The beginning iterator of this range.
```

--------------------------------

### type

Source: https://kazv.chat/libkazv/api/functions_func_t.html

Gets the type of an event.

```APIDOC
## type()

### Description
Retrieves the type of the event.

### Method
`type()`

### Returns
- `Kazv::Event`: The event object.
```

--------------------------------

### joinRoom()

Source: https://kazv.chat/libkazv/api/functions_func_j.html

Initiates the process for a client to join a room.

```APIDOC
## joinRoom()

### Description
Initiates the process for a client to join a room.

### Returns
- Kazv::Client
```

--------------------------------

### supportVersions

Source: https://kazv.chat/libkazv/api/classKazv_1_1Client.html

Get all supported versions.

```APIDOC
## supportVersions

### Description
Get all supported versions.

### Method
`supportVersions()`

### Returns
`lager::reader< immer::array< std::string > >` - A reader containing the supported versions.
```

--------------------------------

### CGetDeviceJob

Source: https://kazv.chat/libkazv/api/annotated.html

Get a single device.

```APIDOC
## CGetDeviceJob

### Description
Get a single device.

### Method
GET

### Endpoint
/api/v1/devices/{deviceId}
```

--------------------------------

### JoinRoomByIdJob Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1JoinRoomByIdJob.html

Initializes a new instance of the JoinRoomByIdJob class to start a user participating in a particular room. Requires server URL, access token, and room ID. Optional parameters include third-party signing details and a reason for joining.

```APIDOC
## JoinRoomByIdJob(std::string _serverUrl, std::string _accessToken, std::string _roomId, std::optional<ThirdPartySigned> _thirdPartySigned = std::nullopt, std::optional<std::string> _reason = std::nullopt)

### Description
Start the requesting user participating in a particular room.

### Parameters
- **_serverUrl** (std::string) - The base URL of the Matrix server.
- **_accessToken** (std::string) - The authentication token for the user.
- **_roomId** (std::string) - The identifier of the room to join. This must be a room ID, not an alias.
- **_thirdPartySigned** (std::optional<ThirdPartySigned>) - Optional. If supplied, the homeserver must verify that it matches a pending `m.room.third_party_invite` event in the room.
- **_reason** (std::optional<std::string>) - Optional. A reason to be included as the `reason` on the subsequent membership event.
```

--------------------------------

### InviteUserJob::buildQuery Method

Source: https://kazv.chat/libkazv/api/inviting_8hpp_source.html

Builds the query for the InviteUserJob. Defined in inviting.cpp.

```cpp
static BaseJob::Query buildQuery(
 );
**Definition** inviting.cpp:13
```

--------------------------------

### CGetAccountDataPerRoomJob

Source: https://kazv.chat/libkazv/api/annotated.html

Get some account_data for the user.

```APIDOC
## CGetAccountDataPerRoomJob

### Description
Get some account_data for the user.

### Method
GET

### Endpoint
/api/v1/rooms/{roomId}/account/data/{eventId}
```

--------------------------------

### QueryKeysJob Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1QueryKeysJob.html

Initializes a new instance of the QueryKeysJob class to download device identity keys. It takes server URL, access token, device keys, and optional timeout and token parameters.

```APIDOC
## QueryKeysJob(std::string serverUrl, std::string _accessToken, immer::map< std::string, immer::array< std::string > > deviceKeys, std::optional< int > timeout=std::nullopt, std::optional< std::string > token=std::nullopt)

### Description
Download device identity keys.

### Parameters
- **deviceKeys** (immer::map< std::string, immer::array< std::string > >) - Required - The keys to be downloaded. A map from user ID, to a list of device IDs, or to an empty list to indicate all devices for the corresponding user.
- **timeout** (std::optional< int >) - Optional - The time (in milliseconds) to wait when downloading keys from remote servers. 10 seconds is the recommended default.
- **token** (std::optional< std::string >) - Optional - If the client is fetching keys as a result of a device update received in a sync request, this should be the 'since' token of that sync request, or any later sync token. This allows the server to ensure its response contains the keys advertised by the notification in that sync.
```

--------------------------------

### CGetAccountDataJob

Source: https://kazv.chat/libkazv/api/annotated.html

Get some account_data for the user.

```APIDOC
## CGetAccountDataJob

### Description
Get some account_data for the user.

### Method
GET

### Endpoint
/api/v1/account/data/{eventId}
```

--------------------------------

### token

Source: https://kazv.chat/libkazv/api/structKazv_1_1ClientModel-members.html

Gets or sets the authentication token.

```APIDOC
## token

### Description
Gets or sets the authentication token.

### Method
GET/PUT (assumed)
```

--------------------------------

### Kazv::PrepareForSharingRoomKeyAction Members

Source: https://kazv.chat/libkazv/api/structKazv_1_1PrepareForSharingRoomKeyAction-members.html

This section details the members of the Kazv::PrepareForSharingRoomKeyAction class. It includes data members like 'devices', 'e', and 'roomId', as well as a static method 'randomSize'.

```APIDOC
## Class Members: Kazv::PrepareForSharingRoomKeyAction

### Description
This class is responsible for preparing room keys for sharing.

### Members

- **devices** (UserIdToDeviceIdMap) - Represents a map of user IDs to device IDs.
- **e** - An unspecified member of the class.
- **random** - An unspecified member of the class.
- **roomId** (string) - The identifier for the room.

### Static Methods

#### randomSize

- **Description**: Calculates a size based on the provided devices.
- **Signature**: `static randomSize(UserIdToDeviceIdMap devices)`
- **Parameters**:
  - **devices** (UserIdToDeviceIdMap) - A map of user IDs to device IDs.

### Typedefs

- **UserIdToDeviceIdMap**: A type alias for mapping user IDs to device IDs.
```

--------------------------------

### Kazv::Api::GetUrlPreviewJob Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1GetUrlPreviewJob-members.html

Constructs a new GetUrlPreviewJob object to fetch a URL preview.

```APIDOC
## Kazv::Api::GetUrlPreviewJob(std::string serverUrl, std::string _accessToken, std::string url, std::optional< std::int_fast64_t > ts=std::nullopt)

### Description
Initializes a job to get a preview of a given URL.

### Parameters
#### Path Parameters
- **serverUrl** (std::string) - Required - The base URL of the server.
- **_accessToken** (std::string) - Required - The authentication token.
- **url** (std::string) - Required - The URL to get a preview for.
- **ts** (std::optional<std::int_fast64_t>) - Optional - A timestamp for the request.
```

--------------------------------

### syncToken

Source: https://kazv.chat/libkazv/api/structKazv_1_1ClientModel-members.html

Gets or sets the synchronization token.

```APIDOC
## syncToken

### Description
Gets or sets the synchronization token.

### Method
GET/PUT (assumed)
```

--------------------------------

### Password Login and Sync

Source: https://kazv.chat/libkazv/api/md_tutorials_2tutorial0.html

Logs in using password credentials and starts the synchronization process. Handles login success or failure, and dispatches a continuous sync action upon successful login.

```cpp
auto client = sdk.client();
client.passwordLogin(homeserver, username, password, deviceName)
.then([=](auto status) {
if (! status.success()) {
std::cerr << "Login failed" << std::endl;
std::exit(1);
}
client.startSyncing();
});
```

--------------------------------

### currentTimeMs

Source: https://kazv.chat/libkazv/api/namespaceKazv.html

Gets the current time in milliseconds.

```APIDOC
## Kazv::currentTimeMs()

### Description
Gets the current time in milliseconds.

### Returns
- Timestamp
```

--------------------------------

### FileDesc::name

Source: https://kazv.chat/libkazv/api/file-desc_8hpp_source.html

Gets the name of the file.

```APIDOC
## std::optional<std::string> FileDesc::name() const

### Description
Returns the name of the file if it is set.

### Returns
std::optional<std::string> - The file name, or std::nullopt if not set.
```

--------------------------------

### GetConfigJob Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1GetConfigJob.html

Initializes a new instance of the GetConfigJob class to fetch content repository configuration. Requires server URL and an access token.

```APIDOC
## GetConfigJob()

### Description
Initializes a new instance of the GetConfigJob class to fetch content repository configuration.

### Parameters
- **_serverUrl** (std::string) - The URL of the server.
- **__accessToken_** (std::string) - The access token for authentication.
```

--------------------------------

### pinnedEvents

Source: https://kazv.chat/libkazv/api/classKazv_1_1Room.html

Gets the pinned events of the room.

```APIDOC
## pinnedEvents

### Description
Get pinned events of this room.

### Method
(Implicitly a method call on a Room object)

### Parameters
None

### Response
- lager::reader< immer::flex_vector< std::string > >: A reader for a list of pinned event IDs.
```

--------------------------------

### makeClient

Source: https://kazv.chat/libkazv/api/namespacemembers_m.html

Factory function to create a client instance.

```APIDOC
## makeClient()

### Description
Factory function to create a client instance.

### Method
(Not specified, likely a function call)

### Endpoint
(Not applicable)

### Parameters
(None specified)

### Request Example
(Not applicable)

### Response
- **return value** (Kazv::Factory) - The created client factory.
```

--------------------------------

### GetConfigJob

Source: https://kazv.chat/libkazv/api/content-repo_8hpp.html

Gets the configuration for the content repository.

```APIDOC
## Kazv::Api::GetConfigJob

### Description
Get the configuration for the content repository.

### Typedefs
- `Kazv::Api::GetConfigResponse` is an alias for `GetConfigJob::JobResponse`.
```

--------------------------------

### JoinRoomJob Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1JoinRoomJob.html

Initializes a new instance of the JoinRoomJob class to start the requesting user participating in a particular room.

```APIDOC
## JoinRoomJob(std::string serverUrl, std::string _accessToken, std::string roomIdOrAlias, immer::array< std::string > serverName={}, std::optional< ThirdPartySigned > thirdPartySigned=std::nullopt, std::optional< std::string > reason=std::nullopt)

### Description
Start the requesting user participating in a particular room.

### Parameters
- **roomIdOrAlias** (std::string) - The room identifier or alias to join.
- **serverName** (immer::array< std::string >) - The servers to attempt to join the room through. One of the servers must be participating in the room.
- **thirdPartySigned** (std::optional< ThirdPartySigned >) - If a `third_party_signed` was supplied, the homeserver must verify that it matches a pending `m.room.third_party_invite` event in the room, and perform key validity checking if required by the event.
- **reason** (std::optional< std::string >) - Optional reason to be included as the `reason` on the subsequent membership event.
```

--------------------------------

### clientFromSecondaryRoot(lager::reader< ModelT > sr)

Source: https://kazv.chat/libkazv/api/classKazv_1_1Sdk-members.html

Creates a client from a secondary root reader.

```APIDOC
## clientFromSecondaryRoot(lager::reader< ModelT > sr)

### Description
Creates a client instance using a secondary root reader.

### Method
`const`

### Endpoint
N/A (Method call)

### Parameters
- **sr** (lager::reader< ModelT >) - The secondary root reader to use for client creation.

### Response
- Returns a client instance.
```

--------------------------------

### GetUrlPreviewJob

Source: https://kazv.chat/libkazv/api/content-repo_8hpp.html

Gets information about a URL for a client.

```APIDOC
## Kazv::Api::GetUrlPreviewJob

### Description
Get information about a URL for a client.

### Typedefs
- `Kazv::Api::GetUrlPreviewResponse` is an alias for `GetUrlPreviewJob::JobResponse`.
```

--------------------------------

### Kazv::BaseJob Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1BaseJob-members.html

Initializes a new instance of the BaseJob class with specified server and request details, including method, job ID, token, return type, body, query, header, and optional response file description.

```APIDOC
## BaseJob Constructor

### Description
Initializes a new instance of the BaseJob class.

### Parameters
- **serverUrl** (std::string) - The URL of the server.
- **requestUrl** (std::string) - The URL for the request.
- **method** (Method) - The HTTP method for the request.
- **jobId** (std::string) - The unique identifier for the job.
- **token** (std::string, optional) - The authentication token. Defaults to an empty string.
- **returnType** (ReturnType, optional) - The expected return type of the job. Defaults to ReturnType::Json.
- **body** (Body, optional) - The request body. Defaults to EmptyBody.
- **query** (Query, optional) - The query parameters. Defaults to an empty Query.
- **header** (Header, optional) - The request headers. Defaults to an empty Header.
- **responseFile** (std::optional<FileDesc>, optional) - Optional description for a response file. Defaults to std::nullopt.
```

--------------------------------

### getVersions

Source: https://kazv.chat/libkazv/api/classKazv_1_1Client.html

Get all supported versions from a homeserver.

```APIDOC
## getVersions

### Description
Get all supported versions from a homeserver.

### Method
`getVersions(std::string homeserver)`

### Parameters
#### Path Parameters
- **homeserver** (std::string) - Required - The homeserver to query.

### Returns
`PromiseT` - A promise that resolves with the supported versions.
```

--------------------------------

### url()

Source: https://kazv.chat/libkazv/api/classKazv_1_1BaseJob.html

Gets the URL associated with the job.

```APIDOC
## ◆ url()

Gets the URL associated with the job.

### Method
const

### Returns
std::string
```

--------------------------------

### JoinRoomJob Constructor

Source: https://kazv.chat/libkazv/api/classKazv_1_1Api_1_1JoinRoomJob-members.html

Initializes a new instance of the JoinRoomJob class to join a specified room. It requires server URL, access token, and room identifier. Optional parameters include server name, third-party signed information, and a reason for joining.

```APIDOC
## JoinRoomJob Constructor

### Description
Initializes a new instance of the JoinRoomJob class to join a specified room. It requires server URL, access token, and room identifier. Optional parameters include server name, third-party signed information, and a reason for joining.

### Signature
JoinRoomJob(std::string serverUrl, std::string _accessToken, std::string roomIdOrAlias, immer::array< std::string > serverName={}, std::optional< ThirdPartySigned > thirdPartySigned=std::nullopt, std::optional< std::string > reason=std::nullopt)

### Parameters
- **serverUrl** (std::string) - The URL of the server to join.
- **_accessToken** (std::string) - The access token for authentication.
- **roomIdOrAlias** (std::string) - The ID or alias of the room to join.
- **serverName** (immer::array< std::string >, optional) - A list of server names to consider. Defaults to an empty array.
- **thirdPartySigned** (std::optional< ThirdPartySigned >, optional) - Optional third-party signed information.
- **reason** (std::optional< std::string >, optional) - An optional reason for joining the room.
```

--------------------------------

### LoginAction

Source: https://kazv.chat/libkazv/api/classKazv_1_1Client.html

Initiates the login process for a user.

```APIDOC
## LoginAction

### Description
Authenticates a user with the Matrix server.

### Method
Not specified, likely an SDK method call.

### Endpoint
Not applicable (SDK method).

### Parameters
- **username** (string) - Required - The user's username.
- **password** (string) - Required - The user's password.
- **deviceId** (string) - Optional - The ID of the device to use for login.
```

--------------------------------

### CGetWhoIsJob

Source: https://kazv.chat/libkazv/api/annotated.html

Gets information about a particular user.

```APIDOC
## CGetWhoIsJob

### Description
Gets information about a particular user.

### Method
GET (Assumed based on 'Get' prefix)

### Endpoint
/get_who_is (Assumed based on job name)

### Parameters
#### Query Parameters
- **user_id** (string) - Required - The ID of the user to get information about.
```

--------------------------------

### CGetUrlPreviewJob

Source: https://kazv.chat/libkazv/api/annotated.html

Get information about a URL for a client.

```APIDOC
## CGetUrlPreviewJob

### Description
Get information about a URL for a client.

### Method
GET (Assumed based on 'Get' prefix)

### Endpoint
/get_url_preview (Assumed based on job name)

### Parameters
#### Query Parameters
- **url** (string) - Required - The URL to get a preview for.
```

--------------------------------

### Constructors

Source: https://kazv.chat/libkazv/api/classKazv_1_1ContextBase-members.html

Constructors for creating instances of Kazv::ContextBase.

```APIDOC
## ContextBase(Func &&dispatcher, PromiseInterfaceT ph, Deps deps)

### Description
Constructs a Kazv::ContextBase object with the given dispatcher, promise interface, and dependencies.

### Method
Constructor

### Parameters
- **dispatcher** (Func &&) - Description
- **ph** (PromiseInterfaceT) - Description
- **deps** (Deps) - Description
```

```APIDOC
## ContextBase(const ContextBase< RetType, AnotherAction, AnotherDeps > &that)

### Description
Copy constructor for Kazv::ContextBase.

### Method
Constructor

### Parameters
- **that** (const ContextBase< RetType, AnotherAction, AnotherDeps > &) - Description
```

```APIDOC
## ContextBase(const ContextBase< RetType, AnotherAction, AnotherDeps > &that, Conv &&conv)

### Description
Constructs a Kazv::ContextBase object from another ContextBase with a conversion.

### Method
Constructor

### Parameters
- **that** (const ContextBase< RetType, AnotherAction, AnotherDeps > &) - Description
- **conv** (Conv &&) - Description
```

--------------------------------

### Client Perform with GetRoomStatesAction

Source: https://kazv.chat/libkazv/api/namespaceKazv.html

Performs a client operation using a ClientModel and a GetRoomStatesAction.

```cpp
BaseJob Kazv::clientPerform  | ( | ClientModel | _m_ , 
  GetRoomStatesAction | _a_ 
)
```

--------------------------------

### CGetRoomVisibilityOnDirectoryJob

Source: https://kazv.chat/libkazv/api/annotated.html

Gets the visibility of a room in the directory.

```APIDOC
## CGetRoomVisibilityOnDirectoryJob

### Description
Gets the visibility of a room in the directory.

### Method
GET

### Endpoint
/api/v1/directory/room/{roomAlias}/visibility
```

--------------------------------

### CGetRoomEventsJob

Source: https://kazv.chat/libkazv/api/annotated.html

Get a list of events for this room.

```APIDOC
## CGetRoomEventsJob

### Description
Get a list of events for this room.

### Method
GET

### Endpoint
/api/v1/rooms/{roomId}/events
```

--------------------------------

### DumbFileProvider Constructor

Source: https://kazv.chat/libkazv/api/structKazv_1_1DumbFileProvider-members.html

Initializes a new instance of the DumbFileProvider class with the provided file content.

```APIDOC
## DumbFileProvider(FileContent content)

### Description
Constructs a new DumbFileProvider instance.

### Method
constructor

### Parameters
#### Path Parameters
- **content** (FileContent) - Description of the file content to be used.
```

--------------------------------

### CGetMembersByRoomJob

Source: https://kazv.chat/libkazv/api/annotated.html

Get the m.room.member events for the room.

```APIDOC
## CGetMembersByRoomJob

### Description
Get the m.room.member events for the room.

### Method
GET

### Endpoint
/api/v1/rooms/{roomId}/members
```

--------------------------------

### GetUrlPreviewJob Constructor

Source: https://kazv.chat/libkazv/api/content-repo_8hpp_source.html

Constructs a GetUrlPreviewJob with server URL, access token, and an optional timestamp.

```cpp
explicit GetUrlPreviewJob(std::string serverUrl
, std::string _accessToken
,
std::string url , std::optional<std::int_fast64_t> ts = std::nullopt
);
```

--------------------------------

### ContextBase Constructor (Dispatcher, Promise Interface, Dependencies)

Source: https://kazv.chat/libkazv/api/context_8hpp_source.html

Constructor for ContextBase that initializes the dispatcher, promise interface, and dependencies.

```cpp
template<class Func>
ContextBase(Func &&dispatcher, PromiseInterfaceT ph, Deps deps)
: Deps(std::move(deps))
, m_ph(ph)
, m_dispatcher(std::forward<Func>(dispatcher))
{
}
```

--------------------------------

### CGetConfigJob

Source: https://kazv.chat/libkazv/api/annotated.html

Get the configuration for the content repository.

```APIDOC
## CGetConfigJob

### Description
Get the configuration for the content repository.

### Method
GET

### Endpoint
/api/v1/config
```

--------------------------------

### Namespace Variables (o)

Source: https://kazv.chat/libkazv/api/namespacemembers_vars.html

Variables starting with 'o' in the libkazv namespace.

```APIDOC
## Namespace Variables (o)

### Description
Variables starting with 'o' in the libkazv namespace.

### Variables
- **olmAlgo** (Kazv::CryptoConstants)
```

--------------------------------

### makeClient

Source: https://kazv.chat/libkazv/api/namespacemembers_func_m.html

Creates a Kazv client instance. This is likely a factory method for initializing a client object.

```APIDOC
## makeClient()

### Description
Creates a Kazv client instance.

### Returns
Kazv::Factory - The created client factory.
```
Tokens:
Raw