/*---------------------------------------------------------------------------*

Copyright (C) Nintendo.  All rights reserved.

These coded instructions, statements, and computer programs contain
proprietary information of Nintendo of America Inc. and/or Nintendo
Company Ltd., and are protected by Federal copyright law.  They may
not be disclosed to third parties or copied or duplicated in any form,
in whole or in part, without the prior written consent of Nintendo.

 *---------------------------------------------------------------------------*/

#ifndef NN_BOSS_BOSS_DATASTORECONST_H_
#define NN_BOSS_BOSS_DATASTORECONST_H_

#ifdef __cplusplus

namespace nn {
namespace boss {

/*!
@addtogroup  nn_boss
    @{

@defgroup nn_boss_datastoreconst  SpotPass (BOSS) DataStore_Constant Definitions
@brief  This list contains constant definitions related to the SpotPass (BOSS) library <tt>DataStore</tt> task feature.
    @{
*/


/*!
@brief  Namespace for <tt>DataStore</tt>-related definitions.
*/
namespace datastore
{
    static const u32 ACCESS_KEY_MAX_WCHAR_LENGTH_WITH_NULL = 16;   //!<  Maximum access key character length including the <tt>NULL</tt> terminator (all <tt>wchar_t</tt> characters).
    static const u32 DESTINATION_PRINCIPAL_ID_MAX_COUNT    = 100;  //!<  Maximum number of destination principal IDs for a single <tt>DataStore</tt> upload task.
    static const u32 CHECK_TOKEN_SIZE                      = 352;  //!<  Size of the <tt>DataStore</tt> check token.
    static const u32 TAG_MAX_CHARACTER_COUNT               = 24;   //!<  Maximum length of a <tt>DataStore</tt> task tag value.
    static const u32 TAG_MAX_CHAR_LENGTH_WITH_NULL         = 577;  //!<  Maximum length of a <tt>DataStore</tt> task tag value, including the terminating null character. A tag can be specified as both an ASCII or a UTF-8 byte string using <tt>\\x</tt> hexadecimal notation, so the maximum length is <tt>6</tt> (maximum bytes of a single UTF-8 glyph) <tt>* 4</tt> (number of bytes in <tt>\\x</tt> hexadecimal notation) <tt>* TAG_MAX_CHARACTER_COUNT + 1</tt>.
    static const u32 TAG_MAX_COUNT                         = 16;   //!<  Maximum number of tag values in a <tt>DataStore</tt> task.
    static const u32 METABINARY_MAX_SIZE                   = 1024; //!<  Maximum size of metabinary data.
    static const u32 MAX_COUNT_OF_PRINCIPAL_ID_WITH_UPDATE_PERMISSION = 100;  //!<  Maximum number of users (principal IDs) that can be specified as having update permissions for uploaded data when registering a <tt>DataStore</tt> upload task.

    static const u32 DOWNLOAD_DATA_MAX_COUNT = 1024; //!<  Maximum pieces of data that can be stored in a single <tt>DataStore</tt> download task.

    /*!
@brief  Constants that represent <tt>DataStore</tt> data recipient types. These are also used for setting update permissions.
(For more information, see the documentation in the NEX library.)
(The numeric value of each enumerator is shown at the start of its description.)
*/
    enum DestinationKind
    {
        DSTKIND_PUBLIC           = 0,               //!<  <tt>0</tt>: All users.
        DSTKIND_FRIEND           = 1,               //!<  <tt>1</tt>: All friends.
        DSTKIND_SPECIFIED        = 2,               //!<  <tt>2</tt>: Specified users.
        DSTKIND_PRIVATE          = 3,               //!<  <tt>3</tt>: Sender.
        DSTKIND_SPECIFIED_FRIEND = 4,               //!<  <tt>4</tt>: Friends and specified others.
    };

    /*!
@brief  Constants that represent the result of <tt>DataStore</tt> task options. Passed as an argument to the <var>optionKind</var> parameter of <tt>@ref nn::boss::Task::GetOptionResult</tt>.
(The numeric value of each enumerator is shown at the start of its description.)
*/
    enum OptionResultKind
    {
        UPLOAD_DATA_ID           = 0,               //!<  <tt>0</tt>: Data ID of the uploaded data.
    };

    /*!
@brief  Definitions of the option values (bit flag) that control the handling of a DataStore upload task. Use <tt>@ref DataStoreUploadSetting::SetOption</tt> to specify these options.
*/
    static const u32 DATASTORE_UPLOAD_OPTION_DISABLE_NOTIFICATION_FOR_POST   = 0x00000001; //!< Disables the notification when uploading new data. When this option is specified, the DataStore upload task does not set the <tt>nn::nex::DataStoreConstants::DATA_FLAG_USE_NOTIFICATION_ON_POST</tt> flag in the NEX library. This makes it so that the data uploaded by the task is not downloaded from DataStore download tasks. (This affects new uploads. Any future updates will be downloaded.)
    static const u32 DATASTORE_UPLOAD_OPTION_DISABLE_NOTIFICATION_FOR_UPDATE = 0x00000002; //!< Disables the notification when updating data that has already been uploaded. When this option is specified, the DataStore upload task does not set the <tt>nn::nex::DataStoreConstants::DATA_FLAG_USE_NOTIFICATION_ON_UPDATE</tt> flag in the NEX library. This makes it so that even if the data uploaded by the task is updated by a different DataStore upload task, it is not downloaded from DataStore download tasks. (This affects updates. New uploads will be downloaded.)

} // end of namespace datastore


/*!
   @}
   @}
*/

} // end of namespace boss
} // end of namespace nn


#endif /*__cplusplus*/

#endif /* NN_BOSS_BOSS_DATASTORECONST_H_ */