Method DeleteAsync
DeleteAsync(string, DeleteOptions)
Delete a player-scoped file form the Cloud Save service. File name can only contain alphanumeric characters, dashes, and underscores and be up to a length of 255 characters. Throws a CloudSaveException with a reason code and explanation of what happened.
Declaration
[Obsolete("This method will be removed in an upcoming release. Use Task CloudSaveService.Instance.Files.Player.DeleteAsync(string key, DeleteOptions options = null) instead.", false)]
Task DeleteAsync(string key, DeleteOptions options = null)
Parameters
Type | Name | Description |
---|---|---|
string | key | The key of the saved file to be deleted. |
DeleteOptions | options | Options object with "WriteLock", the expected stored writeLock of the file - if this value is provided and is not a match then the operation will not succeed. If it is not provided then the operation will be performed regardless of the stored writeLock value. |
Returns
Type | Description |
---|---|
Task |
Exceptions
Type | Condition |
---|---|
CloudSaveException | Thrown if request is unsuccessful. |
CloudSaveValidationException | Thrown if the service returned validation error. |
CloudSaveRateLimitedException | Thrown if the service returned rate limited error. |