sbIWatchFolder Interface Reference

import"sbIWatchFolder.idl";

Inheritance diagram for sbIWatchFolder:

Collaboration diagram for sbIWatchFolder:

Public Member Functions
void	addIgnorePath (in AString aFilePath)
	Add a absolute file path to be ignored by the watch folder service. This path will be ignored until it is removed via a call to |removeIgnorePath()|. Each call to |addIgnorePath()| should be balanced by a call to |removeIgnorePath()|. When used in conjunction with |addIgnoreCount()|, the count will be decremented as normal when the path is ignored. The path will continue to be ignored when the count reaches zero. More...
void	removeIgnorePath (in AString aFilePath)
	Remove an absolute file path from the ignored paths list of the watch folder service. All future events at the specified path will be processed by the watch folders service. When used in conjunction with |addIgnoreCount()|, any remaining events specified by the count will still be ignored. More...
void	addIgnoreCount (in AString aFilePath, in long aCount)
	Add an absolute file path to be ignore by the watch folder service. This path will be ignored for the given number of events, which includes file addition, deletion, or change. When used in conjunction with |addIgnorePath()| and |removeIgnorPath()|, the counter will be decremented as events are ignored. The path may continue to be ignored after the count reaches zero if any calls to |addIgnorePath()| are not balanced by calls to |removeIgnorePath()|. More...
void	start (in ACString aSessionGuid)
	Starts watching. More...
ACString	stop ()
	Stops watching. More...
void	setFolder (in AString aPath, in boolean aSynchronizeMediaList)

Public Attributes
attribute sbIMediaList	mediaList
readonly attribute AString	path
attribute sbIDirectoryImportService	importer
attribute sbIMediacoreTypeSniffer	typeSniffer
attribute sbIFileMetadataService	metadataScanner
attribute boolean	canInteract
readonly attribute boolean	isSupported
readonly attribute boolean	isRunning

Detailed Description

Definition at line 37 of file sbIWatchFolder.idl.

Member Function Documentation

void sbIWatchFolder::addIgnoreCount	(	in AString	aFilePath,
		in long	aCount
	)

Add an absolute file path to be ignore by the watch folder service. This path will be ignored for the given number of events, which includes file addition, deletion, or change. When used in conjunction with |addIgnorePath()| and |removeIgnorPath()|, the counter will be decremented as events are ignored. The path may continue to be ignored after the count reaches zero if any calls to |addIgnorePath()| are not balanced by calls to |removeIgnorePath()|.

Parameters

aFilePath	The absolute path to ignore.
aCount	The number of times to ignore events for the given path. Passing in zero will have no effect. Passing in a negative number will decrement the previously recorded count. Attempts to decrement the count below zero will be silently clamped to zero.

void sbIWatchFolder::addIgnorePath

(

in AString

aFilePath

)

Add a absolute file path to be ignored by the watch folder service. This path will be ignored until it is removed via a call to |removeIgnorePath()|. Each call to |addIgnorePath()| should be balanced by a call to |removeIgnorePath()|. When used in conjunction with |addIgnoreCount()|, the count will be decremented as normal when the path is ignored. The path will continue to be ignored when the count reaches zero.

Parameters

aFilePath

The absolute path to start ignoring.

void sbIWatchFolder::removeIgnorePath

(

in AString

aFilePath

)

Remove an absolute file path from the ignored paths list of the watch folder service. All future events at the specified path will be processed by the watch folders service. When used in conjunction with |addIgnoreCount()|, any remaining events specified by the count will still be ignored.

Parameters

aFilePath

The absolute path to stop ignoring.

void sbIWatchFolder::setFolder	(	in AString	aPath,
		in boolean	aSynchronizeMediaList
	)

void sbIWatchFolder::start

(

in ACString

aSessionGuid

)

Starts watching.

Parameters

aSessionGuid

An empty string or a string previously returned by stop(). If valid, the specified watch session resumes. Otherwise, start() begins a new watch session.

Todo:

sbWatchFolderService will set aSessionGuid from PREF_WATCHFOLDER_SESSIONGUID

ACString sbIWatchFolder::stop

(

)

Stops watching.

Returns

A session GUID. The GUID can be saved and later passed to start() to resume the stopped watch session.

Todo:

sbWatchFolderService will save the result in PREF_WATCHFOLDER_SESSIONGUID

Member Data Documentation

attribute boolean sbIWatchFolder::canInteract

Todo:

sbWatchFolderService will set this flag where it currently calls GetIsUnitTestsRunning(). canInteract == !GetIsUnitTestsRunning()

Definition at line 55 of file sbIWatchFolder.idl.

attribute sbIDirectoryImportService sbIWatchFolder::importer

Definition at line 47 of file sbIWatchFolder.idl.

readonly attribute boolean sbIWatchFolder::isRunning

Definition at line 69 of file sbIWatchFolder.idl.

readonly attribute boolean sbIWatchFolder::isSupported

Definition at line 62 of file sbIWatchFolder.idl.

attribute sbIMediaList sbIWatchFolder::mediaList

Todo:

sbWatchFolderService will set this where it currently handles PREF_WATCHFOLDER_ENABLE. Enabled => main library, disabled => null

Definition at line 42 of file sbIWatchFolder.idl.

attribute sbIFileMetadataService sbIWatchFolder::metadataScanner

Definition at line 51 of file sbIWatchFolder.idl.

readonly attribute AString sbIWatchFolder::path

Todo:

sbWatchFolderService will initialize this from PREF_WATCHFOLDER_PATH

Definition at line 45 of file sbIWatchFolder.idl.

attribute sbIMediacoreTypeSniffer sbIWatchFolder::typeSniffer

Definition at line 49 of file sbIWatchFolder.idl.

---

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

• /home/martin/dev/nightingale-hacking/components/watchfolder/public/sbIWatchFolder.idl