OpenTween/Api/ApiLimit.cs

   1 // OpenTween - Client of Twitter
   2 // Copyright (c) 2013 kim_upsilon (@kim_upsilon) <https://upsilo.net/~upsilon/>
   3 // All rights reserved.
   4 //
   5 // This file is part of OpenTween.
   6 //
   7 // This program is free software; you can redistribute it and/or modify it
   8 // under the terms of the GNU General Public License as published by the Free
   9 // Software Foundation; either version 3 of the License, or (at your option)
  10 // any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  15 // for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License along
  18 // with this program. If not, see <http://www.gnu.org/licenses/>, or write to
  19 // the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
  20 // Boston, MA 02110-1301, USA.
  21
  22 #nullable enable
  23
  24 using System;
  25 using System.Collections.Generic;
  26 using System.Linq;
  27 using System.Text;
  28
  29 namespace OpenTween.Api
  30 {
  31     public class ApiLimit
  32     {
  33         /// <summary>
  34         /// API 実行回数制限の値
  35         /// </summary>
  36         public int AccessLimitCount { get; }
  37
  38         /// <summary>
  39         /// API 実行回数制限までの残回数
  40         /// </summary>
  41         public int AccessLimitRemain { get; }
  42
  43         /// <summary>
  44         /// API 実行回数制限がリセットされる日時
  45         /// </summary>
  46         public DateTimeUtc AccessLimitResetDate { get; }
  47
  48         /// <summary>
  49         /// API 実行回数制限値を取得した日時
  50         /// </summary>
  51         public DateTimeUtc UpdatedAt { get; }
  52
  53         public ApiLimit(int limitCount, int limitRemain, DateTimeUtc resetDate)
  54             : this(limitCount, limitRemain, resetDate, DateTimeUtc.Now)
  55         {
  56         }
  57
  58         public ApiLimit(int limitCount, int limitRemain, DateTimeUtc resetDate, DateTimeUtc updatedAt)
  59         {
  60             this.AccessLimitCount = limitCount;
  61             this.AccessLimitRemain = limitRemain;
  62             this.AccessLimitResetDate = resetDate;
  63             this.UpdatedAt = updatedAt;
  64         }
  65
  66         public override bool Equals(object? obj)
  67             => this.Equals(obj as ApiLimit);
  68
  69         public bool Equals(ApiLimit? obj)
  70             => obj != null && this.AccessLimitCount == obj.AccessLimitCount &&
  71                 this.AccessLimitRemain == obj.AccessLimitRemain && this.AccessLimitResetDate == obj.AccessLimitResetDate;
  72
  73         public override int GetHashCode()
  74             => this.AccessLimitCount ^ this.AccessLimitRemain ^ this.AccessLimitResetDate.GetHashCode();
  75     }
  76 }