APIにおけるタイムドトピックフィールドの説明

開発
1

私のプロジェクトでは、スケジュールされたトピックをプログラムで作成したいと考えています。タイマー付きトピックの API エンドポイントを使用しようと考えていますが、いくつかのフィールドについて少し混乱しています。

  • id パラメータ（パス）：単純で、スケジュール対象のトピック ID です。
  • time：この値はどのような形式で指定するのでしょうか？ドキュメントには単に「string」としか記載されていません。
  • status_type：考えられる値がわかりません。ステータス更新 API のステータス列挙型と同様かと思いましたが、タイマーの例では「publish_to_category」となっており、これは列挙型のオプションに含まれていません。
  • based_on_last_post：このブール値フラグが何を意味するのか全くわかりません。
  • category_id：単純で、カテゴリ ID です。
2

app/models/topic_timer.rb:

close
open
publish_to_category
delete
reminder
bump
delete_replies

コード内のコメントをいくつか見つけました：

  • 現在時刻からの時間（時間単位）を表す整数で、トピックのステータスを更新する時間を指定します。
  • トピックのステータスを更新する時刻を表すタイムスタンプ（例：「2013-11-25 13:00」）。
  • タイムゾーンを含むタイムスタンプを JSON 形式で指定します（例：「2013-11-26T21:00:00.000Z」）。
  • based_on_last_post: 時間が最後の投稿のタイムスタンプに基づいて計算される場合は True にします。
「いいね！」 2
3

コメントへの参考ありがとうございます：discourse/app/models/topic.rb at 0863c36221130b161d63562a58ac97171475dca5 · discourse/discourse · GitHub

models/topic.rb 内の set_or_create_timer メソッドに、この API をサポートするロジックが含まれています。

「いいね！」 1