RealtimeServer (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - RealtimeServer

All Implemented Interfaces:

Serializable
```
public class RealtimeServer
extends SerializableObject
```
A real-time server that can be used for long polling user events.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RealtimeServer.Builder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`maxRetries` The maximum number of retries this server will allow before a new long poll should be started by getting a [new list of server](https://developer.box.com/reference/options-events).
`protected Long`	`retryTimeout` The maximum number of seconds without a response after which you should retry the long poll connection.
`protected String`	`ttl` The time in minutes for which this server is available.
`protected String`	`type` The value will always be `realtime_server`.
`protected String`	`url` The URL for the server.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

RealtimeServer()

protected RealtimeServer(RealtimeServer.Builder builder)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getMaxRetries()`
`Long`	`getRetryTimeout()`
`String`	`getTtl()`
`String`	`getType()`
`String`	`getUrl()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

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

- Field Detail
  - type
```
protected String type
```
    The value will always be `realtime_server`.
  - url
```
protected String url
```
    The URL for the server.
  - ttl
```
protected String ttl
```
    The time in minutes for which this server is available.
  - maxRetries
```
protected String maxRetries
```
    The maximum number of retries this server will allow before a new long poll should be started by getting a [new list of server](https://developer.box.com/reference/options-events).
  - retryTimeout
```
protected Long retryTimeout
```
    The maximum number of seconds without a response after which you should retry the long poll connection.
    This helps to overcome network issues where the long poll looks to be working but no packages are coming through.
- Constructor Detail
  - RealtimeServer
```
public RealtimeServer()
```
  - RealtimeServer
```
protected RealtimeServer(RealtimeServer.Builder builder)
```
- Method Detail
  - getType
```
public String getType()
```
  - getUrl
```
public String getUrl()
```
  - getTtl
```
public String getTtl()
```
  - getMaxRetries
```
public String getMaxRetries()
```
  - getRetryTimeout
```
public Long getRetryTimeout()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RealtimeServer

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

type

url

ttl

maxRetries

retryTimeout

Constructor Detail

RealtimeServer

RealtimeServer

Method Detail

getType

getUrl

getTtl

getMaxRetries

getRetryTimeout

equals

hashCode

toString