> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Long pollingイベント
export const Link = ({href, children, className, ...props}) => {
const localizedHref = localizeLink(href);
return
{children}
;
};
export const MultiRelatedLinks = ({sections = []}) => {
if (!sections || sections.length === 0) {
return null;
}
return
{sections.map((section, index) => )}
;
};
export const RelatedLinks = ({title, items = []}) => {
const getBadgeClass = badge => {
if (!badge) return "badge-default";
const badgeType = badge.toLowerCase().replace(/\s+/g, "-");
return `badge-${badge === "ガイド" ? "guide" : badgeType}`;
};
if (!items || items.length === 0) {
return null;
}
return ;
};
Boxアカウントでアクティビティのリアルタイム通知を取得するために、`OPTIONS /events` APIのLong polling機能を使用できます。
```sh cURL theme={null}
curl -i -X OPTIONS "https://api.box.com/2.0/events" \
-H "authorization: Bearer "
```
```typescript Node/TypeScript v10 theme={null}
await client.events.getEventsWithLongPolling();
```
```python Python v10 theme={null}
client.events.get_events_with_long_polling()
```
```cs .NET v10 theme={null}
await client.Events.GetEventsWithLongPollingAsync();
```
```swift Swift v10 theme={null}
try await client.events.getEventsWithLongPolling()
```
```java Java v10 theme={null}
client.getEvents().getEventsWithLongPolling()
```
```python Python v4 theme={null}
events = client.events().generate_events_with_long_polling()
for event in events:
print(f'Got {event.event_type} event')
```
```javascript Node v4 theme={null}
client.events.getEventStream(function(err, stream) {
if (err) {
// handle error
}
stream.on('data', function(event) {
// handle the event
});
});
```
Long pollingはUser Eventにのみ使用できます。Enterprise EventではLong pollingがサポートされません。
## Long polling
Long pollingでは、HTTPリクエストを開き、サーバーがレスポンスを送信するまでそのリクエストを開いたままにして、そのプロセスを何度も繰り返して更新されたレスポンスを受信します。
SDKには、新しいイベントに対するLong pollingにより、イベントフィードをイベントストリームに変換するためのサポートが組み込まれています。
### Long polling URL
Long pollingを使用するには、まず、リクエストを`OPTIONS /events` APIに送信し、Long polling URLを取得します。
```sh theme={null}
curl -X OPTIONS https://api.box.com/2.0/events \
-H "authorization: Bearer ACCESS_TOKEN"
```
```json theme={null}
{
"chunk_size": 1,
"entries": [
{
"type": "realtime_server",
"url": "http://2.realtime.services.box.net/subscribe?channel=cc807c9c4869ffb1c81a&stream_type=all",
"ttl": 10,
"max_retries": 10,
"retry_timeout": 610
}
]
}
```
### リアルタイムサーバー
次に、指定されたURLに`GET`リクエストを実行してイベントのリッスンを開始します。監視対象のアカウントでイベントが発生すると、`new_change`という値を持つレスポンスが送信されます。レスポンスにはその他の詳細は含まれていません。
この単一のレスポンスは、最新の既知の`stream_position`を使用して`GET /events`エンドポイントにリクエストを送信するなど、後続の処理を促すことを目的としています。
### 切断と再接続
サーバーは、このレスポンスを送信した後に接続を閉じます。この時点でアプリケーションがイベントのリッスンを再開するには、Long pollingのプロセスを繰り返す必要があります。
アプリケーションがリアルタイムサーバーに接続してもその後しばらくイベントが発生しないと、接続が閉じられ、`reconnect`という値が返されます。この状況になると、アプリケーションはプロセスを再開するために`OPTIONS /events`に対する新しい呼び出しを実行する必要があります。
### タイムアウトと再試行
`retry_timeout`で指定した秒数以内にアプリケーションがイベントを受け取らなければ、アプリケーションはリアルタイムサーバーに再接続できます。これは、ネットワークエラーが発生すると必要になる場合があります。
アプリケーションがリアルタイムサーバーに対して`GET`リクエストを送信したときに`max_retries`エラーが返された場合は、`/events` APIに対して`OPTIONS`呼び出しを実行してプロセスを再開する必要があります。