sbILocalDatabasePropertyCache Interface Reference

[USER CODE SHOULD NOT REFERENCE THIS CLASS] More...

import"sbILocalDatabasePropertyCache.idl";

Inheritance diagram for sbILocalDatabasePropertyCache:

Collaboration diagram for sbILocalDatabasePropertyCache:

Public Member Functions
void	getProperties ([array, size_is(aGUIDArrayCount)] in wstring aGUIDArray, in unsigned long aGUIDArrayCount, out unsigned long aPropertyArrayCount, [retval, array, size_is(aPropertyArrayCount)] out sbILocalDatabaseResourcePropertyBag aPropertyArray)
void	setProperties ([array, size_is(aGUIDArrayCount)] in wstring aGUIDArray, in unsigned long aGUIDArrayCount, [array, size_is(aPropertyArrayCount)] in sbILocalDatabaseResourcePropertyBag aPropertyArray, in unsigned long aPropertyArrayCount, in boolean aWriteThroughNow)
void	cacheProperties ([array, size_is(aGUIDArrayCount)] in wstring aGUIDArray, in unsigned long aGUIDArrayCount)
void	write ()
unsigned long	getPropertyDBID (in AString aPropertyID)
sbIJobProgress	invalidateSortData ()
void	addDependentGUIDArray (in sbLocalDatabaseGUIDArrayPtr aGUIDArray)
	Add a dependent GUID Array. More...
void	removeDependentGUIDArray (in sbLocalDatabaseGUIDArrayPtr aGUIDArray)
	Remove a dependent GUID Array. More...

Public Attributes
readonly attribute boolean	writePending

Detailed Description

[USER CODE SHOULD NOT REFERENCE THIS CLASS]

Definition at line 48 of file sbILocalDatabasePropertyCache.idl.

Member Function Documentation

void sbILocalDatabasePropertyCache::addDependentGUIDArray

(

in sbLocalDatabaseGUIDArrayPtr

aGUIDArray

)

Add a dependent GUID Array.

Note

[USER CODE SHOULD NEVER USE THIS METHOD]

void sbILocalDatabasePropertyCache::cacheProperties	(	[array, size_is(aGUIDArrayCount)] in wstring	aGUIDArray,
		in unsigned long	aGUIDArrayCount
	)

void sbILocalDatabasePropertyCache::getProperties	(	[array, size_is(aGUIDArrayCount)] in wstring	aGUIDArray,
		in unsigned long	aGUIDArrayCount,
		out unsigned long	aPropertyArrayCount,
		[retval, array, size_is(aPropertyArrayCount)] out sbILocalDatabaseResourcePropertyBag	aPropertyArray
	)

unsigned long sbILocalDatabasePropertyCache::getPropertyDBID

(

in AString

aPropertyID

)

sbIJobProgress sbILocalDatabasePropertyCache::invalidateSortData

(

)

Used to rebuild all sortable and secondary sortable data in the library. Should be called any time the GetSecondarySort or MakeSortable functions of an sbIPropertyInfo implementation are changed.

See Bug 12677 – "[sorting] cached sortable values should auto-invalidate when property implementations change"

Example: var mainLibrary = Cc["@songbirdnest.com/Songbird/library/Manager;1"] .getService(Ci.sbILibraryManager).mainLibrary; var cache = mainLibrary.QueryInterface(Ci.sbILocalDatabaseLibrary) .propertyCache; Components.utils.import("resource://app/jsmodules/SBJobUtils.jsm"); SBJobUtils.showProgressDialog(cache.invalidateSortData(), null, 0);

void sbILocalDatabasePropertyCache::removeDependentGUIDArray

(

in sbLocalDatabaseGUIDArrayPtr

aGUIDArray

)

Remove a dependent GUID Array.

Note

[USER CODE SHOULD NEVER USE THIS METHOD]

void sbILocalDatabasePropertyCache::setProperties	(	[array, size_is(aGUIDArrayCount)] in wstring	aGUIDArray,
		in unsigned long	aGUIDArrayCount,
		[array, size_is(aPropertyArrayCount)] in sbILocalDatabaseResourcePropertyBag	aPropertyArray,
		in unsigned long	aPropertyArrayCount,
		in boolean	aWriteThroughNow
	)

void sbILocalDatabasePropertyCache::write

(

)

Member Data Documentation

readonly attribute boolean sbILocalDatabasePropertyCache::writePending

Definition at line 50 of file sbILocalDatabasePropertyCache.idl.

---

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

• /home/martin/dev/nightingale-hacking/components/library/localdatabase/public/sbILocalDatabasePropertyCache.idl