SmartFoldersAPI
Defined in: namespaces.ts:974
Methods
Section titled “Methods”registerFilterType()
Section titled “registerFilterType()”registerFilterType(
options):Promise<string>
Defined in: namespaces.ts:976
Registers a plugin-contributed filter type.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<string>
getSmartFolders()
Section titled “getSmartFolders()”getSmartFolders():
Promise<SmartFolderDescriptor[]>
Defined in: namespaces.ts:978
Returns all defined smart folders.
Returns
Section titled “Returns”Promise<SmartFolderDescriptor[]>
evaluateFilter()
Section titled “evaluateFilter()”evaluateFilter(
folderId,items):Promise<FilterEvalResult[]>
Defined in: namespaces.ts:980
Evaluates plugin-contributed filter types against a list of items.
Parameters
Section titled “Parameters”folderId
Section titled “folderId”string
Returns
Section titled “Returns”Promise<FilterEvalResult[]>
onSmartFolderEvaluated()
Section titled “onSmartFolderEvaluated()”onSmartFolderEvaluated(
callback):Promise<string>
Defined in: namespaces.ts:982
Registers a callback fired after each evaluateFilter call.
Parameters
Section titled “Parameters”callback
Section titled “callback”(payload) => void
Returns
Section titled “Returns”Promise<string>
offSmartFolderEvaluated()
Section titled “offSmartFolderEvaluated()”offSmartFolderEvaluated(
token):Promise<void>
Defined in: namespaces.ts:984
Removes a callback registered via onSmartFolderEvaluated.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>