AimeCampaignInfo.h

[詳解]

/// @file
/// @brief Aimeキャンペーン情報を保持する構造体 AimeCampaignInfo のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_AIMECAMPAIGNINFO_H
#define AMDAEMON_AIMECAMPAIGNINFO_H

#include "amdaemon/env.h"
#include "amdaemon/util/DateTime.h"

#include <cstdint>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_aime
/// @{

    /// @brief Aimeキャンペーン情報を保持する構造体。
    ///
    /// 日時はすべて年月日と時までが有効。分以下の値は 0 となっている。
    struct AimeCampaignInfo
    {
        /// 期間を表す構造体。
        struct TimeRange
        {
            ::amdaemon::util::DateTime begin;   ///< 開始日時。
            ::amdaemon::util::DateTime end;     ///< 終了日時。
        };

        /// キャンペーン名の最大文字列長。
        static const std::size_t MaxNameLength = 127;

        std::uint32_t id;                       ///< キャンペーンID。 0 は無効値。
        wchar_t name[MaxNameLength + 1];        ///< キャンペーン名。
        ::amdaemon::util::DateTime noticeTime;  ///< 告知開始日時。
        TimeRange openTimeRange;                ///< 開催期間。
        TimeRange rewardTimeRange;              ///< 報酬配布期間。
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_AIMECAMPAIGNINFO_H