compile 'com.box:box-java-sdk:4.10.0'+
compile 'com.box:box-java-sdk:4.11.0'-
protected static enum BoxAPIConnection.ResourceLinkType +protected static enum BoxAPIConnection.ResourceLinkType extends Enum<BoxAPIConnection.ResourceLinkType>Used to categorize the types of resource links.@@ -160,7 +160,7 @@Enum Constant Detail
public static final BoxAPIConnection.ResourceLinkType Unknown+
public static final BoxAPIConnection.ResourceLinkType Unknown
public static final BoxAPIConnection.ResourceLinkType APIEndpoint+
public static final BoxAPIConnection.ResourceLinkType APIEndpoint
public static final BoxAPIConnection.ResourceLinkType SharedLink+
public static final BoxAPIConnection.ResourceLinkType SharedLink
public class BoxAPIConnection +public class BoxAPIConnection extends ObjectRepresents an authenticated connection to the Box API. @@ -223,32 +223,37 @@Method Summary
+ ++ protected Call+ createNewCall(OkHttpClient httpClient, + Request request)- protected BoxAPIRequestcreateTokenRequest(URL url)+ - protected BoxAPIConnection.ResourceLinkTypedetermineResourceLinkType(String resourceLink)Determines the type of resource, given a link to a Box resource.+ - voidenableNotifications()Re-enable email notifications from API actions if they have been suppressed.+ - protected voidextractTokens(JsonObject jsonObject)+ - StringgetAccessToken()Gets an access token that can be used to authenticate an API request.+ - static URLgetAuthorizationURL(String clientID, URI redirectUri, @@ -257,7 +262,7 @@Method Summary
Returns the default authorization URL which is used to perform the authorization_code based OAuth2 flow.+ - URLgetAuthorizationURL(URI redirectUri, String state, @@ -265,197 +270,197 @@Method Summary
Returns the authorization URL which is used to perform the authorization_code based OAuth2 flow.+ - booleangetAutoRefresh()Gets whether or not automatic refreshing of this connection's access token is enabled.+ - StringgetBaseAppUrl()Gets the base App url.+ - StringgetBaseUploadURL()Gets the base upload URL that's used when performing file uploads to Box.+ - StringgetBaseURL()Gets the base URL that's used when sending requests to the Box API.+ - StringgetClientID()Gets the client ID.+ - StringgetClientSecret()Gets the client secret.+ - intgetConnectTimeout()Gets the connect timeout for this connection in milliseconds.+ - longgetExpires()Gets the amount of time for which this connection's access token is valid.+ - protected HostnameVerifiergetHostnameVerifier()+ - protected StringgetKeyValueOrDefault(JsonObject json, String key, String defaultValue)+ - longgetLastRefresh()Gets the last time that the access token was refreshed.+ - ScopedTokengetLowerScopedToken(List<String> scopes, String resource)Get a lower-scoped token restricted to a resource for the list of scopes that are passed.+ - intgetMaxRetryAttempts()Gets the maximum number of times an API request will be retried after an error response is received.+ - ProxygetProxy()Gets the proxy value to use for API calls to Box.+ - StringgetProxyPassword()Gets the password to use for a proxy that requires basic auth.+ - StringgetProxyUsername()Gets the username to use for a proxy that requires basic auth.+ - intgetReadTimeout()Gets the read timeout for this connection in milliseconds.+ - protected ReadWriteLockgetRefreshLock()Gets the refresh lock to be used when refreshing an access token.+ - StringgetRefreshToken()Gets a refresh token that can be used to refresh an access token.+ - RequestInterceptorgetRequestInterceptor()Gets the RequestInterceptor associated with this API connection.+ - StringgetRevokeURL()Returns the URL used for token revocation.+ - StringgetTokenURL()Gets the token URL that's used to request access tokens.+ - protected X509TrustManagergetTrustManager()+ - StringgetUserAgent()Gets the user agent that's used when sending requests to the Box API.+ - protected OkHttpClient.BuildermodifyHttpClientBuilder(OkHttpClient.Builder httpClientBuilder)Can be used to modify OkHttp.Builder used to create connection.+ - booleanneedsRefresh()Determines if this connection's access token has expired and needs to be refreshed.+ - protected voidnotifyError(BoxAPIException error)Notifies an error event to all the listeners.+ - protected voidnotifyRefresh()Notifies a refresh event to all the listeners.+ - voidrefresh()Refresh's this connection's access token using its refresh token.+ - voidremoveCustomHeader(String header)Removes a custom header, so it will no longer be sent on requests through this API connection.+ - voidremoveListener(BoxAPIConnectionListener listener)Remove a listener listening to Box API connection events.+ - voidrestore(String state)Restores a saved connection state into this BoxAPIConnection.+ - static BoxAPIConnectionrestore(String clientID, String clientSecret, @@ -463,106 +468,106 @@Method Summary
Restores a BoxAPIConnection from a saved state.+ - voidrevokeToken()Revokes the tokens associated with this API connection.+ - Stringsave()Saves the state of this connection to a string so that it can be persisted and restored at a later time.+ - voidsetAccessToken(String accessToken)Sets the access token to use when authenticating API requests.+ - voidsetAutoRefresh(boolean autoRefresh)Enables or disables automatic refreshing of this connection's access token.+ - voidsetBaseAppUrl(String baseAppURL)Sets the base App url.+ - voidsetBaseAuthorizationURL(String baseAuthorizationURL)Sets authorization base URL which is used to perform the authorization_code based OAuth2 flow.+ - voidsetBaseUploadURL(String baseUploadURL)Sets the base upload URL to be used when performing file uploads to Box.+ - voidsetBaseURL(String baseURL)Sets the base URL to be used when sending requests to the Box API.+ - voidsetConnectTimeout(int connectTimeout)Sets the connect timeout for this connection.+ - voidsetCustomHeader(String header, String value)Sets a custom header to be sent on all requests through this API connection.+ - voidsetExpires(long milliseconds)Sets the amount of time for which this connection's access token is valid before it must be refreshed.+ - voidsetLastRefresh(long lastRefresh)Sets the last time that the access token was refreshed.+ - voidsetMaxRetryAttempts(int attempts)Sets the maximum number of times an API request will be retried after an error response is received.+ - voidsetProxy(Proxy proxy)Sets the proxy to use for API calls to Box.+ - voidsetProxyAuthenticator(Authenticator authenticator)Sets a proxy authenticator that will be used when proxy requires authentication.+ - voidsetProxyBasicAuthentication(String proxyUsername, String proxyPassword)Sets the proxy user and password used in basic authentication+ - voidsetProxyPassword(String proxyPassword)Deprecated. @@ -570,7 +575,7 @@Method Summary
+ - voidsetProxyUsername(String proxyUsername)Deprecated. @@ -578,31 +583,31 @@Method Summary
+ - voidsetReadTimeout(int readTimeout)Sets the read timeout for this connection.+ - voidsetRefreshToken(String refreshToken)Sets the refresh token to use when refreshing an access token.+ - voidsetRequestInterceptor(RequestInterceptor interceptor)Sets a RequestInterceptor that can intercept requests and manipulate them before they're sent to the Box API.+ - voidsetUserAgent(String userAgent)Sets the user agent to be used when sending requests to the Box API.+ voidsuppressNotifications()Suppresses email notifications from API actions.@@ -636,7 +641,7 @@Field Detail
DEFAULT_TRUST_MANAGER
-public static final X509TrustManager DEFAULT_TRUST_MANAGER+public static final X509TrustManager DEFAULT_TRUST_MANAGERUsed as a marker to setup connection to use default HostnameVerifier Example:BoxApiConnection api = new BoxApiConnection(...); @@ -651,7 +656,7 @@DEFAULT_TRUST_MANAGER
DEFAULT_HOSTNAME_VERIFIER
-public static final HostnameVerifier DEFAULT_HOSTNAME_VERIFIER+public static final HostnameVerifier DEFAULT_HOSTNAME_VERIFIERUsed as a marker to setup connection to use default HostnameVerifier Example:BoxApiConnection api = new BoxApiConnection(...); @@ -666,7 +671,7 @@DEFAULT_HOSTNAME_VERIFIER
DEFAULT_MAX_RETRIES
-public static final int DEFAULT_MAX_RETRIES+public static final int DEFAULT_MAX_RETRIESThe default maximum number of times an API request will be retried after an error response is received.@@ -681,7 +686,7 @@
DEFAULT_MAX_RETRIES
DEFAULT_BASE_AUTHORIZATION_URL
-protected static final String DEFAULT_BASE_AUTHORIZATION_URL+protected static final String DEFAULT_BASE_AUTHORIZATION_URLDefault authorization URL
- See Also:
@@ -703,7 +708,7 @@Constructor Detail
BoxAPIConnection
-public BoxAPIConnection(String accessToken)+public BoxAPIConnection(String accessToken)Constructs a new BoxAPIConnection that authenticates with a developer or access token.
- Parameters:
@@ -717,7 +722,7 @@BoxAPIConnection
BoxAPIConnection
-public BoxAPIConnection(String clientID, +public BoxAPIConnection(String clientID, String clientSecret, String accessToken, String refreshToken)@@ -737,7 +742,7 @@BoxAPIConnection
BoxAPIConnection
-public BoxAPIConnection(String clientID, +public BoxAPIConnection(String clientID, String clientSecret, String authCode)Constructs a new BoxAPIConnection with an auth code that was obtained from the first half of OAuth.@@ -755,7 +760,7 @@BoxAPIConnection
BoxAPIConnection
-public BoxAPIConnection(String clientID, +public BoxAPIConnection(String clientID, String clientSecret)Constructs a new BoxAPIConnection.@@ -771,7 +776,7 @@
BoxAPIConnection
BoxAPIConnection
-public BoxAPIConnection(BoxConfig boxConfig)+public BoxAPIConnection(BoxConfig boxConfig)Constructs a new BoxAPIConnection levaraging BoxConfig.
- Parameters:
@@ -793,7 +798,7 @@Method Detail
modifyHttpClientBuilder
-protected OkHttpClient.Builder modifyHttpClientBuilder(OkHttpClient.Builder httpClientBuilder)+protected OkHttpClient.Builder modifyHttpClientBuilder(OkHttpClient.Builder httpClientBuilder)Can be used to modify OkHttp.Builder used to create connection. This method is called after all modifications were done, thus allowing others to create their own connections and further customize builder.@@ -810,7 +815,7 @@
modifyHttpClientBuilder
setProxyAuthenticator
-public void setProxyAuthenticator(Authenticator authenticator)+public void setProxyAuthenticator(Authenticator authenticator)Sets a proxy authenticator that will be used when proxy requires authentication. If you usesetProxyBasicAuthentication(String, String)it adds an authenticator that performs Basic authorization. By calling this method you can override this behaviour. @@ -828,7 +833,7 @@setProxyAuthenticator
restore
-public static BoxAPIConnection restore(String clientID, +public static BoxAPIConnection restore(String clientID, String clientSecret, String state)Restores a BoxAPIConnection from a saved state.@@ -850,7 +855,7 @@restore
getAuthorizationURL
-public static URL getAuthorizationURL(String clientID, +public static URL getAuthorizationURL(String clientID, URI redirectUri, String state, List<String> scopes)@@ -875,7 +880,7 @@getAuthorizationURL
authenticate
-public void authenticate(String authCode)+public void authenticate(String authCode)Authenticates the API connection by obtaining access and refresh tokens using the auth code that was obtained from the first half of OAuth.@@ -890,7 +895,7 @@
authenticate
getClientID
-public String getClientID()+public String getClientID()Gets the client ID.
- Returns:
@@ -904,7 +909,7 @@getClientID
getClientSecret
-public String getClientSecret()+public String getClientSecret()Gets the client secret.
- Returns:
@@ -918,7 +923,7 @@getClientSecret
getExpires
-public long getExpires()+public long getExpires()Gets the amount of time for which this connection's access token is valid.
- Returns:
@@ -932,7 +937,7 @@getExpires
setExpires
-public void setExpires(long milliseconds)+public void setExpires(long milliseconds)Sets the amount of time for which this connection's access token is valid before it must be refreshed.
- Parameters:
@@ -946,7 +951,7 @@setExpires
getTokenURL
-public String getTokenURL()+public String getTokenURL()Gets the token URL that's used to request access tokens. The default value is "https://www.box.com/api/oauth2/token". The URL is created from@@ -962,7 +967,7 @@baseURLandTOKEN_URL_SUFFIX.getTokenURL
getRevokeURL
-public String getRevokeURL()+public String getRevokeURL()Returns the URL used for token revocation. The URL is created frombaseURLandREVOKE_URL_SUFFIX.@@ -977,7 +982,7 @@
getRevokeURL
getBaseURL
-public String getBaseURL()+public String getBaseURL()Gets the base URL that's used when sending requests to the Box API. The URL is created from@@ -993,7 +998,7 @@baseURLandAPI_VERSION. The default value is "https://api.box.com/2.0/".getBaseURL
setBaseURL
-public void setBaseURL(String baseURL)+public void setBaseURL(String baseURL)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/". This method changes how@@ -1009,7 +1014,7 @@getRevokeURL()andgetTokenURL()are constructed.setBaseURL
getBaseUploadURL
-public String getBaseUploadURL()+public String getBaseUploadURL()Gets the base upload URL that's used when performing file uploads to Box. The URL is created frombaseUploadURLandAPI_VERSION.@@ -1024,7 +1029,7 @@
getBaseUploadURL
setBaseUploadURL
-public void setBaseUploadURL(String baseUploadURL)+public void setBaseUploadURL(String baseUploadURL)Sets the base upload URL to be used when performing file uploads to Box.
- Parameters:
@@ -1038,7 +1043,7 @@setBaseUploadURL
getAuthorizationURL
-public URL getAuthorizationURL(URI redirectUri, +public URL getAuthorizationURL(URI redirectUri, String state, List<String> scopes)Returns the authorization URL which is used to perform the authorization_code based OAuth2 flow. @@ -1061,7 +1066,7 @@getAuthorizationURL
setBaseAuthorizationURL
-public void setBaseAuthorizationURL(String baseAuthorizationURL)+public void setBaseAuthorizationURL(String baseAuthorizationURL)Sets authorization base URL which is used to perform the authorization_code based OAuth2 flow.
- Parameters:
@@ -1075,7 +1080,7 @@setBaseAuthorizationURL
getUserAgent
-public String getUserAgent()+public String getUserAgent()Gets the user agent that's used when sending requests to the Box API.
- Returns:
@@ -1089,7 +1094,7 @@getUserAgent
setUserAgent
-public void setUserAgent(String userAgent)+public void setUserAgent(String userAgent)Sets the user agent to be used when sending requests to the Box API.
- Parameters:
@@ -1103,7 +1108,7 @@setUserAgent
getBaseAppUrl
-public String getBaseAppUrl()+public String getBaseAppUrl()Gets the base App url. Used for e.g. file requests.
- Returns:
@@ -1117,7 +1122,7 @@getBaseAppUrl
setBaseAppUrl
-public void setBaseAppUrl(String baseAppURL)+public void setBaseAppUrl(String baseAppURL)Sets the base App url. Used for e.g. file requests.
- Parameters:
@@ -1131,7 +1136,7 @@setBaseAppUrl
getAccessToken
-public String getAccessToken()+public String getAccessToken()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 togetAccessToken().@@ -1146,7 +1151,7 @@
getAccessToken
setAccessToken
-public void setAccessToken(String accessToken)+public void setAccessToken(String accessToken)Sets the access token to use when authenticating API requests.
- Parameters:
@@ -1160,7 +1165,7 @@setAccessToken
getRefreshLock
-protected ReadWriteLock getRefreshLock()+protected ReadWriteLock getRefreshLock()Gets the refresh lock to be used when refreshing an access token.
- Returns:
@@ -1174,7 +1179,7 @@getRefreshLock
getRefreshToken
-public String getRefreshToken()+public String getRefreshToken()Gets a refresh token that can be used to refresh an access token.
- Returns:
@@ -1188,7 +1193,7 @@getRefreshToken
setRefreshToken
-public void setRefreshToken(String refreshToken)+public void setRefreshToken(String refreshToken)Sets the refresh token to use when refreshing an access token.
- Parameters:
@@ -1202,7 +1207,7 @@setRefreshToken
getLastRefresh
-public long getLastRefresh()+public long getLastRefresh()Gets the last time that the access token was refreshed.
- Returns:
@@ -1216,7 +1221,7 @@getLastRefresh
setLastRefresh
-public void setLastRefresh(long lastRefresh)+public void setLastRefresh(long lastRefresh)Sets the last time that the access token was refreshed.This value is used when determining if an access token needs to be auto-refreshed. If the amount of time since @@ -1233,7 +1238,7 @@
setLastRefresh
getAutoRefresh
-public boolean getAutoRefresh()+public boolean getAutoRefresh()Gets whether or not automatic refreshing of this connection's access token is enabled. Defaults to true.
- Returns:
@@ -1247,7 +1252,7 @@getAutoRefresh
setAutoRefresh
-public void setAutoRefresh(boolean autoRefresh)+public void setAutoRefresh(boolean autoRefresh)Enables or disables automatic refreshing of this connection's access token. Defaults to true.
- Parameters:
@@ -1261,7 +1266,7 @@setAutoRefresh
getMaxRetryAttempts
-public int getMaxRetryAttempts()+public int getMaxRetryAttempts()Gets the maximum number of times an API request will be retried after an error response is received.@@ -1276,7 +1281,7 @@
getMaxRetryAttempts
setMaxRetryAttempts
-public void setMaxRetryAttempts(int attempts)+public void setMaxRetryAttempts(int attempts)Sets the maximum number of times an API request will be retried after an error response is received.@@ -1291,7 +1296,7 @@
setMaxRetryAttempts
getConnectTimeout
-public int getConnectTimeout()+public int getConnectTimeout()Gets the connect timeout for this connection in milliseconds.
- Returns:
@@ -1305,7 +1310,7 @@getConnectTimeout
setConnectTimeout
-public void setConnectTimeout(int connectTimeout)+public void setConnectTimeout(int connectTimeout)Sets the connect timeout for this connection.
- Parameters:
@@ -1319,7 +1324,7 @@setConnectTimeout
getReadTimeout
-public int getReadTimeout()+public int getReadTimeout()Gets the read timeout for this connection in milliseconds.
- Returns:
@@ -1333,7 +1338,7 @@getReadTimeout
setReadTimeout
-public void setReadTimeout(int readTimeout)+public void setReadTimeout(int readTimeout)Sets the read timeout for this connection.
- Parameters:
@@ -1347,7 +1352,7 @@setReadTimeout
getProxy
-public Proxy getProxy()+public Proxy getProxy()Gets the proxy value to use for API calls to Box.
- Returns:
@@ -1361,7 +1366,7 @@getProxy
setProxy
-public void setProxy(Proxy proxy)+public void setProxy(Proxy proxy)Sets the proxy to use for API calls to Box.
- Parameters:
@@ -1375,7 +1380,7 @@setProxy
getProxyUsername
-public String getProxyUsername()+public String getProxyUsername()Gets the username to use for a proxy that requires basic auth.
- Returns:
@@ -1389,7 +1394,7 @@getProxyUsername
setProxyUsername
-public void setProxyUsername(String proxyUsername)+public void setProxyUsername(String proxyUsername)Deprecated. UsesetProxyBasicAuthentication(String, String)Sets the username to use for a proxy that requires basic auth.@@ -1404,7 +1409,7 @@
setProxyUsername
getProxyPassword
-public String getProxyPassword()+public String getProxyPassword()Gets the password to use for a proxy that requires basic auth.
- Returns:
@@ -1418,7 +1423,7 @@getProxyPassword
setProxyBasicAuthentication
-public void setProxyBasicAuthentication(String proxyUsername, +public void setProxyBasicAuthentication(String proxyUsername, String proxyPassword)Sets the proxy user and password used in basic authentication@@ -1434,7 +1439,7 @@
setProxyBasicAuthentication
setProxyPassword
-public void setProxyPassword(String proxyPassword)+public void setProxyPassword(String proxyPassword)Deprecated. UsesetProxyBasicAuthentication(String, String)Sets the password to use for a proxy that requires basic auth.@@ -1449,7 +1454,7 @@
setProxyPassword
canRefresh
-public boolean canRefresh()+public boolean canRefresh()Determines if this connection's access token can be refreshed. An access token cannot be refreshed if a refresh token was never set.@@ -1464,7 +1469,7 @@
canRefresh
needsRefresh
-public boolean needsRefresh()+public boolean needsRefresh()Determines if this connection's access token has expired and needs to be refreshed.
- Returns:
@@ -1478,7 +1483,7 @@needsRefresh
refresh
-public void refresh()+public void refresh()Refresh's this connection's access token using its refresh token.
- Throws:
@@ -1492,7 +1497,7 @@refresh
restore
-public void restore(String state)+public void restore(String state)Restores a saved connection state into this BoxAPIConnection.
- Parameters:
@@ -1508,7 +1513,7 @@restore
- @@ -1519,7 +1524,7 @@
getKeyValueOrDefault
-protected String getKeyValueOrDefault(JsonObject json, +protected String getKeyValueOrDefault(JsonObject json, String key, String defaultValue)getKeyValueOrDefault
@@ -1529,7 +1534,7 @@
notifyRefresh
-protected void notifyRefresh()+protected void notifyRefresh()Notifies a refresh event to all the listeners.notifyRefresh
notifyError
-protected void notifyError(BoxAPIException error)+protected void notifyError(BoxAPIException error)Notifies an error event to all the listeners.
- Parameters:
@@ -1543,7 +1548,7 @@notifyError
addListener
-public void addListener(BoxAPIConnectionListener listener)+public void addListener(BoxAPIConnectionListener listener)Add a listener to listen to Box API connection events.
- Parameters:
@@ -1557,7 +1562,7 @@addListener
removeListener
-public void removeListener(BoxAPIConnectionListener listener)+public void removeListener(BoxAPIConnectionListener listener)Remove a listener listening to Box API connection events.
- Parameters:
@@ -1571,7 +1576,7 @@removeListener
getRequestInterceptor
-public RequestInterceptor getRequestInterceptor()+public RequestInterceptor getRequestInterceptor()Gets the RequestInterceptor associated with this API connection.
- Returns:
@@ -1585,7 +1590,7 @@getRequestInterceptor
setRequestInterceptor
-public void setRequestInterceptor(RequestInterceptor interceptor)+public void setRequestInterceptor(RequestInterceptor interceptor)Sets a RequestInterceptor that can intercept requests and manipulate them before they're sent to the Box API.
- Parameters:
@@ -1599,7 +1604,7 @@setRequestInterceptor
getLowerScopedToken
-public ScopedToken getLowerScopedToken(List<String> scopes, +public ScopedToken getLowerScopedToken(List<String> scopes, String resource)Get a lower-scoped token restricted to a resource for the list of scopes that are passed.@@ -1619,7 +1624,7 @@
getLowerScopedToken
determineResourceLinkType
-protected BoxAPIConnection.ResourceLinkType determineResourceLinkType(String resourceLink)+protected BoxAPIConnection.ResourceLinkType determineResourceLinkType(String resourceLink)Determines the type of resource, given a link to a Box resource.
- Parameters:
@@ -1635,7 +1640,7 @@determineResourceLinkType
- @@ -1646,7 +1651,7 @@
revokeToken
-public void revokeToken()+public void revokeToken()Revokes the tokens associated with this API connection. This results in the connection no longer being able to make API calls until a fresh authorization is made by calling authenticate()revokeToken
save
-public String save()+public String save()Saves the state of this connection to a string so that it can be persisted and restored at a later time.Note that proxy settings aren't automatically saved or restored. This is mainly due to security concerns @@ -1666,7 +1671,7 @@
save
setCustomHeader
-public void setCustomHeader(String header, +public void setCustomHeader(String header, String value)Sets a custom header to be sent on all requests through this API connection.@@ -1682,7 +1687,7 @@
setCustomHeader
removeCustomHeader
-public void removeCustomHeader(String header)+public void removeCustomHeader(String header)Removes a custom header, so it will no longer be sent on requests through this API connection.
- Parameters:
@@ -1696,7 +1701,7 @@removeCustomHeader
- @@ -1707,7 +1712,7 @@
suppressNotifications
-public void suppressNotifications()+public void suppressNotifications()Suppresses email notifications from API actions. This is typically used by security or admin applications to prevent spamming end users when doing automated processing on their content.suppressNotifications
enableNotifications
-public void enableNotifications()+public void enableNotifications()Re-enable email notifications from API actions if they have been suppressed.
- See Also:
@@ -1721,7 +1726,7 @@enableNotifications
asUser
-public void asUser(String userID)+public void asUser(String userID)Set this API connection to make API calls on behalf of another users, impersonating them. This functionality can only be used by admins and service accounts.@@ -1736,7 +1741,7 @@
asUser
asSelf
-public void asSelf()+public void asSelf()Sets this API connection to make API calls on behalf of the user with whom the access token is associated. This undoes any previous calls to asUser().@@ -1751,7 +1756,7 @@
asSelf
configureSslCertificatesValidation
-public void configureSslCertificatesValidation(X509TrustManager trustManager, +public void configureSslCertificatesValidation(X509TrustManager trustManager, HostnameVerifier hostnameVerifier)Used to override default SSL certification handling. For example, you can provide your own trust manager or hostname verifier to allow self-signed certificates. @@ -1769,7 +1774,7 @@configureSslCertificatesValidation
@@ -1778,7 +1783,17 @@
extractTokens
-protected void extractTokens(JsonObject jsonObject)+protected void extractTokens(JsonObject jsonObject)extractTokens
+ + + +
- +
createTokenRequest
-protected BoxAPIRequest createTokenRequest(URL url)+protected BoxAPIRequest createTokenRequest(URL url)++
@@ -1787,7 +1802,7 @@- +
createNewCall
+protected Call createNewCall(OkHttpClient httpClient, + Request request)createTokenRequest
@@ -1796,7 +1811,7 @@
getTrustManager
-protected X509TrustManager getTrustManager()+protected X509TrustManager getTrustManager()getTrustManager
diff --git a/javadoc/com/box/sdk/BoxCCGAPIConnection.html b/javadoc/com/box/sdk/BoxCCGAPIConnection.html index c9d2b911b..72bac6790 100644 --- a/javadoc/com/box/sdk/BoxCCGAPIConnection.html +++ b/javadoc/com/box/sdk/BoxCCGAPIConnection.html @@ -163,7 +163,7 @@
getHostnameVerifier
-protected HostnameVerifier getHostnameVerifier()+protected HostnameVerifier getHostnameVerifier()Method Summary
Methods inherited from class BoxAPIConnection
-addListener, asSelf, asUser, authenticate, configureSslCertificatesValidation, determineResourceLinkType, enableNotifications, getAccessToken, getAuthorizationURL, getAuthorizationURL, getAutoRefresh, getBaseAppUrl, getBaseUploadURL, getBaseURL, getClientID, getClientSecret, getConnectTimeout, getExpires, getHostnameVerifier, getKeyValueOrDefault, getLastRefresh, getLowerScopedToken, getMaxRetryAttempts, getProxy, getProxyPassword, getProxyUsername, getReadTimeout, getRefreshLock, getRefreshToken, getRequestInterceptor, getRevokeURL, getTokenURL, getTrustManager, getUserAgent, modifyHttpClientBuilder, needsRefresh, notifyError, notifyRefresh, refresh, removeCustomHeader, removeListener, revokeToken, setAccessToken, setAutoRefresh, setBaseAppUrl, setBaseAuthorizationURL, setBaseUploadURL, setBaseURL, setConnectTimeout, setCustomHeader, setExpires, setLastRefresh, setMaxRetryAttempts, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRefreshToken, setRequestInterceptor, setUserAgent, suppressNotifications+addListener, asSelf, asUser, authenticate, configureSslCertificatesValidation, createNewCall, determineResourceLinkType, enableNotifications, getAccessToken, getAuthorizationURL, getAuthorizationURL, getAutoRefresh, getBaseAppUrl, getBaseUploadURL, getBaseURL, getClientID, getClientSecret, getConnectTimeout, getExpires, getHostnameVerifier, getKeyValueOrDefault, getLastRefresh, getLowerScopedToken, getMaxRetryAttempts, getProxy, getProxyPassword, getProxyUsername, getReadTimeout, getRefreshLock, getRefreshToken, getRequestInterceptor, getRevokeURL, getTokenURL, getTrustManager, getUserAgent, modifyHttpClientBuilder, needsRefresh, notifyError, notifyRefresh, refresh, removeCustomHeader, removeListener, revokeToken, setAccessToken, setAutoRefresh, setBaseAppUrl, setBaseAuthorizationURL, setBaseUploadURL, setBaseURL, setConnectTimeout, setCustomHeader, setExpires, setLastRefresh, setMaxRetryAttempts, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRefreshToken, setRequestInterceptor, setUserAgent, suppressNotifications
- diff --git a/javadoc/com/box/sdk/BoxDeveloperEditionAPIConnection.html b/javadoc/com/box/sdk/BoxDeveloperEditionAPIConnection.html index f03c7b0b4..97403e0f0 100644 --- a/javadoc/com/box/sdk/BoxDeveloperEditionAPIConnection.html +++ b/javadoc/com/box/sdk/BoxDeveloperEditionAPIConnection.html @@ -234,7 +234,7 @@
+Method Summary
Methods inherited from class BoxAPIConnection
-addListener, asSelf, asUser, configureSslCertificatesValidation, createTokenRequest, determineResourceLinkType, enableNotifications, extractTokens, getAccessToken, getAuthorizationURL, getAuthorizationURL, getAutoRefresh, getBaseAppUrl, getBaseUploadURL, getBaseURL, getClientID, getClientSecret, getConnectTimeout, getExpires, getHostnameVerifier, getKeyValueOrDefault, getLastRefresh, getLowerScopedToken, getMaxRetryAttempts, getProxy, getProxyPassword, getProxyUsername, getReadTimeout, getRefreshLock, getRefreshToken, getRequestInterceptor, getRevokeURL, getTokenURL, getTrustManager, getUserAgent, modifyHttpClientBuilder, needsRefresh, notifyError, notifyRefresh, removeCustomHeader, removeListener, restore, restore, revokeToken, save, setAccessToken, setAutoRefresh, setBaseAppUrl, setBaseAuthorizationURL, setBaseUploadURL, setBaseURL, setConnectTimeout, setCustomHeader, setExpires, setLastRefresh, setMaxRetryAttempts, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRefreshToken, setRequestInterceptor, setUserAgent, suppressNotificationsaddListener, asSelf, asUser, configureSslCertificatesValidation, createNewCall, createTokenRequest, determineResourceLinkType, enableNotifications, extractTokens, getAccessToken, getAuthorizationURL, getAuthorizationURL, getAutoRefresh, getBaseAppUrl, getBaseUploadURL, getBaseURL, getClientID, getClientSecret, getConnectTimeout, getExpires, getHostnameVerifier, getKeyValueOrDefault, getLastRefresh, getLowerScopedToken, getMaxRetryAttempts, getProxy, getProxyPassword, getProxyUsername, getReadTimeout, getRefreshLock, getRefreshToken, getRequestInterceptor, getRevokeURL, getTokenURL, getTrustManager, getUserAgent, modifyHttpClientBuilder, needsRefresh, notifyError, notifyRefresh, removeCustomHeader, removeListener, restore, restore, revokeToken, save, setAccessToken, setAutoRefresh, setBaseAppUrl, setBaseAuthorizationURL, setBaseUploadURL, setBaseURL, setConnectTimeout, setCustomHeader, setExpires, setLastRefresh, setMaxRetryAttempts, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRefreshToken, setRequestInterceptor, setUserAgent, suppressNotifications
- diff --git a/javadoc/com/box/sdk/BoxJSONObject.html b/javadoc/com/box/sdk/BoxJSONObject.html index 700532326..a24495b15 100644 --- a/javadoc/com/box/sdk/BoxJSONObject.html +++ b/javadoc/com/box/sdk/BoxJSONObject.html @@ -47,7 +47,7 @@
+Class BoxJSONObject
- Direct Known Subclasses:
-- BoxAIDialogueEntry, BoxAIResponse, BoxClassification, BoxEnterprise, BoxFileUploadSession.Endpoints, BoxFileUploadSessionPart, BoxFileUploadSessionPartList, BoxLock, BoxMetadataQueryItem, BoxNotificationEmail, BoxRecentItem, BoxResource.Info, BoxSearchSharedLink, BoxSharedLink, BoxSharedLink.Permissions, BoxSignRequestPrefillTag, BoxSignRequestSigner, BoxSignRequestSigner.BoxSignerDecision, BoxSignRequestSigner.BoxSignerInput, BoxSignTemplateSigner, BoxSignTemplateSigner.BoxSignTemplateSignerInput, BoxUploadEmail, BoxWatermark, BoxZipConflict, BoxZipConflictItem, BoxZipDownloadStatus, BoxZipInfo, EmailAlias, MetadataTemplate, MetadataTemplate.Field, MetadataTemplate.FieldOperation, MetadataTemplate.Option, ScopedToken
+- BoxAIDialogueEntry, BoxAIResponse, BoxClassification, BoxEnterprise, BoxFileUploadSession.Endpoints, BoxFileUploadSessionPart, BoxFileUploadSessionPartList, BoxLock, BoxMetadataQueryItem, BoxNotificationEmail, BoxRecentItem, BoxResource.Info, BoxSearchSharedLink, BoxSharedLink, BoxSharedLink.Permissions, BoxSignRequestPrefillTag, BoxSignRequestSigner, BoxSignRequestSigner.BoxSignerDecision, BoxSignRequestSigner.BoxSignerInput, BoxSignTemplateSigner, BoxSignTemplateSigner.BoxSignTemplateSignerInput, BoxUploadEmail, BoxWatermark, BoxZipConflict, BoxZipConflictItem, BoxZipDownloadStatus, BoxZipInfo, EmailAlias, MetadataTemplate, MetadataTemplate.Field, MetadataTemplate.FieldOperation, MetadataTemplate.Option, MetadataTemplate.StaticConfig, ScopedToken
diff --git a/javadoc/com/box/sdk/BoxTransactionalAPIConnection.html b/javadoc/com/box/sdk/BoxTransactionalAPIConnection.html index 744d33e9e..d355e0f0a 100644 --- a/javadoc/com/box/sdk/BoxTransactionalAPIConnection.html +++ b/javadoc/com/box/sdk/BoxTransactionalAPIConnection.html @@ -169,7 +169,7 @@Method Summary
Methods inherited from class BoxAPIConnection
-addListener, asSelf, asUser, configureSslCertificatesValidation, createTokenRequest, determineResourceLinkType, enableNotifications, extractTokens, getAccessToken, getAuthorizationURL, getAuthorizationURL, getAutoRefresh, getBaseAppUrl, getBaseUploadURL, getBaseURL, getClientID, getClientSecret, getConnectTimeout, getExpires, getHostnameVerifier, getKeyValueOrDefault, getLastRefresh, getLowerScopedToken, getMaxRetryAttempts, getProxy, getProxyPassword, getProxyUsername, getReadTimeout, getRefreshLock, getRefreshToken, getRequestInterceptor, getRevokeURL, getTokenURL, getTrustManager, getUserAgent, modifyHttpClientBuilder, needsRefresh, notifyError, notifyRefresh, removeCustomHeader, removeListener, restore, restore, revokeToken, save, setAccessToken, setBaseAppUrl, setBaseAuthorizationURL, setBaseUploadURL, setBaseURL, setConnectTimeout, setCustomHeader, setExpires, setLastRefresh, setMaxRetryAttempts, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRefreshToken, setRequestInterceptor, setUserAgent, suppressNotificationsaddListener, asSelf, asUser, configureSslCertificatesValidation, createNewCall, createTokenRequest, determineResourceLinkType, enableNotifications, extractTokens, getAccessToken, getAuthorizationURL, getAuthorizationURL, getAutoRefresh, getBaseAppUrl, getBaseUploadURL, getBaseURL, getClientID, getClientSecret, getConnectTimeout, getExpires, getHostnameVerifier, getKeyValueOrDefault, getLastRefresh, getLowerScopedToken, getMaxRetryAttempts, getProxy, getProxyPassword, getProxyUsername, getReadTimeout, getRefreshLock, getRefreshToken, getRequestInterceptor, getRevokeURL, getTokenURL, getTrustManager, getUserAgent, modifyHttpClientBuilder, needsRefresh, notifyError, notifyRefresh, removeCustomHeader, removeListener, restore, restore, revokeToken, save, setAccessToken, setBaseAppUrl, setBaseAuthorizationURL, setBaseUploadURL, setBaseURL, setConnectTimeout, setCustomHeader, setExpires, setLastRefresh, setMaxRetryAttempts, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRefreshToken, setRequestInterceptor, setUserAgent, suppressNotifications
- diff --git a/javadoc/com/box/sdk/MetadataTemplate.Field.html b/javadoc/com/box/sdk/MetadataTemplate.Field.html index e0beb9ae1..4a4310600 100644 --- a/javadoc/com/box/sdk/MetadataTemplate.Field.html +++ b/javadoc/com/box/sdk/MetadataTemplate.Field.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -56,7 +56,7 @@
@@ -150,48 +150,60 @@Class MetadataTemplate.Fi
-public static class MetadataTemplate.Field +public static class MetadataTemplate.Field extends BoxJSONObjectClass contains information about the metadata template field.Method Summary
+ ++ MetadataTemplate.StaticConfig+ getStaticConfig()+Gets static configuration for the classification.+- StringgetType()Gets the data type of the field's value.+ - voidsetCopyInstanceOnItemCopy(Boolean copyInstanceOnItemCopy)Sets whether the copy operation should copy the metadata along with the item.+ - voidsetDescription(String description)Sets the description of the field.+ - voidsetDisplayName(String displayName)Sets the display name of the field.+ - voidsetIsHidden(boolean isHidden)Sets is metadata template field hidden.+ - voidsetKey(String key)Sets the key of the field.+ - voidsetOptions(List<String> options)Sets list of possible options for enum type of the field.+ + ++ void+ setStaticConfig(MetadataTemplate.StaticConfig staticConfig)+Sets static configuration for the classification.++ voidsetType(String type)Sets the data type of the field's value.@@ -232,7 +244,7 @@Constructor Detail
@@ -242,7 +254,7 @@Field
Field
-public Field(String json)+public Field(String json)Constructs a metadate template field from a JSON string.
- Parameters:
@@ -264,7 +276,7 @@Method Detail
getID
-public String getID()+public String getID()Gets the ID of the template field.
- Returns:
@@ -278,7 +290,7 @@getID
getType
-public String getType()+public String getType()Gets the data type of the field's value.
- Returns:
@@ -292,7 +304,7 @@getType
setType
-public void setType(String type)+public void setType(String type)Sets the data type of the field's value.
- Parameters:
@@ -306,7 +318,7 @@setType
getKey
-public String getKey()+public String getKey()Gets the key of the field.
- Returns:
@@ -320,7 +332,7 @@getKey
setKey
-public void setKey(String key)+public void setKey(String key)Sets the key of the field.
- Parameters:
@@ -334,7 +346,7 @@setKey
getDisplayName
-public String getDisplayName()+public String getDisplayName()Gets the display name of the field.
- Returns:
@@ -348,7 +360,7 @@getDisplayName
setDisplayName
-public void setDisplayName(String displayName)+public void setDisplayName(String displayName)Sets the display name of the field.
- Parameters:
@@ -362,7 +374,7 @@setDisplayName
getIsHidden
-public Boolean getIsHidden()+public Boolean getIsHidden()Gets is metadata template field hidden.
- Returns:
@@ -376,7 +388,7 @@getIsHidden
setIsHidden
-public void setIsHidden(boolean isHidden)+public void setIsHidden(boolean isHidden)Sets is metadata template field hidden.
- Parameters:
@@ -390,7 +402,7 @@setIsHidden
getDescription
-public String getDescription()+public String getDescription()Gets the description of the field.
- Returns:
@@ -404,7 +416,7 @@getDescription
setDescription
-public void setDescription(String description)+public void setDescription(String description)Sets the description of the field.
- Parameters:
@@ -418,7 +430,7 @@setDescription
getOptions
-public List<String> getOptions()+public List<String> getOptions()Gets list of possible options for enum type of the field.
- Returns:
@@ -432,7 +444,7 @@getOptions
setOptions
-public void setOptions(List<String> options)+public void setOptions(List<String> options)Sets list of possible options for enum type of the field.
- Parameters:
@@ -446,7 +458,7 @@setOptions
- diff --git a/javadoc/com/box/sdk/MetadataTemplate.FieldOperation.html b/javadoc/com/box/sdk/MetadataTemplate.FieldOperation.html index 397eb3a9d..9b12a5747 100644 --- a/javadoc/com/box/sdk/MetadataTemplate.FieldOperation.html +++ b/javadoc/com/box/sdk/MetadataTemplate.FieldOperation.html @@ -56,7 +56,7 @@
getOptionsObjects
-public List<MetadataTemplate.Option> getOptionsObjects()+public List<MetadataTemplate.Option> getOptionsObjects()Gets list of possible options for options type of the field.
- Returns:
@@ -460,7 +472,7 @@getOptionsObjects
getCopyInstanceOnItemCopy
-public Boolean getCopyInstanceOnItemCopy()+public Boolean getCopyInstanceOnItemCopy()Gets whether the copy operation should copy the metadata along with the item.
- Returns:
@@ -471,10 +483,10 @@getCopyInstanceOnItemCopy
-+
+ + + +
setCopyInstanceOnItemCopy
-public void setCopyInstanceOnItemCopy(Boolean copyInstanceOnItemCopy)+public void setCopyInstanceOnItemCopy(Boolean copyInstanceOnItemCopy)Sets whether the copy operation should copy the metadata along with the item.
- Parameters:
@@ -482,6 +494,34 @@setCopyInstanceOnItemCopy
+
+ + + +- +
+getStaticConfig
+public MetadataTemplate.StaticConfig getStaticConfig()+Gets static configuration for the classification.++
+- Returns:
+- static configuration for the classification.
++
- +
+setStaticConfig
+public void setStaticConfig(MetadataTemplate.StaticConfig staticConfig)+Sets static configuration for the classification.++
+- Parameters:
+- +
staticConfig- static configuration for the classification.Class MetadataTe
-public static class MetadataTemplate.FieldOperation +public static class MetadataTemplate.FieldOperation extends BoxJSONObjectPosssible operations that can be performed in a Metadata template.@@ -249,7 +249,7 @@
Constructor Detail
@@ -259,7 +259,7 @@
FieldOperation
-public FieldOperation()+public FieldOperation()Constructs an empty FieldOperation.FieldOperation
FieldOperation
-public FieldOperation(String json)+public FieldOperation(String json)Constructs a Field operation from a JSON string.
- Parameters:
@@ -281,7 +281,7 @@Method Detail
getOp
-public MetadataTemplate.Operation getOp()+public MetadataTemplate.Operation getOp()Gets the operation.
- Returns:
@@ -295,7 +295,7 @@getOp
setOp
-public void setOp(MetadataTemplate.Operation op)+public void setOp(MetadataTemplate.Operation op)Sets the operation.
- Parameters:
@@ -309,7 +309,7 @@setOp
getData
-public MetadataTemplate.Field getData()+public MetadataTemplate.Field getData()Gets the data associated with the operation.
- Returns:
@@ -323,7 +323,7 @@getData
setData
-public void setData(MetadataTemplate.Field data)+public void setData(MetadataTemplate.Field data)Sets the data.
- Parameters:
@@ -337,7 +337,7 @@setData
getFieldKey
-public String getFieldKey()+public String getFieldKey()Gets the field key.
- Returns:
@@ -351,7 +351,7 @@getFieldKey
setFieldKey
-public void setFieldKey(String fieldKey)+public void setFieldKey(String fieldKey)Sets the field key.
- Parameters:
@@ -365,7 +365,7 @@setFieldKey
getFieldKeys
-public List<String> getFieldKeys()+public List<String> getFieldKeys()Gets the list of field keys.
- Returns:
@@ -379,7 +379,7 @@getFieldKeys
setFieldKeys
-public void setFieldKeys(List<String> fieldKeys)+public void setFieldKeys(List<String> fieldKeys)Sets the list of the field keys.
- Parameters:
@@ -393,7 +393,7 @@setFieldKeys
getEnumOptionKeys
-public List<String> getEnumOptionKeys()+public List<String> getEnumOptionKeys()Gets the list of keys of the Enum options.
- Returns:
@@ -407,7 +407,7 @@getEnumOptionKeys
setEnumOptionKeys
-public void setEnumOptionKeys(List<String> enumOptionKeys)+public void setEnumOptionKeys(List<String> enumOptionKeys)Sets the list of the enum option keys.
- Parameters:
@@ -421,7 +421,7 @@setEnumOptionKeys
getEnumOptionKey
-public String getEnumOptionKey()+public String getEnumOptionKey()Gets the enum option key.
- Returns:
@@ -435,7 +435,7 @@getEnumOptionKey
setEnumOptionKey
-public void setEnumOptionKey(String enumOptionKey)+public void setEnumOptionKey(String enumOptionKey)Sets the enum option key.
- Parameters:
@@ -449,7 +449,7 @@setEnumOptionKey
getMultiSelectOptionKey
-public String getMultiSelectOptionKey()+public String getMultiSelectOptionKey()Gets the multi-select option key.
- Returns:
@@ -463,7 +463,7 @@getMultiSelectOptionKey
setMultiSelectOptionKey
-public void setMultiSelectOptionKey(String key)+public void setMultiSelectOptionKey(String key)Sets the multi-select option key.
- Parameters:
@@ -477,7 +477,7 @@setMultiSelectOptionKey
getMultiSelectOptionKeys
-public List<String> getMultiSelectOptionKeys()+public List<String> getMultiSelectOptionKeys()Gets the list of multiselect option keys.
- Returns:
@@ -491,7 +491,7 @@getMultiSelectOptionKeys
setMultiSelectOptionKeys
-public void setMultiSelectOptionKeys(List<String> keys)+public void setMultiSelectOptionKeys(List<String> keys)Sets the multi-select option keys.
- Parameters:
@@ -505,7 +505,7 @@setMultiSelectOptionKeys
- @@ -208,7 +208,7 @@
clearPendingChanges
-public void clearPendingChanges()+public void clearPendingChanges()Description copied from class:BoxJSONObjectClears any pending changes from this JSON object.diff --git a/javadoc/com/box/sdk/MetadataTemplate.Operation.html b/javadoc/com/box/sdk/MetadataTemplate.Operation.html index 52bec3ec4..6118157c9 100644 --- a/javadoc/com/box/sdk/MetadataTemplate.Operation.html +++ b/javadoc/com/box/sdk/MetadataTemplate.Operation.html @@ -60,7 +60,7 @@
Enum MetadataTemplate.
-public static enum MetadataTemplate.Operation +public static enum MetadataTemplate.Operation extends Enum<MetadataTemplate.Operation>Possible template operations.Enum Constant Detail
@@ -218,7 +218,7 @@
addEnumOption
-public static final MetadataTemplate.Operation addEnumOption+public static final MetadataTemplate.Operation addEnumOptionAdds an enum option at the end of the enum option list for the specified field.addEnumOption
@@ -228,7 +228,7 @@
editEnumOption
-public static final MetadataTemplate.Operation editEnumOption+public static final MetadataTemplate.Operation editEnumOptionEdits the enum option.editEnumOption
@@ -238,7 +238,7 @@
removeEnumOption
-public static final MetadataTemplate.Operation removeEnumOption+public static final MetadataTemplate.Operation removeEnumOptionRemoves the specified enum option from the specified enum field.removeEnumOption
@@ -248,7 +248,7 @@
addField
-public static final MetadataTemplate.Operation addField+public static final MetadataTemplate.Operation addFieldAdds a field at the end of the field list for the template.addField
@@ -258,7 +258,7 @@
editField
-public static final MetadataTemplate.Operation editField+public static final MetadataTemplate.Operation editFieldEdits any number of the base properties of a field: displayName, hidden, description.editField
@@ -268,7 +268,7 @@
removeField
-public static final MetadataTemplate.Operation removeField+public static final MetadataTemplate.Operation removeFieldRemoves the specified field from the template.removeField
@@ -278,7 +278,7 @@
editTemplate
-public static final MetadataTemplate.Operation editTemplate+public static final MetadataTemplate.Operation editTemplateEdits any number of the base properties of a template: displayName, hidden.editTemplate
@@ -288,7 +288,7 @@
reorderEnumOptions
-public static final MetadataTemplate.Operation reorderEnumOptions+public static final MetadataTemplate.Operation reorderEnumOptionsReorders the enum option list to match the requested enum option list.reorderEnumOptions
@@ -298,7 +298,7 @@
reorderFields
-public static final MetadataTemplate.Operation reorderFields+public static final MetadataTemplate.Operation reorderFieldsReorders the field list to match the requested field list.reorderFields
@@ -308,7 +308,7 @@
addMultiSelectOption
-public static final MetadataTemplate.Operation addMultiSelectOption+public static final MetadataTemplate.Operation addMultiSelectOptionAdds a new option to a multiselect field.addMultiSelectOption
@@ -318,7 +318,7 @@
editMultiSelectOption
-public static final MetadataTemplate.Operation editMultiSelectOption+public static final MetadataTemplate.Operation editMultiSelectOptionEdits an existing option in a multiselect field.editMultiSelectOption
@@ -328,7 +328,7 @@
removeMultiSelectOption
-public static final MetadataTemplate.Operation removeMultiSelectOption+public static final MetadataTemplate.Operation removeMultiSelectOptionRemoves an option from a multiselect field.removeMultiSelectOption
@@ -346,7 +346,7 @@
reorderMultiSelectOptions
-public static final MetadataTemplate.Operation reorderMultiSelectOptions+public static final MetadataTemplate.Operation reorderMultiSelectOptionsChanges the display order of options in a multiselect field.Method Detail
values
-public static MetadataTemplate.Operation[] values()+public static MetadataTemplate.Operation[] values()Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: @@ -366,7 +366,7 @@values
valueOf
-public static MetadataTemplate.Operation valueOf(String name)+public static MetadataTemplate.Operation valueOf(String name)Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are diff --git a/javadoc/com/box/sdk/MetadataTemplate.Option.html b/javadoc/com/box/sdk/MetadataTemplate.Option.html index ef8f4fffc..a723c1d20 100644 --- a/javadoc/com/box/sdk/MetadataTemplate.Option.html +++ b/javadoc/com/box/sdk/MetadataTemplate.Option.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10}; +var methods = {"i0":10,"i1":10,"i2":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -56,7 +56,7 @@Class MetadataTemplate.O
-public static class MetadataTemplate.Option +public static class MetadataTemplate.Option extends BoxJSONObjectClass contains information about the metadata template option.@@ -113,6 +113,12 @@Method Summary
Gets the key of the field.+ + MetadataTemplate.StaticConfig+ getStaticConfig()+Gets static configuration for the classification.+@@ -554,7 +560,7 @@
- @@ -148,7 +154,7 @@
Constructor Detail
@@ -158,7 +164,7 @@Option
- diff --git a/javadoc/com/box/sdk/MetadataTemplate.StaticConfig.html b/javadoc/com/box/sdk/MetadataTemplate.StaticConfig.html new file mode 100644 index 000000000..6a43baf8f --- /dev/null +++ b/javadoc/com/box/sdk/MetadataTemplate.StaticConfig.html @@ -0,0 +1,213 @@ + + + + + + +
Option
-public Option(String json)+public Option(String json)Constructs a metadate template option from a JSON string.
- Parameters:
@@ -180,7 +186,7 @@Method Detail
getID
-public String getID()+public String getID()Gets the ID of the template field.
- Returns:
@@ -191,10 +197,10 @@getID
-+
+ + + +
getKey
-public String getKey()+public String getKey()Gets the key of the field.
- Returns:
@@ -202,6 +208,20 @@getKey
+
- +
+getStaticConfig
+public MetadataTemplate.StaticConfig getStaticConfig()+Gets static configuration for the classification.++
+- Returns:
+- static configuration for the classification.
+MetadataTemplate.StaticConfig (Box Java SDK) + + + + + + + +++com.box.sdk+Class MetadataTemplate.StaticConfig
+++ + + diff --git a/javadoc/com/box/sdk/MetadataTemplate.html b/javadoc/com/box/sdk/MetadataTemplate.html index d33077740..1027dcd39 100644 --- a/javadoc/com/box/sdk/MetadataTemplate.html +++ b/javadoc/com/box/sdk/MetadataTemplate.html @@ -103,6 +103,12 @@+
+- Object
+- +
++
+- BoxJSONObject
+- +
++
+- MetadataTemplate.StaticConfig
++++
+- +
++
+- Enclosing class:
+- MetadataTemplate
+
+
+public static class MetadataTemplate.StaticConfig +extends BoxJSONObject+Class contains information about the static configuration for the classification.++++
+- + +
++
+ +- + + +
+Constructor Summary
++
+Constructors ++ +Constructor and Description ++ ++ StaticConfig()+Constructs an empty static configuration.++ ++ StaticConfig(String json)+Constructs a static configuration from a JSON string.++
+- + + +
+Method Summary
++
+All Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ JsonObject+ getClassification()+Gets the classification of the static configuration.++ ++ void+ setClassification(JsonObject classification)+Sets the classification of the static configuration.++
+ +- + + +
+Methods inherited from class BoxJSONObject
+clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject, getPendingJSONObject+++
+- + +
++
+ +- + + +
+Constructor Detail
+ + + ++
+ + + +- +
+StaticConfig
+public StaticConfig()+Constructs an empty static configuration.++
+- +
+StaticConfig
+public StaticConfig(String json)+Constructs a static configuration from a JSON string.++
+- Parameters:
+- +
json- the json encoded metadate template field.+
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+getClassification
+public JsonObject getClassification()+Gets the classification of the static configuration.++
+- Returns:
+- the classification of the static configuration.
++
+- +
+setClassification
+public void setClassification(JsonObject classification)+Sets the classification of the static configuration.++
+- Parameters:
+- +
classification- the classification of the static configuration.Nested Class Summary
Class contains information about the metadata template option.++ + static class+ MetadataTemplate.StaticConfig+Class contains information about the static configuration for the classification.+executeMetadataQuery
getMetadataTemplate
-public static MetadataTemplate getMetadataTemplate(BoxAPIConnection api)+public static MetadataTemplate getMetadataTemplate(BoxAPIConnection api)Gets the metadata template of properties.
- Parameters:
@@ -570,7 +576,7 @@getMetadataTemplate
getMetadataTemplate
-public static MetadataTemplate getMetadataTemplate(BoxAPIConnection api, +public static MetadataTemplate getMetadataTemplate(BoxAPIConnection api, String templateName)Gets the metadata template of specified template type.@@ -588,7 +594,7 @@
getMetadataTemplate
getMetadataTemplate
-public static MetadataTemplate getMetadataTemplate(BoxAPIConnection api, +public static MetadataTemplate getMetadataTemplate(BoxAPIConnection api, String templateName, String scope, String... fields)@@ -610,7 +616,7 @@getMetadataTemplate
getMetadataTemplateByID
-public static MetadataTemplate getMetadataTemplateByID(BoxAPIConnection api, +public static MetadataTemplate getMetadataTemplateByID(BoxAPIConnection api, String templateID)Geta the specified metadata template by its ID.@@ -628,7 +634,7 @@
getMetadataTemplateByID
getEnterpriseMetadataTemplates
-public static Iterable<MetadataTemplate> getEnterpriseMetadataTemplates(BoxAPIConnection api, +public static Iterable<MetadataTemplate> getEnterpriseMetadataTemplates(BoxAPIConnection api, String... fields)Returns all metadata templates within a user's enterprise.@@ -646,7 +652,7 @@
getEnterpriseMetadataTemplates
getEnterpriseMetadataTemplates
-public static Iterable<MetadataTemplate> getEnterpriseMetadataTemplates(String scope, +public static Iterable<MetadataTemplate> getEnterpriseMetadataTemplates(String scope, BoxAPIConnection api, String... fields)Returns all metadata templates within a user's scope. Currently only the enterprise scope is supported.@@ -666,7 +672,7 @@getEnterpriseMetadataTemplates
getEnterpriseMetadataTemplates
-public static Iterable<MetadataTemplate> getEnterpriseMetadataTemplates(String scope, +public static Iterable<MetadataTemplate> getEnterpriseMetadataTemplates(String scope, int limit, BoxAPIConnection api, String... fields)@@ -688,7 +694,7 @@getEnterpriseMetadataTemplates
getID
-public String getID()+public String getID()Gets the ID of the template.
- Returns:
@@ -702,7 +708,7 @@getID
getTemplateKey
-public String getTemplateKey()+public String getTemplateKey()Gets the unique template key to identify the metadata template.
- Returns:
@@ -716,7 +722,7 @@getTemplateKey
getScope
-public String getScope()+public String getScope()Gets the metadata template scope.
- Returns:
@@ -730,7 +736,7 @@getScope
getDisplayName
-public String getDisplayName()+public String getDisplayName()Gets the displayed metadata template name.
- Returns:
@@ -744,7 +750,7 @@getDisplayName
getIsHidden
-public Boolean getIsHidden()+public Boolean getIsHidden()Gets is the metadata template hidden.
- Returns:
@@ -758,7 +764,7 @@getIsHidden
getFields
-public List<MetadataTemplate.Field> getFields()+public List<MetadataTemplate.Field> getFields()Gets the iterable with all fields the metadata template contains.
- Returns:
@@ -772,7 +778,7 @@getFields
- +
getCopyInstanceOnItemCopy
-public Boolean getCopyInstanceOnItemCopy()+public Boolean getCopyInstanceOnItemCopy()Gets whether the copy operation should copy the metadata along with the item.
- Returns:
diff --git a/javadoc/com/box/sdk/SharedLinkAPIConnection.html b/javadoc/com/box/sdk/SharedLinkAPIConnection.html index 4caa2d74e..85d442583 100644 --- a/javadoc/com/box/sdk/SharedLinkAPIConnection.html +++ b/javadoc/com/box/sdk/SharedLinkAPIConnection.html @@ -282,7 +282,7 @@Method Summary
Methods inherited from class BoxAPIConnection
-addListener, asSelf, asUser, authenticate, configureSslCertificatesValidation, createTokenRequest, determineResourceLinkType, enableNotifications, extractTokens, getAuthorizationURL, getAuthorizationURL, getBaseAppUrl, getClientID, getClientSecret, getConnectTimeout, getHostnameVerifier, getKeyValueOrDefault, getLastRefresh, getLowerScopedToken, getProxy, getProxyPassword, getProxyUsername, getReadTimeout, getRefreshLock, getRevokeURL, getTokenURL, getTrustManager, modifyHttpClientBuilder, notifyError, notifyRefresh, removeCustomHeader, removeListener, restore, restore, revokeToken, save, setBaseAppUrl, setBaseAuthorizationURL, setConnectTimeout, setCustomHeader, setLastRefresh, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRequestInterceptor, suppressNotificationsaddListener, asSelf, asUser, authenticate, configureSslCertificatesValidation, createNewCall, createTokenRequest, determineResourceLinkType, enableNotifications, extractTokens, getAuthorizationURL, getAuthorizationURL, getBaseAppUrl, getClientID, getClientSecret, getConnectTimeout, getHostnameVerifier, getKeyValueOrDefault, getLastRefresh, getLowerScopedToken, getProxy, getProxyPassword, getProxyUsername, getReadTimeout, getRefreshLock, getRevokeURL, getTokenURL, getTrustManager, modifyHttpClientBuilder, notifyError, notifyRefresh, removeCustomHeader, removeListener, restore, restore, revokeToken, save, setBaseAppUrl, setBaseAuthorizationURL, setConnectTimeout, setCustomHeader, setLastRefresh, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRequestInterceptor, suppressNotifications
- diff --git a/javadoc/com/box/sdk/package-frame.html b/javadoc/com/box/sdk/package-frame.html index 4c99d34a8..158d16159 100644 --- a/javadoc/com/box/sdk/package-frame.html +++ b/javadoc/com/box/sdk/package-frame.html @@ -139,6 +139,7 @@
Classes
- MetadataTemplate.Field
- MetadataTemplate.FieldOperation
- MetadataTemplate.Option
+- MetadataTemplate.StaticConfig
- PagingParameters
- PartialCollection
- Representation
diff --git a/javadoc/com/box/sdk/package-summary.html b/javadoc/com/box/sdk/package-summary.html index cf66fba84..681cebea6 100644 --- a/javadoc/com/box/sdk/package-summary.html +++ b/javadoc/com/box/sdk/package-summary.html @@ -786,58 +786,64 @@Package com.box.sdk
+ +MetadataTemplate.StaticConfig ++ +Class contains information about the static configuration for the classification.+- PagingParameters + - PartialCollection<E> + - Representation + - RetentionPolicyParams + - ScopedToken + - SharedLinkAPIConnection Deprecated + - SizeRange + - SortParameters + - StandardCharsets + URLTemplate box-java-sdk-10 4.10.0 API
+box-java-sdk-11 4.11.0 API