Note
This API has been available since API level 11.
This API has been available since API level 11.
com.webos.service.filecache
API Summary
This service enables you to manage caching of files. It implements the global shared cache space, which webOS applications (such as Email) can use to temporary store cache files or send files to other webOS applications.
Overview of the API
On the system level, the File Cache service is a daemon that starts after the webOS boots. It is responsible for caching filesystem requests, enabling to improve the performance of I/O operations and to save space on the the flash storage device.
You can configure the File Cache service behavior by calling its methods or by editing the options in the FileCache.conf file. In particular, you can:
- specify the global shared cache space
- configure space and object parameters
- specify automatic expiration options or select to control expiration manually.
The default setting of the FileCache.conf file is:
- totalCacheSpace 104857600 (100 MiB)
Methods
ChangeType
ACG: filecache.management
- Added: API level 11
Description
Allows apps to modify the parameters of a cache type other than its name. You must specify the name of the cache type, and those cache type parameters that have to be modified. The cache type values are all as defined in DefineType.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| typeName | Required | String | Name of cache type to be modified. |
| loWatermark | Optional | Number | The minimum space in bytes guaranteed to be available for this cache type. |
| hiWatermark | Optional | Number | The maximum space in bytes allowed to be used by this cache type. |
| size | Optional | Number | Default value in bytes for any object inserted into this cache type that does not specify a value for size. Size must not be negative. |
| cost | Optional | Number | Default value between 0 and 100 for any object inserted into this cache type that does not specify a value for cost. |
| lifetime | Optional | Number | Default value in seconds for any object inserted into this cache type that does not specify a value for lifetime. lifetime must not be negative. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -200 | "ChangeType: Invalid params: hiWatermark must be greater than loWatermark." | Parameters set are invalid |
| -196 | "ChangeType: Type 'test' does not exist." | Type is not yet defined |
Example
Example code
Prerequisite: Invoke DefineType API to define the type name "test".
# luna-send -f -n 1 luna://com.webos.service.filecache/DefineType '{"typeName":"test", "size":1024, "loWatermark":102400, "hiWatermark":409600, "cost":5}'
Example:
# luna-send -f -n 1 luna://com.webos.service.filecache/ChangeType '{"typeName":"test", "size":2048, "cost":10}'
CopyCacheObject
ACG: filecache.management
- Added: API level 11
Description
Enables copying of an object from the file cache to a non-cached location. On successful completion, newPathName will be returned as it may be different than expected due to filename collisions. If there is a name collision, the name will be made unique by adding a number to the file basename (i.e. foo.bar may become foo-(1).bar).
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| pathName | Required | String | The pathName is the path of the cache object to be copied |
| destination | Optional | String | The destination is the path to a target directory, this path will be validated to ensure you have write permissions to that directory. |
| fileName | Optional | String | The fileName is the name for the target file. If not passed, the fileName will be the value passed when calling InsertCacheObject. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| newPathName | Optional | String | On success, the newPathName will be returned. This file name may be different than expected due to filename collisions. If there is a name collision, the name will be made unique by adding a number to the file basename (i.e. foo.bar may become foo-(1).bar). |
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -199 | "CopyCacheObject: Could not locate object" | Object does not exist. |
| -199 | "CopyCacheObject: pathName no longer found in cache." | Path not available anymore. |
| -199 | "CopyCacheObject: Invalid object id derived from pathname." | Invalid object ID. |
| -193 | "CopyCacheObject: Invalid destination, no write permission." | No write permission. |
| -192 | "CopyCacheObject: No fileName specified or found." | Invalid filename argument. |
| -192 | "CopyCacheObject: No unique destination name found." | Destination not found. |
| -192 | "CopyCacheObject: Invalid destination, not a directory." | Invalid destination path. |
Example
Example code
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/CopyCacheObject '{"pathName":"/var/file-cache/test/M/OnRpQABl.bar", "destination":"", "fileName":"foo.bar"}'
Returns:
{
"newPathName": "/media/internal/downloads/foo.bar",
"returnValue": true
}
DefineType
ACG: filecache.management
- Added: API level 11
Description
Defines a new cache type. This is intended for use by the backup service.
Optionally you may specify the default values for the size, cost, and lifetime. These defaults will be applied to all objects inserted into this cache type that do not specify their own values for these arguments. The size is in bytes, the cost is an integer between 0 and 100, and the lifetime is in seconds.
The errorCode and errorText are only be returned if the returnValue is false.
Note: You can not define type with the same typeName. Use changeType to change an existing type.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| typeName | Required | String | A typeName is a string up to 64 characters that uniquely identifies the new cache type. A typeName cannot start with a . ( the period character). |
| loWatermark | Required | Number | The minimum space in bytes guaranteed to be available for the cache type. |
| hiWatermark | Required | Number | The maximum space in bytes allowed to be used by the cache type. |
| size | Optional | Number | Default value in bytes for any object inserted into the cache type that does not specify a value for size. |
| cost | Optional | Number | Default value between 0 and 100 for any object inserted into this cache type that does not specify a value for cost. |
| lifetime | Optional | Number | Default value in seconds for any object inserted into this cache type that does not specify a value for lifetime. |
| dirType | Optional | Boolean | Specifies whether the cache type should create directory entries. This is intended for use by the backup service. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -200 | "DefineType: Invalid params: hiWatermark must be greater than loWatermark." | Invalid parameters set. |
| -199 | "DefineType: Type 'test' already exists." | Typename already exists. |
| -197 | "DefineType: Failed to configure 'test'" | Type configuration failed. |
| -197 | "DefineType: Failed to allocate 'test'." | Type allocation failed. |
| -197 | "DefineType: Type 'test' already exists." | Type already exists. |
| -189 | "DefineType: Type 'test' has different configuration." | Configuration error. |
Example
Example code
Example:
# luna-send -f -n 1 luna://com.webos.service.filecache/DefineType '{"typeName":"test","size":1024,"loWatermark":102400,"hiWatermark":409600,"cost":5}'
DeleteType
ACG: filecache.management
- Added: API level 11
Description
Allows you to delete a previously defined cache type and frees up its space. All objects in the cache must be expired in order to delete a cache type. The app can call the ExpireCacheObject to force the objects to expire in the cache type.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| typeName | Required | String | The typeName is the name of the cache type to be deleted |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| freedSpace | Optional | Number | Show the space freed by the cache being deleted on success. |
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -195 | "DeleteType: Type 'test' has subscribed objects." | Type has subscribed objects, hence, cannot be deleted. |
| -195 | "DeleteType: Type 'test' does not exist." | Type does not exist. |
Example
Example code
Prerequisite: Invoke DefineType API to define the type name "test".
# luna-send -f -n 1 luna://com.webos.service.filecache/DefineType '{"typeName":"test", "size":1024, "loWatermark":102400, "hiWatermark":409600, "cost":5}'
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/DeleteType '{"typeName":"test"}'
DescribeType
ACG: filecache.operation
- Added: API level 11
Description
Returns cache type details. The DescribeType will return the currently assigned values for all cache type parameters.
Note: Filesize as it resides on disk after accounting for the filesystem blocksize of 4096 loWatermark/hiWatermark will be padded with filesystem block size of 4096.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| typeName | Required | String | The typeName is the name of the cache type for which more information about the cache type is needed. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| loWatermark | Optional | Number | The minimum space in bytes guaranteed to be available for this cache type. |
| hiWatermark | Optional | Number | The maximum space in bytes guaranteed to be available for this cache type. |
| size | Optional | Number | Default value in bytes for any object inserted into this cache type that does not specify a value for size. |
| cost | Optional | Number | Default value between 0 and 100 for any object inserted into this cache type that does not specify a value for cost. |
| lifetime | Optional | Number | Default value in seconds for any object inserted into this cache type that does not specify a value for lifetime. |
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -199 | "DescribeType: Type 'test' does not exists." | Type does not exist. |
Example
Example code
Prerequisite: Invoke DefineType API to define the type name "test".
# luna-send -f -n 1 luna://com.webos.service.filecache/DefineType '{"typeName":"test", "size":1024, "loWatermark":102400, "hiWatermark":409600, "cost":5}'
Example:
# luna-send -f -n 1 luna://com.webos.service.filecache/DescribeType '{"typeName":"test"}'
Returns:
{
"size": 1024,
"hiWatermark": 413696,
"lifetime": 1,
"loWatermark": 106496,
"returnValue": true,
"cost": 5
}
ExpireCacheObject
ACG: filecache.operation
- Added: API level 11
Description
Objects will normally be automatically expired form the cache as space is needed. If you want to force an item to be removed or if you want to remove items prior to calling DeleteType, you can expire an object manually.
The ExpireCacheObject method will not actually remove a subscribed object from the cache, but will mark the object for removal. The object is physically removed, when it has no active subscriptions.
NOTE: By default, objects in a cache type will be automatically expired from the cache as space is needed.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| pathName | Required | String | Path of the object to be manually expired. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -199 | "ExpireCacheObject: pathName no longer found in cache." | Path not found. |
| -199 | "ExpireCacheObject: Invalid object id derived from pathname." | Invalid object ID. |
| -198 | "ExpireCacheObject: Expire deferred, object in use." | Object in use, cannot expire. |
Example
Example code
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/ExpireCacheObject '{"pathName":"/var/file-cache/test/M/OnRpQABl.bar"}'
Returns:
{
"returnValue": true
}
GetCacheObjectFilename
ACG: filecache.operation
- Added: API level 11
Description
Allows you to query the original filename of a particular object in a cache type. In order to get the cache object file name the app must specify the path name of the object.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| pathName | Required | String | Path of the object for which the filename is to be queried. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| fileName | Optional | String | Original filename of the specified object if the call succeeds. |
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -199 | "GetCacheObjectFilename: Object '' doesn't exist" | Object path does not exist. |
Example
Example code
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/GetCacheObjectFilename '{"pathName":"/var/file-cache/test/L/cvrKwABm.bar"}'
Returns:
{
"fileName": "foo.bar",
"returnValue": true
}
GetCacheObjectSize
ACG: filecache.operation
- Added: API level 11
Description
Allows you to query a particular object size in a cache type. In order to get the cache object size, the app must specify the pathname of the object.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| pathName | Required | String | Path for the cache object to be queried for its size. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| size | Optional | Number | Size of the specified object on success |
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -199 | "GetCacheObjectSize: Object '' doesn't exist" | Object path does not exist. |
Example
Example code
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/GetCacheObjectSize '{"pathName":"/var/file-cache/test/L/cvrKwABm.bar"}'
Returns:
{
"returnValue": true,
"size": 1024
}
GetCacheStatus
ACG: filecache.operation
- Added: API level 11
Description
Give status of the cache as a whole. The GetCacheStatus will return:
- the number of cache types defined
- the total space used by the objects in all cache types
- the number of objects in all cache types
- the available space in the cache
Parameters
None
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Always returns true. |
| numTypes | Required | Number | The number of cached types defined |
| size | Required | Number | The total space used by the objects in all cache types |
| numObjs | Required | Number | The number of objects in all cache types |
| availSpace | Required | Number | The available space in the cache |
Example
Example code
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/GetCacheStatus '{}'
Returns:
{
"availSpace": 98304,
"numObjs": 1,
"numTypes": 1,
"returnValue": true,
"size": 8192
}
GetCacheTypeStatus
ACG: filecache.operation
- Added: API level 11
Description
Allows you to query the status of a particular cache type to obtain:
- the total space used by the objects in the specified cache type
- the number of objects in the specified cache type
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| typeName | Required | String | The name of the cache type for which the status information is to be retrieved. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| size | Optional | Number | The total space used by the objects in the specified cache type, if succeed |
| numObjs | Optional | Number | The number of objects in the specified cache type, if succeed. |
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -199 | "GetCacheTypeStatus: Type 'test' doesn't exist" | Type does not exist. |
Example
Example code
Prerequisite:
# luna-send -f -n 1 luna://com.webos.service.filecache/DefineType '{"typeName":"test", "size":1024, "loWatermark":102400, "hiWatermark":409600, "cost":5}'
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/GetCacheTypeStatus '{"typeName":"test"}'
Returns:
{
"numObjs": 1,
"returnValue": true,
"size": 8192
}
GetCacheTypes
ACG: filecache.operation
- Added: API level 11
Description
Returns an array of all defined cache types.
Parameters
None
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Always returns true. |
| types | Optional | String array | Array of all defined cache types. NOTE: If cache types are not defined, the “types” array is not returned. |
Example
Example code
Prerequisite: Invoke DefineType API to define the type name "test".
# luna-send -f -n 1 luna://com.webos.service.filecache/DefineType '{"typeName":"test", "size":1024, "loWatermark":102400, "hiWatermark":409600, "cost":5}'
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/GetCacheTypes '{}'
Returns:
{
"returnValue": true,
"types": ["test"]
}
GetVersion
ACG: filecache.operation
- Added: API level 11
Description
Returns the version of the File Cache API.
Parameters
None
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| version | Required | String | File Cache API version. |
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Example
Example code
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/GetVersion '{}'
Returns:
{
"returnValue": true,
"version": "1.1"
}
InsertCacheObject
ACG: filecache.operation
- Added: API level 11
Description
Inserts a new object of the specified type into the cache.
The fileName parameter is required. It is stored with the object to ensure that the correct extension is provided, so that other module can choose a strategy to process this file (for example, choose the file viewer matching the extension).
Other parameters are optional. If not provided, the cache type default values defined are be used.
Returned is the path to the object in the cache. The subscribe setting should be set to true so that after the object is inserted you can write the file.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| typeName | Required | String | The cache type of the object being inserted. |
| fileName | Required | String | The fileName is stored with the object and is used to ensure the correct extension is provided on the cache object. The fileName will help any code, for example, one that determines a file viewer, to operate correctly on a cached object file. |
| size | Optional | Number | The size is a value in bytes, should be greater than zero. Note that, size parameter is required, if type has no default size. |
| cost | Optional | Number | The cost is a number between 1 and 100. |
| lifetime | Optional | Number | The lifetime is value in seconds. |
| subscribe | Optional | Boolean | Subscribe should be set to true so that after the object is inserted one can continues to make updates to the file. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| pathName | Optional | String | The path to the object in the cache is returned on success. |
| subscribed | Optional | Boolean | Returns true if the subscription has been successful, returns false if it fails. May not be returned if subscribe was set to false in the arguments. |
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -200 | "InsertCacheObject: No type 'test' defined." | Type not defined. |
| -200 | "InsertCacheObject: Invalid params: size must be greater than 1 block when dirType = true." | Invalid parameters set. |
| -199 | "InsertCacheObject: Could not find '' bytes for object insert." | Size does not exist. |
| -199 | "InsertCacheObject: Type 'test' does not exist." | Type does not exist. |
Example
Example code
Prerequisite: Invoke DefineType API to define the type name "test".
# luna-send -f -n 1 luna://com.webos.service.filecache/DefineType '{"typeName":"test", "size":1024, "loWatermark":102400, "hiWatermark":409600, "cost":5}'
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/InsertCacheObject '{"typeName":"test", "fileName":"foo.bar", "size":1024, "subscribe":false}'
Returns:
{
"pathName": "/var/file-cache/test/M/OnRpQABl.bar",
"returnValue": true
}
ResizeCacheObject
ACG: filecache.operation
- Added: API level 11
Description
By calling the ResizeCacheObject you can specify the size of the cached object after it is inserted into the cache. Call this method if the final size of the object, which is being inserted into the cache, is not known by the moment, when you call the InsertCacheObject method. In this case:
- Call the InsertCacheObject method specifying the best approximate object size you can guess.
- Then call the ResizeCacheObject method on a subscribed object, if the the object size grows out of the previously specified size.
If the object is larger than the specified size when the write operation is complete, the object will be automatically removed from the cache. If the object is smaller than the specified size, the recorded object size will be adjusted to the correct size.
Remark: it is not a good practice to just specify a larger than expected size though as this could cause other objects to be expired from the cache to make room for the specified size.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| pathName | Required | String | The path of the object to be resized. |
| newSize | Required | Number | The new size of the object in bytes. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| newSize | Optional | Number | The new size of the resized object on success. |
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -199 | "ResizeCacheObject: pathName no longer found in cache." | Path not found. |
| -199 | "ResizeCacheObject: Invalid object id derived from pathname." | Invalid object ID. |
| -194 | "ResizeCacheObject: Unable to resize object." | Unable to resize object. |
Example
Example code
Example:
# luna-send -f -n 1 luna://com.webos.service.filecache/ResizeCacheObject '{"newSize": 1024, "pathName": "/var/file-cache/test/H/LCWlwAJb.cat"}'
Returns:
{
"newSize": 1024,
"returnValue": true
}
SubscribeCacheObject
ACG: filecache.operation
- Added: API level 11
Description
Enables you to subscribe an object in the cache and hold a subscription to the object for the duration of your usage. An object cannot be expired from the cache while at least one subscription is active.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| pathName | Required | String | The path for the object to be subscribed. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| subscribed | Required | Boolean | Indicates if subscribed to get notified.
|
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -199 | "SubscribeCacheObject: "Invalid object id derived from pathname." | Invalid object ID. |
| -199 | "SubscribeCacheObject: No cache of type 'test' found for id ''." | Cache type not found. |
| -199 | "SubscribeCacheObject: Cache type not found for id ''." | Cache type not found. |
Example
Example code
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/SubscribeCacheObject '{"pathName": "/var/file-cache/test/H/LCWlwAJb.cat"}'
Returns:
{
"returnValue": true
}
TouchCacheObject
ACG: filecache.operation
- Added: API level 11
Description
Allows you to mark an object as recently used. This decreases the chances of the object from getting expired from the cache when the space is being reclaimed.
Parameters
Name | Required | Type | Description |
|---|---|---|---|
| pathName | Required | String | path of the object to be marked as touched. |
Call Returns
Name | Required | Type | Description |
|---|---|---|---|
| returnValue | Required | Boolean | Indicates the status of operation. Possible values are:
|
| errorCode | Optional | Number | The error code for the failed operation. |
| errorText | Optional | String | Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details. |
Error Codes Reference
Error Code | Error Text | Error Description |
|---|---|---|
| -199 | "TouchCacheObject: Could not locate object" | Cache object not found. |
| -199 | "TouchCacheObject: pathName no longer found in cache." | Path not found. |
| -199 | "TouchCacheObject: Invalid object id derived from pathname." | Invalid object ID. |
Example
Example code
Example:
# luna-send -n 1 -f luna://com.webos.service.filecache/TouchCacheObject '{"pathName":"/var/file-cache/test/D2_/aJQCH9.bar"}'
Returns:
{
"returnValue": true
}