SDK  2.1.4 [async]
CloudBackend Software Development Kit - SDK API for C++
cbe::Subscribe Class Reference

Managing a subscribed Item. More...

#include <Subscribe.h>

Public Member Functions

cbe::Date getDate () const
 
std::string getTitle () const
 
std::string getDescription () const
 
std::string getPassword () const
 
cbe::PublishAccess getSecurity () const
 
cbe::PublishVisibility getPrivacy () const
 
cbe::SubscribeId getSubscribeId () const
 
cbe::PublishId getPublishId () const
 
cbe::UserId getOwner () const
 
void unSubscribe ()
 
 Subscribe (cbe::DefaultCtor)
 
 operator bool () const
 

Friends

class CloudBackend
 
class Item
 

Detailed Description

Managing a subscribed Item.

To inspect the settings of a subscription.

Member Function Documentation

◆ getDate()

cbe::Date cbe::Subscribe::getDate ( ) const

Gets the date as unix epoch number

◆ getDescription()

std::string cbe::Subscribe::getDescription ( ) const

Gets the description

◆ getOwner()

cbe::UserId cbe::Subscribe::getOwner ( ) const

Gets the owner id number

◆ getPassword()

std::string cbe::Subscribe::getPassword ( ) const

Checks if a password has been set.

Returns
"true" : if a password has been set
"" : empty string if not.

◆ getPrivacy()

cbe::PublishVisibility cbe::Subscribe::getPrivacy ( ) const

Gets the privacy see cbe::PublishVisibility enum

◆ getPublishId()

cbe::PublishId cbe::Subscribe::getPublishId ( ) const

Gets the publish id number

◆ getSecurity()

cbe::PublishAccess cbe::Subscribe::getSecurity ( ) const

Gets the security see cbe::PublishAccess enum

◆ getSubscribeId()

cbe::SubscribeId cbe::Subscribe::getSubscribeId ( ) const

Gets the subscribe id number

◆ getTitle()

std::string cbe::Subscribe::getTitle ( ) const

Gets the title

◆ unSubscribe()

void cbe::Subscribe::unSubscribe ( )

unSubscribe to this subscription.


The documentation for this class was generated from the following file: