gem::SocialLabelsOverlayInfo Class Reference

SocialLabelsOverlayInfo object. More...

Inheritance diagram for gem::SocialLabelsOverlayInfo:

Collaboration diagram for gem::SocialLabelsOverlayInfo:

Public Member Functions
	SocialLabelsOverlayInfo (const SocialLabelsOverlayInfo &)=delete
	Deleted copy constructor.
	SocialLabelsOverlayInfo (SocialLabelsOverlayInfo &&social)=default
	Default move constructor noexcept is deduced.
SocialLabelsOverlayInfo &	operator= (const SocialLabelsOverlayInfo &)=delete
	Deleted copy assignment.
SocialLabelsOverlayInfo &	operator= (SocialLabelsOverlayInfo &&social)=default
	Default move assignment noexcept is deduced.
LargeInteger	getLoginUserUid () const noexcept
	Get user login uid.
String	getLoginUserName () const noexcept
	Get user login unique name.
int	getUid () const noexcept
	Get the unique ID of the overlay.
const StringRef	getName () const noexcept
	Get the name of the overlay.
const ImageRef	getImage () const noexcept
	Get the image of the overlay.
OverlayCategoryList	getCategories () const noexcept
	Get the overlay categories.
OverlayCategory	getCategory (int categId) const noexcept
	Get the overlay category by id.
bool	hasCategories (int categId) const noexcept
	Check if category has subcategories.

Detailed Description

SocialLabelsOverlayInfo object.

Implements share-read / copy-on-write Api object over ISocialLabelsOverlayInfo.

Constructor & Destructor Documentation

SocialLabelsOverlayInfo()

gem::SocialLabelsOverlayInfo::SocialLabelsOverlayInfo ( SocialLabelsOverlayInfo && social )

default

Default move constructor noexcept is deduced.

Parameters

[in]

social

The object to move

Member Function Documentation

getCategories()

OverlayCategoryList gem::OverlayInfo::getCategories ( ) const

inlinenoexceptinherited

Get the overlay categories.

Returns

Empty if no categories are available

getCategory()

OverlayCategory gem::OverlayInfo::getCategory ( int categId ) const

inlinenoexceptinherited

Get the overlay category by id.

Parameters

categId

The category id

Returns

Empty if no category is found

getImage()

const ImageRef gem::OverlayInfo::getImage ( ) const

inlinenoexceptinherited

Get the image of the overlay.

Returns

empty if image is not available

getLoginUserName()

String gem::SocialLabelsOverlayInfo::getLoginUserName ( ) const

inlinenoexcept

Get user login unique name.

Returns

User name

getLoginUserUid()

LargeInteger gem::SocialLabelsOverlayInfo::getLoginUserUid ( ) const

inlinenoexcept

Get user login uid.

Returns

User unique id

If user is not logged in, 0 is returned

getName()

const StringRef gem::OverlayInfo::getName ( ) const

inlinenoexceptinherited

Get the name of the overlay.

Returns

The overlay name

getUid()

int gem::OverlayInfo::getUid ( ) const

inlinenoexceptinherited

Get the unique ID of the overlay.

Returns

The overlay ID

hasCategories()

bool gem::OverlayInfo::hasCategories ( int categId ) const

inlinenoexceptinherited

Check if category has subcategories.

Returns

True if category has subcategories, false otherwise

Parameters

categId

The category id

operator=()

SocialLabelsOverlayInfo & gem::SocialLabelsOverlayInfo::operator= ( SocialLabelsOverlayInfo && social )

default

Default move assignment noexcept is deduced.

Parameters

[in]

social

The object to move

Returns

The moved object