import"sbIWatchFolderService.idl";
|
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...
|
|
Definition at line 30 of file sbIWatchFolderService.idl.
void sbIWatchFolderService::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 sbIWatchFolderService::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 sbIWatchFolderService::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. |
readonly attribute boolean sbIWatchFolderService::isRunning |
readonly attribute boolean sbIWatchFolderService::isSupported |
The documentation for this interface was generated from the following file: