nx_server_plugin_sdk  1.0
Server Plugin SDK
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
nx::sdk::cloud_storage::Bookmark Struct Reference

#include <data.h>

Public Member Functions

 Bookmark (const char *jsonData) noexcept(false)
 
 Bookmark (const nx::kit::Json &json) noexcept(false)
 
template<typename T >
 Bookmark (const T &)=delete
 
bool operator== (const Bookmark &) const
 
nx::kit::Json to_json () const
 

Static Public Member Functions

static ValueOrError< BookmarkfromJson (const char *jsonStr) noexcept
 
static ValueOrError< BookmarkfromJson (const nx::kit::Json &json) noexcept
 

Public Attributes

std::string id
 
std::string creatorId
 
std::chrono::milliseconds creationTimestamp {}
 
std::string name
 
std::string description
 
std::chrono::milliseconds timeout = std::chrono::milliseconds(-1)
 
std::chrono::milliseconds startTimestamp {}
 
std::chrono::milliseconds duration {}
 
std::vector< std::string > tags
 
std::string deviceId
 

Detailed Description

Bookmark object passed to the plugin when a bookmark is saved. And the same object should be returned to the Server when queried back if it matches the filter. The plugin should keep bookmarks as is, without any changes.

Member Data Documentation

◆ creatorId

std::string nx::sdk::cloud_storage::Bookmark::creatorId

User that created this bookmark id.

◆ id

std::string nx::sdk::cloud_storage::Bookmark::id

Bookmark unique id.


The documentation for this struct was generated from the following files: