docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Interface IPlayerDataService

    Namespace: Unity.Services.CloudSave.Internal
    Assembly: solution.dll
    Syntax
    public interface IPlayerDataService

    Methods

    Name Description
    DeleteAllAsync()

    Removes all keys for the player without write lock validation. Throws a CloudSaveException with a reason code and explanation of what happened.

    DeleteAsync(string, DeleteOptions)

    Removes one key at a time, with optional write lock validation. If the given key doesn't exist, there is no feedback in place to inform a developer about it. If a write lock is provided and it does not match with the existing write lock, will throw a conflict exception. There is no client validation on the arguments for this method. Throws a CloudSaveException with a reason code and explanation of what happened.

    ListAllKeysAsync()

    Returns all keys stored in Cloud Save for the logged in player. Throws a CloudSaveException with a reason code and explanation of what happened.

    LoadAllAsync()

    Downloads data from Cloud Save for all keys. Throws a CloudSaveException with a reason code and explanation of what happened.

    LoadAsync(ISet<string>)

    Downloads data from Cloud Save for the keys provided. There is no client validation in place for the provided keys. Throws a CloudSaveException with a reason code and explanation of what happened.

    SaveAsync(IDictionary<string, object>)

    Upload one or more key-value pairs to the Cloud Save service without write lock validation, overwriting any values that are currently stored under the given keys. Key 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.

    Dictionary
    as a parameter ensures the uniqueness of given keys.

    There is no client validation in place, which means the API can be called regardless if data is incorrect, invalid, and/or missing.

    SaveAsync(IDictionary<string, SaveItem>)

    Upload one or more key-value pairs to the Cloud Save service, with optional write lock validation. If a write lock is provided on an item and it does not match with the existing write lock, will throw a conflict exception. If the write lock for an item is set to null, the write lock validation for that item will be skipped and any existing value currently stored for that key will be overwritten. Keys 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.

    Dictionary
    as a parameter ensures the uniqueness of given keys.

    There is no client validation in place, which means the API can be called regardless if data or keys are incorrect, invalid, and/or missing.

    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023