CompactableAssetRepositoryInterface Class Reference

#include <assets.h>

Inheritance diagram for CompactableAssetRepositoryInterface:

Detailed Description

Repository which allows to write an index.

Public Member Functions

MAXON_METHOD Result< void > Compact ()
 
MAXON_METHOD Result< void > DeleteIndexFiles ()
 
MAXON_METHOD Result< void > CompactInBackground (const TimeValue &delay, const BackgroundProgressRef &backgroundJob)
 
MAXON_METHOD REPOSITORYINDEXSTATE GetIndexState ()
 

Private Member Functions

 MAXON_INTERFACE (CompactableAssetRepositoryInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.compactableassetrepository", MAXON_IMPLEMENTATION_MODULE("net.maxon.asset"))
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( CompactableAssetRepositoryInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.interface.compactableassetrepository"  ,
MAXON_IMPLEMENTATION_MODULE("net.maxon.asset")   
)
private

◆ Compact()

MAXON_METHOD Result<void> Compact ( )

Compact generates an index for a repository.

Returns
OK on success.

◆ DeleteIndexFiles()

MAXON_METHOD Result<void> DeleteIndexFiles ( )

DeleteIndexFiles removes all index files.

Returns
OK on success.

◆ CompactInBackground()

MAXON_METHOD Result<void> CompactInBackground ( const TimeValue delay,
const BackgroundProgressRef &  backgroundJob 
)

Compact generates an index for a repository in a async background job. param[in] delay Optional delay after which time the compact should run. TimeValue() to run immediatly. param[in] backgroundJob Optional backgroundJob to use given job. Nullptr to create a backgroundjob internally.

Returns
OK on success.

◆ GetIndexState()

GetIndexState returns the state of the database index.