EventsManager (Box Java SDK)

Object
- EventsManager

public class EventsManager
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EventsManager.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`EventsManager.Builder`

Field Summary

Fields
Modifier and Type Field and Description

Authentication auth

NetworkSession networkSession

Fields
Modifier and Type	Field and Description
`Authentication`	`auth`
`NetworkSession`	`networkSession`

Constructor Summary

Constructors
Modifier Constructor and Description

EventsManager()

protected EventsManager(EventsManager.Builder builder)

Constructors
Modifier	Constructor and Description
	`EventsManager()`
`protected`	`EventsManager(EventsManager.Builder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Authentication`	`getAuth()`
`Events`	`getEvents()` Returns up to a year of past events for a given user or for the entire enterprise.
`Events`	`getEvents(GetEventsHeaders headers)` Returns up to a year of past events for a given user or for the entire enterprise.
`Events`	`getEvents(GetEventsQueryParams queryParams)` Returns up to a year of past events for a given user or for the entire enterprise.
`Events`	`getEvents(GetEventsQueryParams queryParams, GetEventsHeaders headers)` Returns up to a year of past events for a given user or for the entire enterprise.
`EventStream`	`getEventStream()` Get an event stream for the Box API
`EventStream`	`getEventStream(GetEventStreamHeaders headers)` Get an event stream for the Box API
`EventStream`	`getEventStream(GetEventStreamQueryParams queryParams)` Get an event stream for the Box API
`EventStream`	`getEventStream(GetEventStreamQueryParams queryParams, GetEventStreamHeaders headers)` Get an event stream for the Box API
`RealtimeServers`	`getEventsWithLongPolling()` Returns a list of real-time servers that can be used for long-polling updates to the [event stream](https://developer.box.com/reference/get-events).
`RealtimeServers`	`getEventsWithLongPolling(GetEventsWithLongPollingHeaders headers)` Returns a list of real-time servers that can be used for long-polling updates to the [event stream](https://developer.box.com/reference/get-events).
`NetworkSession`	`getNetworkSession()`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - auth
```
public Authentication auth
```
  - networkSession
```
public NetworkSession networkSession
```
- Constructor Detail
  - EventsManager
```
public EventsManager()
```
  - EventsManager
```
protected EventsManager(EventsManager.Builder builder)
```
- Method Detail
  - getEventsWithLongPolling
```
public RealtimeServers getEventsWithLongPolling()
```
    Returns a list of real-time servers that can be used for long-polling updates to the [event stream](https://developer.box.com/reference/get-events).
    Long polling is the concept where a HTTP request is kept open until the server sends a response, then repeating the process over and over to receive updated responses.
    Long polling the event stream can only be used for user events, not for enterprise events.
    To use long polling, first use this endpoint to retrieve a list of long poll URLs. Next, make a long poll request to any of the provided URLs.
    When an event occurs in monitored account a response with the value `new_change` will be sent. The response contains no other details as it only serves as a prompt to take further action such as sending a request to the [events endpoint](https://developer.box.com/reference/get-events) with the last known `stream_position`.
    After the server sends this response it closes the connection. You must now repeat the long poll process to begin listening for events again.
    If no events occur for a while and the connection times out you will receive a response with the value `reconnect`. When you receive this response you’ll make another call to this endpoint to restart the process.
    If you receive no events in `retry_timeout` seconds then you will need to make another request to the real-time server (one of the URLs in the response for this endpoint). This might be necessary due to network errors.
    Finally, if you receive a `max_retries` error when making a request to the real-time server, you should start over by making a call to this endpoint first.
  - getEventsWithLongPolling
```
public RealtimeServers getEventsWithLongPolling(GetEventsWithLongPollingHeaders headers)
```
    Returns a list of real-time servers that can be used for long-polling updates to the [event stream](https://developer.box.com/reference/get-events).
    Long polling is the concept where a HTTP request is kept open until the server sends a response, then repeating the process over and over to receive updated responses.
    Long polling the event stream can only be used for user events, not for enterprise events.
    To use long polling, first use this endpoint to retrieve a list of long poll URLs. Next, make a long poll request to any of the provided URLs.
    When an event occurs in monitored account a response with the value `new_change` will be sent. The response contains no other details as it only serves as a prompt to take further action such as sending a request to the [events endpoint](https://developer.box.com/reference/get-events) with the last known `stream_position`.
    After the server sends this response it closes the connection. You must now repeat the long poll process to begin listening for events again.
    If no events occur for a while and the connection times out you will receive a response with the value `reconnect`. When you receive this response you’ll make another call to this endpoint to restart the process.
    If you receive no events in `retry_timeout` seconds then you will need to make another request to the real-time server (one of the URLs in the response for this endpoint). This might be necessary due to network errors.
    Finally, if you receive a `max_retries` error when making a request to the real-time server, you should start over by making a call to this endpoint first.
    
    Parameters:
    
    headers - Headers of getEventsWithLongPolling method
  - getEvents
```
public Events getEvents()
```
    Returns up to a year of past events for a given user or for the entire enterprise.
    By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to `admin_logs_streaming` for live monitoring of new events, or `admin_logs` for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.
  - getEvents
```
public Events getEvents(GetEventsQueryParams queryParams)
```
    Returns up to a year of past events for a given user or for the entire enterprise.
    By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to `admin_logs_streaming` for live monitoring of new events, or `admin_logs` for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.
    
    Parameters:
    
    queryParams - Query parameters of getEvents method
  - getEvents
```
public Events getEvents(GetEventsHeaders headers)
```
    Returns up to a year of past events for a given user or for the entire enterprise.
    By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to `admin_logs_streaming` for live monitoring of new events, or `admin_logs` for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.
    
    Parameters:
    
    headers - Headers of getEvents method
  - getEvents
```
public Events getEvents(GetEventsQueryParams queryParams,
                        GetEventsHeaders headers)
```
    Returns up to a year of past events for a given user or for the entire enterprise.
    By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to `admin_logs_streaming` for live monitoring of new events, or `admin_logs` for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.
    
    Parameters:
    
    queryParams - Query parameters of getEvents method
    
    headers - Headers of getEvents method
  - getEventStream
```
public EventStream getEventStream()
```
    Get an event stream for the Box API
  - getEventStream
```
public EventStream getEventStream(GetEventStreamQueryParams queryParams)
```
    Get an event stream for the Box API
    
    Parameters:
    
    queryParams - Query parameters of getEvents method
  - getEventStream
```
public EventStream getEventStream(GetEventStreamHeaders headers)
```
    Get an event stream for the Box API
    
    Parameters:
    
    headers - Headers of getEvents method
  - getEventStream
```
public EventStream getEventStream(GetEventStreamQueryParams queryParams,
                                  GetEventStreamHeaders headers)
```
    Get an event stream for the Box API
    
    Parameters:
    
    queryParams - Query parameters of getEvents method
    
    headers - Headers of getEvents method
  - getAuth
```
public Authentication getAuth()
```
  - getNetworkSession
```
public NetworkSession getNetworkSession()
```

Class EventsManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

auth

networkSession

Constructor Detail

EventsManager

EventsManager

Method Detail

getEventsWithLongPolling

getEventsWithLongPolling

getEvents

getEvents

getEvents

getEvents

getEventStream

getEventStream

getEventStream

getEventStream

getAuth

getNetworkSession