gem::ContentUpdater Class Reference

ContentUpdater object. More...

Inheritance diagram for gem::ContentUpdater:

Collaboration diagram for gem::ContentUpdater:

Public Member Functions
	ContentUpdater (const ContentUpdater &)=delete
	ContentUpdater (ContentUpdater &&)=default
	Default move constructor noexcept is deduced.
ContentUpdater &	operator= (const ContentUpdater &)=delete
ContentUpdater &	operator= (ContentUpdater &&cu)=default
	Default move assignment noexcept is deduced.
int	update (bool allowChargeNetwork, ProgressListener listener, EDataSavePolicy savePolicy=UseDefault) noexcept
	Start / resume the update process.
ContentStoreItemList	getItems () const noexcept
	Get the content items list in update process.
int	getContentType () const noexcept
	Get content type in update process.
EContentUpdaterStatus	getStatus () const noexcept
	Get update operation status.
int	getProgress () const noexcept
	Get update operation progress.
bool	canApply () const noexcept
	Check if content update can be applied.
int	apply () noexcept
	Apply content update.
void	cancel () noexcept
	Cancel content update.
bool	isStarted () const noexcept
	Check if content updater is started.

Detailed Description

ContentUpdater object.

Provides functionality to update existing content in the background.

Implements share read/write Api object over IContentUpdater.

Member Function Documentation

apply()

int gem::ContentUpdater::apply ( )

inlinenoexcept

Apply content update.

Returns

KNoError on success

canApply()

bool gem::ContentUpdater::canApply ( ) const

inlinenoexcept

Check if content update can be applied.

Returns

True if can be applied

getContentType()

int gem::ContentUpdater::getContentType ( ) const

inlinenoexcept

Get content type in update process.

See EContentType enum for possible values

Returns

Content type

getItems()

ContentStoreItemList gem::ContentUpdater::getItems ( ) const

inlinenoexcept

Get the content items list in update process.

Returns

Content list

getProgress()

int gem::ContentUpdater::getProgress ( ) const

inlinenoexcept

Get update operation progress.

progress values are calculated with respect to ProgressListener::GetProgressMultiplier

Returns

Progress value

getStatus()

EContentUpdaterStatus gem::ContentUpdater::getStatus ( ) const

inlinenoexcept

Get update operation status.

Returns

Content updater status

isStarted()

bool gem::ContentUpdater::isStarted ( ) const

inlinenoexcept

Check if content updater is started.

Returns

True if started

operator=()

ContentUpdater & gem::ContentUpdater::operator= ( ContentUpdater && cu )

default

Default move assignment noexcept is deduced.

Returns

ContentUpdater object reference

Parameters

cu	ContentUpdater object

update()

int gem::ContentUpdater::update ( bool allowChargeNetwork, ProgressListener listener, EDataSavePolicy savePolicy = UseDefault )

inlinenoexcept

Start / resume the update process.

Returns

KNoError on success

Parameters

allowChargeNetwork	Allow charging network
listener	Progress listener
savePolicy	Specify where updated data will be stored. Default is UseDefault meaning the savePolicy from SDK::initialize will be used