gem::SocialReportsOverlayInfo Class Reference

SocialReportsOverlayInfo object. More...

Inheritance diagram for gem::SocialReportsOverlayInfo:

Collaboration diagram for gem::SocialReportsOverlayInfo:

Public Member Functions
	SocialReportsOverlayInfo (const SocialReportsOverlayInfo &social)=delete
	Deleted copy constructor.
	SocialReportsOverlayInfo (SocialReportsOverlayInfo &&social)=default
	Default move constructor noexcept is deduced.
SocialReportsOverlayInfo &	operator= (const SocialReportsOverlayInfo &social)=delete
	Deleted copy assignment.
SocialReportsOverlayInfo &	operator= (SocialReportsOverlayInfo &&social)=default
	Default move assignment noexcept is deduced.
SocialReportsOverlayCategoryList	getCategories (const String &country) const noexcept
	Get categories list.
SocialReportsOverlayCategory	getCategory (int categId, const String &country) const noexcept
	Get the overlay category by id.
OverlayCategory	getCategory (int categId) const noexcept
	Get the overlay category by id.
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.
bool	hasCategories (int categId) const noexcept
	Check if category has subcategories.

Detailed Description

SocialReportsOverlayInfo object.

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

Constructor & Destructor Documentation

SocialReportsOverlayInfo()

gem::SocialReportsOverlayInfo::SocialReportsOverlayInfo ( SocialReportsOverlayInfo && social )

default

Default move constructor noexcept is deduced.

Parameters

[in]

social

The object to move

Member Function Documentation

getCategories() [1/2]

OverlayCategoryList gem::OverlayInfo::getCategories ( ) const

inlinenoexceptinherited

Get the overlay categories.

Returns

Empty if no categories are available

getCategories() [2/2]

SocialReportsOverlayCategoryList gem::SocialReportsOverlayInfo::getCategories ( const String & country ) const

inlinenoexcept

Get categories list.

Parameters

[in]

country

The country ISO code for which the list is retrieved. Use empty String() for generic country

Returns

The categories list

getCategory() [1/2]

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

inlinenoexcept

Get the overlay category by id.

Parameters

categId

The category id

Returns

Empty if no category is found

getCategory() [2/2]

SocialReportsOverlayCategory gem::SocialReportsOverlayInfo::getCategory ( int categId, const String & country ) const

inlinenoexcept

Get the overlay category by id.

Parameters

[in]	categId	The category id
[in]	country	The country ISO code for which the list is retrieved. Use empty String() for generic country

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

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=()

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

default

Default move assignment noexcept is deduced.

Parameters

[in]

social

The object to move

Returns

The moved object