api_result_types.h File Reference

Types which are used to return values in api client. More...

#include <optional>
#include <ostream>
#include <string>
#include <string_view>
#include <variant>
#include <vector>
#include "./result.h"

Include dependency graph for api_result_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	octane::HealthResult
	Structure used as result for health, has the server's status and message. More...
struct	octane::Response
	Structure used/inherited in various methods of ApiClient, has the server's status. More...
struct	octane::Device
	Structure used in RoomStatus's devices, has the information of each device connected to the room. More...
struct	octane::RoomStatus
	Structure used as result for getRoomStatus, has the status of the room and inherits Response. More...
struct	octane::ContentStatus
	Structure used in Content, has the status of Content. More...
struct	octane::FileInfo
struct	octane::Content
	Structure used as result for getContent, has data and ContentStatus and inherits Response. More...
struct	octane::RoomId
	Structure used as result for createRoom, has the room id and inherits Response. More...

Namespaces
namespace	octane

Enumerations
enum struct	octane::Health { octane::Healthy , octane::Degraded , octane::Faulty }
	Enum used in HealthResult, represents the server's status. More...
enum struct	octane::ContentType { octane::File , octane::Clipboard , octane::MultiFile }
	Enum used in ContentStatus, represents the type of Content. More...

Functions
bool	octane::operator== (const HealthResult &a, const HealthResult &b)
std::ostream &	octane::operator<< (std::ostream &stream, const HealthResult &healthResult)
bool	octane::operator== (const RoomStatus &a, const RoomStatus &b)
std::ostream &	octane::operator<< (std::ostream &stream, const RoomStatus &roomStatus)
bool	octane::operator== (const ContentStatus &a, const ContentStatus &b)
std::ostream &	octane::operator<< (std::ostream &stream, const ContentStatus &contentStatus)
bool	octane::operator== (const RoomId &a, const RoomId &b)
std::ostream &	octane::operator<< (std::ostream &stream, const RoomId &roomId)

Detailed Description

Types which are used to return values in api client.

Author

soon (kento.nosp@m..soo.nosp@m.n@gma.nosp@m.il.c.nosp@m.om)

Version

0.1

Date

2022-09-01

Copyright

Copyright (c) 2022