cbe::Publish Class Reference

Managing a published Item. More...

#include <Publish.h>

Public Member Functions
void	setTitle (const std::string &title)
	Set the Title of this publication. More...
void	setSecurity (cbe::PublishAccess security)
	Set the Security of this publication. More...
void	setPrivacy (cbe::PublishVisibility privacy)
	Set the Privacy of this publication. More...
void	setPassword (const std::string &password)
	Set the Password of this publication. More...
void	setDescription (const std::string &description)
	Set the Description of this publication. More...
std::string	getTitle () const
cbe::PublishAccess	getSecurity () const
cbe::PublishVisibility	getPrivacy () const
std::string	getPassword () const
std::string	getDescription () const
cbe::PublishId	getPublishId () const
	Publish (cbe::DefaultCtor)
	Default constructor. More...
	operator bool () const
	Checks if the current instance is real. More...

Friends
class	CloudBackend
class	Item

Detailed Description

Managing a published Item.

Constructor & Destructor Documentation

Publish()

cbe::Publish::Publish

(

cbe::DefaultCtor

)

Default constructor.

Construct a new object with the DefaultCtor to enable the operator bool() test

Member Function Documentation

getDescription()

std::string cbe::Publish::getDescription

(

)

const

Gets the description

getPassword()

std::string cbe::Publish::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::Publish::getPrivacy

(

)

const

Gets the privacy setting, see cbe::PublishVisibility enum

getPublishId()

cbe::PublishId cbe::Publish::getPublishId

(

)

const

Gets the publish id number

getSecurity()

cbe::PublishAccess cbe::Publish::getSecurity

(

)

const

Gets the security setting, see cbe::PublishAccess enum

getTitle()

std::string cbe::Publish::getTitle

(

)

const

Gets the title

operator bool()

cbe::Publish::operator bool ( ) const

explicit

Checks if the current instance is real.

An "unreal" instance implies typically a failed event.

Relies on the Default constructor Publish(cbe::DefaultCtor)

Returns

true : is real

false : unreal; got nullptr; if current instance is unbound/undefined. I.e., if it is only default constructed.

setDescription()

void cbe::Publish::setDescription

(

const std::string &

description

)

Set the Description of this publication.

Parameters

description

free text

setPassword()

void cbe::Publish::setPassword

(

const std::string &

password

)

Set the Password of this publication.

Parameters

password

text

setPrivacy()

void cbe::Publish::setPrivacy

(

cbe::PublishVisibility

privacy

)

Set the Privacy of this publication.

Parameters

privacy

of type cbe::PublishVisibility enum

setSecurity()

void cbe::Publish::setSecurity

(

cbe::PublishAccess

security

)

Set the Security of this publication.

Parameters

security

of type cbe::PublishAccess enum

setTitle()

void cbe::Publish::setTitle

(

const std::string &

title

)

Set the Title of this publication.

Parameters

title

name

---

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

• include/cbe/Publish.h