This function is part of the PlayerDataStorage Interface.
Clear previously cached file data. This operation will be done asynchronously. All cached files except those corresponding to the transfers in progress will be removed.
Warning: Use this with care. Cache system generally tries to clear old and unused cached files from time to time. Unnecessarily clearing cache can degrade performance as SDK will have to re-download data.
Return Value
{Result.Success} if the operation was started correctly, otherwise an error result explaining what went wrong
Parameters
PlayerDataStorage.PlayerDataStorageInterface.DeleteCache
|
Parameter Type And Name
|
Usage Information
|
|
DeleteCacheOptions options
|
Object containing properties related to which user is deleting cache
|
|
object clientData
|
Optional pointer to help clients track this request, that is returned in associated callbacks
|
|
OnDeleteCacheCompleteCallback completionCallback
|
This function is called when the delete cache operation completes
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionCallback parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type PlayerDataStorage.OnDeleteCacheCompleteCallback to report the results of its operation.
Callback for when {PlayerDataStorageInterface.DeleteCache} completes
Callback Parameters
PlayerDataStorage.OnDeleteCacheCompleteCallback
|
Parameter Type And Name
|
Usage Information
|
|
DeleteCacheCallbackInfo data
|
|