ストリーム位置のページ割り

ガイドイベントストリーム位置のページ割り

ストリーム位置のページ割り

イベントストリームのページ割りは、stream_positionパラメータの使用によって機能します。

最初に、stream_positionクエリパラメータを指定せずにリクエストをGET /events APIに送信します。

curl https://api.box.com/2.0/events \
  -H "authorization: Bearer ACCESS_TOKEN"

このAPIにより、使用可能なすべてのイベントが古い方から順に返されます。応答にはnext_stream_position値も含まれており、これを使用して、ストリーム内の次の位置に対する次のAPI呼び出しを実行できます。

curl https://api.box.com/2.0/events?stream_position=388720462721 \
  -H "authorization: Bearer ACCESS_TOKEN"

stream_positionは、最も近いストリーム位置が返されるようnowに設定することもできます。

curl https://api.box.com/2.0/events?stream_position=now \
  -H "authorization: Bearer ACCESS_TOKEN"

この場合、APIによって空のリストと、次の呼び出しに使用できるnext_stream_positionが返されます。