SharedLinkAPIConnection (Box Java SDK)

Object
- BoxAPIConnection
- - SharedLinkAPIConnection

```
public class SharedLinkAPIConnection
extends BoxAPIConnection
```
This API connection uses a shared link (along with an optional password) to authenticate with the Box API. It wraps a preexisting BoxAPIConnection in order to provide additional access to items that are accessible with a shared link.

Nested Class Summary
- Nested classes/interfaces inherited from class BoxAPIConnection
  BoxAPIConnection.ResourceLinkType

Field Summary
- Fields inherited from class BoxAPIConnection
  DEFAULT_MAX_ATTEMPTS, DEFAULT_MAX_RETRIES

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canRefresh()` Determines if this connection's access token can be refreshed.
`String`	`getAccessToken()` Gets an access token that can be used to authenticate an API request.
`boolean`	`getAutoRefresh()` Gets whether or not automatic refreshing of this connection's access token is enabled.
`String`	`getBaseUploadURL()` Gets the base upload URL that's used when performing file uploads to Box.
`String`	`getBaseURL()` Gets the base URL that's used when sending requests to the Box API.
`long`	`getExpires()` Gets the amount of time for which this connection's access token is valid.
`int`	`getMaxRequestAttempts()` Deprecated. getMaxRetryAttempts is preferred because it more clearly gets the number of times a request should be retried after an error response is received.
`int`	`getMaxRetryAttempts()` Gets the maximum number of times an API request will be retried after an error response is received.
`String`	`getRefreshToken()` Gets a refresh token that can be used to refresh an access token.
`String`	`getUserAgent()` Gets the user agent that's used when sending requests to the Box API.
`boolean`	`needsRefresh()` Determines if this connection's access token has expired and needs to be refreshed.
`void`	`refresh()` Refresh's this connection's access token using its refresh token.
`void`	`setAccessToken(String accessToken)` Sets the access token to use when authenticating API requests.
`void`	`setAutoRefresh(boolean autoRefresh)` Enables or disables automatic refreshing of this connection's access token.
`void`	`setBaseUploadURL(String baseUploadURL)` Sets the base upload URL to be used when performing file uploads to Box.
`void`	`setBaseURL(String baseURL)` Sets the base URL to be used when sending requests to the Box API.
`void`	`setExpires(long milliseconds)` Sets the amount of time for which this connection's access token is valid before it must be refreshed.
`void`	`setMaxRequestAttempts(int attempts)` Deprecated. setMaxRetryAttempts is preferred because it more clearly sets the number of times a request should be retried after an error response is received.
`void`	`setMaxRetryAttempts(int attempts)` Sets the maximum number of times an API request will be retried after an error response is received.
`void`	`setRefreshToken(String refreshToken)` Sets the refresh token to use when refreshing an access token.
`void`	`setUserAgent(String userAgent)` Sets the user agent to be used when sending requests to the Box API.

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

- Method Detail
  - getExpires
```
public long getExpires()
```
    Description copied from class: BoxAPIConnection
    
    Gets the amount of time for which this connection's access token is valid.
    
    Overrides:
    
    getExpires in class BoxAPIConnection
    
    Returns:
    
    the amount of time in milliseconds.
  - setExpires
```
public void setExpires(long milliseconds)
```
    Description copied from class: BoxAPIConnection
    
    Sets the amount of time for which this connection's access token is valid before it must be refreshed.
    
    Overrides:
    
    setExpires in class BoxAPIConnection
    
    Parameters:
    
    milliseconds - the number of milliseconds for which the access token is valid.
  - getBaseURL
```
public String getBaseURL()
```
    Description copied from class: BoxAPIConnection
    
    Gets the base URL that's used when sending requests to the Box API. The default value is "https://api.box.com/2.0/".
    
    Overrides:
    
    getBaseURL in class BoxAPIConnection
    
    Returns:
    
    the base URL.
  - setBaseURL
```
public void setBaseURL(String baseURL)
```
    Description copied from class: BoxAPIConnection
    
    Sets the base URL to be used when sending requests to the Box API. For example, the default base URL is "https://api.box.com/2.0/".
    
    Overrides:
    
    setBaseURL in class BoxAPIConnection
    
    Parameters:
    
    baseURL - a base URL
  - getBaseUploadURL
```
public String getBaseUploadURL()
```
    Description copied from class: BoxAPIConnection
    
    Gets the base upload URL that's used when performing file uploads to Box.
    
    Overrides:
    
    getBaseUploadURL in class BoxAPIConnection
    
    Returns:
    
    the base upload URL.
  - setBaseUploadURL
```
public void setBaseUploadURL(String baseUploadURL)
```
    Description copied from class: BoxAPIConnection
    
    Sets the base upload URL to be used when performing file uploads to Box.
    
    Overrides:
    
    setBaseUploadURL in class BoxAPIConnection
    
    Parameters:
    
    baseUploadURL - a base upload URL.
  - getUserAgent
```
public String getUserAgent()
```
    Description copied from class: BoxAPIConnection
    
    Gets the user agent that's used when sending requests to the Box API.
    
    Overrides:
    
    getUserAgent in class BoxAPIConnection
    
    Returns:
    
    the user agent.
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
    Description copied from class: BoxAPIConnection
    
    Sets the user agent to be used when sending requests to the Box API.
    
    Overrides:
    
    setUserAgent in class BoxAPIConnection
    
    Parameters:
    
    userAgent - the user agent.
  - getAccessToken
```
public String getAccessToken()
```
    Description copied from class: BoxAPIConnection
    
    Gets an access token that can be used to authenticate an API request. This method will automatically refresh the access token if it has expired since the last call to getAccessToken().
    
    Overrides:
    
    getAccessToken in class BoxAPIConnection
    
    Returns:
    
    a valid access token that can be used to authenticate an API request.
  - setAccessToken
```
public void setAccessToken(String accessToken)
```
    Description copied from class: BoxAPIConnection
    
    Sets the access token to use when authenticating API requests.
    
    Overrides:
    
    setAccessToken in class BoxAPIConnection
    
    Parameters:
    
    accessToken - a valid access token to use when authenticating API requests.
  - getRefreshToken
```
public String getRefreshToken()
```
    Description copied from class: BoxAPIConnection
    
    Gets a refresh token that can be used to refresh an access token.
    
    Overrides:
    
    getRefreshToken in class BoxAPIConnection
    
    Returns:
    
    a valid refresh token.
  - setRefreshToken
```
public void setRefreshToken(String refreshToken)
```
    Description copied from class: BoxAPIConnection
    
    Sets the refresh token to use when refreshing an access token.
    
    Overrides:
    
    setRefreshToken in class BoxAPIConnection
    
    Parameters:
    
    refreshToken - a valid refresh token.
  - setAutoRefresh
```
public void setAutoRefresh(boolean autoRefresh)
```
    Description copied from class: BoxAPIConnection
    
    Enables or disables automatic refreshing of this connection's access token. Defaults to true.
    
    Overrides:
    
    setAutoRefresh in class BoxAPIConnection
    
    Parameters:
    
    autoRefresh - true to enable auto token refresh; otherwise false.
  - getAutoRefresh
```
public boolean getAutoRefresh()
```
    Description copied from class: BoxAPIConnection
    
    Gets whether or not automatic refreshing of this connection's access token is enabled. Defaults to true.
    
    Overrides:
    
    getAutoRefresh in class BoxAPIConnection
    
    Returns:
    
    true if auto token refresh is enabled; otherwise false.
  - getMaxRequestAttempts
```
@Deprecated
public int getMaxRequestAttempts()
```
    Deprecated. getMaxRetryAttempts is preferred because it more clearly gets the number of times a request should be retried after an error response is received.
    
    Sets the total maximum number of times an API request will be tried when error responses are received.
    
    Overrides:
    
    getMaxRequestAttempts in class BoxAPIConnection
    
    Returns:
    
    the maximum number of request attempts.
  - setMaxRequestAttempts
```
@Deprecated
public void setMaxRequestAttempts(int attempts)
```
    Deprecated. setMaxRetryAttempts is preferred because it more clearly sets the number of times a request should be retried after an error response is received.
    
    Sets the total maximum number of times an API request will be tried when error responses are received.
    
    Overrides:
    
    setMaxRequestAttempts in class BoxAPIConnection
    
    Parameters:
    
    attempts - the maximum number of request attempts.
  - getMaxRetryAttempts
```
public int getMaxRetryAttempts()
```
    Gets the maximum number of times an API request will be retried after an error response is received.
    
    Overrides:
    
    getMaxRetryAttempts in class BoxAPIConnection
    
    Returns:
    
    the maximum number of request attempts.
  - setMaxRetryAttempts
```
public void setMaxRetryAttempts(int attempts)
```
    Sets the maximum number of times an API request will be retried after an error response is received.
    
    Overrides:
    
    setMaxRetryAttempts in class BoxAPIConnection
    
    Parameters:
    
    attempts - the maximum number of request attempts.
  - canRefresh
```
public boolean canRefresh()
```
    Description copied from class: BoxAPIConnection
    
    Determines if this connection's access token can be refreshed. An access token cannot be refreshed if a refresh token was never set.
    
    Overrides:
    
    canRefresh in class BoxAPIConnection
    
    Returns:
    
    true if the access token can be refreshed; otherwise false.
  - needsRefresh
```
public boolean needsRefresh()
```
    Description copied from class: BoxAPIConnection
    
    Determines if this connection's access token has expired and needs to be refreshed.
    
    Overrides:
    
    needsRefresh in class BoxAPIConnection
    
    Returns:
    
    true if the access token needs to be refreshed; otherwise false.
  - refresh
```
public void refresh()
```
    Description copied from class: BoxAPIConnection
    
    Refresh's this connection's access token using its refresh token.
    
    Overrides:
    
    refresh in class BoxAPIConnection

Class SharedLinkAPIConnection

Nested Class Summary

Nested classes/interfaces inherited from class BoxAPIConnection

Field Summary

Fields inherited from class BoxAPIConnection

Method Summary

Methods inherited from class BoxAPIConnection

Methods inherited from class Object

Method Detail

getExpires

setExpires

getBaseURL

setBaseURL

getBaseUploadURL

setBaseUploadURL

getUserAgent

setUserAgent

getAccessToken

setAccessToken

getRefreshToken

setRefreshToken

setAutoRefresh

getAutoRefresh

getMaxRequestAttempts

setMaxRequestAttempts

getMaxRetryAttempts

setMaxRetryAttempts

canRefresh

needsRefresh

refresh