Package com.dropbox.core

Class DbxApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.dropbox.core.DbxException

com.dropbox.core.DbxApiException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AddFileMemberErrorException, AddFolderMemberErrorException, AddPropertiesErrorException, AddSecondaryEmailsErrorException, AddTagErrorException, AlphaGetMetadataErrorException, BaseTagErrorException, CountFileRequestsErrorException, CreateFileRequestErrorException, CreateFolderErrorException, CreateSharedLinkErrorException, CreateSharedLinkWithSettingsErrorException, CustomQuotaErrorException, DateRangeErrorException, DeleteAllClosedFileRequestsErrorException, DeleteErrorException, DeleteFileRequestErrorException, DeleteManualContactsErrorException, DocLookupErrorException, DownloadErrorException, DownloadZipErrorException, ExcludedUsersListContinueErrorException, ExcludedUsersListErrorException, ExcludedUsersUpdateErrorException, ExportErrorException, FeaturesGetValuesBatchErrorException, FileMemberActionErrorException, GetAccountBatchErrorException, GetAccountErrorException, GetCopyReferenceErrorException, GetFileMetadataErrorException, GetFileRequestErrorException, GetMetadataErrorException, GetSharedLinkFileErrorException, GetSharedLinksErrorException, GetTeamEventsContinueErrorException, GetTeamEventsErrorException, GetTemporaryLinkErrorException, GetThumbnailBatchErrorException, GroupCreateErrorException, GroupDeleteErrorException, GroupMembersAddErrorException, GroupMemberSetAccessTypeErrorException, GroupMembersRemoveErrorException, GroupSelectorErrorException, GroupsGetInfoErrorException, GroupsListContinueErrorException, GroupsMembersListContinueErrorException, GroupsPollErrorException, GroupUpdateErrorException, InvalidPropertyGroupErrorException, LegalHoldsGetPolicyErrorException, LegalHoldsListHeldRevisionsErrorException, LegalHoldsListPoliciesErrorException, LegalHoldsPolicyCreateErrorException, LegalHoldsPolicyReleaseErrorException, LegalHoldsPolicyUpdateErrorException, ListDocsCursorErrorException, ListFileMembersContinueErrorException, ListFileMembersErrorException, ListFileRequestsContinueErrorException, ListFileRequestsErrorException, ListFilesContinueErrorException, ListFolderContinueErrorException, ListFolderErrorException, ListFolderLongpollErrorException, ListFolderMembersContinueErrorException, ListFoldersContinueErrorException, ListMemberAppsErrorException, ListMemberDevicesErrorException, ListMembersAppsErrorException, ListMembersDevicesErrorException, ListRevisionsErrorException, ListSharedLinksErrorException, ListTeamAppsErrorException, ListTeamDevicesErrorException, ListUsersCursorErrorException, LockFileErrorException, MembersDeleteProfilePhotoErrorException, MembersGetInfoErrorException, MembersListContinueErrorException, MembersListErrorException, MembersRecoverErrorException, MembersRemoveErrorException, MembersSendWelcomeErrorException, MembersSetPermissions2ErrorException, MembersSetPermissionsErrorException, MembersSetProfileErrorException, MembersSetProfilePhotoErrorException, MembersSuspendErrorException, MembersTransferFormerMembersFilesErrorException, MembersUnsuspendErrorException, ModifySharedLinkSettingsErrorException, ModifyTemplateErrorException, MountFolderErrorException, PaperCreateErrorException, PaperDocCreateErrorException, PaperDocUpdateErrorException, PaperFolderCreateErrorException, PaperUpdateErrorException, PollErrorException, PreviewErrorException, PropertiesSearchContinueErrorException, PropertiesSearchErrorException, RelinquishFileMembershipErrorException, RelinquishFolderMembershipErrorException, RelocationErrorException, RemoveFileMemberErrorException, RemoveFolderMemberErrorException, RemovePropertiesErrorException, RemoveTagErrorException, RestoreErrorException, RevokeDeviceSessionBatchErrorException, RevokeDeviceSessionErrorException, RevokeLinkedAppBatchErrorException, RevokeLinkedAppErrorException, RevokeSharedLinkErrorException, SaveCopyReferenceErrorException, SaveUrlErrorException, SearchErrorException, SetAccessInheritanceErrorException, SetCustomQuotaErrorException, SetProfilePhotoErrorException, SharedFolderAccessErrorException, SharedLinkErrorException, ShareFolderErrorException, SharingAllowlistAddErrorException, SharingAllowlistListContinueErrorException, SharingAllowlistListErrorException, SharingAllowlistRemoveErrorException, SharingUserErrorException, TeamFolderActivateErrorException, TeamFolderArchiveErrorException, TeamFolderCreateErrorException, TeamFolderListContinueErrorException, TeamFolderListErrorException, TeamFolderPermanentlyDeleteErrorException, TeamFolderRenameErrorException, TeamFolderUpdateSyncSettingsErrorException, TeamNamespacesListContinueErrorException, TeamNamespacesListErrorException, TemplateErrorException, ThumbnailErrorException, ThumbnailV2ErrorException, TokenFromOAuth1ErrorException, TokenGetAuthenticatedAdminErrorException, TransferFolderErrorException, UnmountFolderErrorException, UnshareFileErrorException, UnshareFolderErrorException, UpdateFileRequestErrorException, UpdateFolderMemberErrorException, UpdateFolderPolicyErrorException, UpdatePropertiesErrorException, UploadErrorException, UploadSessionAppendErrorException, UploadSessionFinishErrorException, UploadSessionStartErrorException, UserFeaturesGetValuesBatchErrorException, UserInfoErrorException

public class DbxApiException
extends DbxException

Base class for API-specific exceptions raised by API v2 routes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DbxApiException(java.lang.String requestId, LocalizedText userMessage, java.lang.String message)
DbxApiException(java.lang.String requestId, LocalizedText userMessage, java.lang.String message, java.lang.Throwable cause)

Method Summary

Modifier and Type	Method	Description
protected static java.lang.String	buildMessage(java.lang.String routeName, LocalizedText userMessage)
protected static java.lang.String	buildMessage(java.lang.String routeName, LocalizedText userMessage, java.lang.Object errorValue)
LocalizedText	getUserMessage()	Returns a human-readable message that can be displayed to the end user.

Methods inherited from class com.dropbox.core.DbxException

getRequestId

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DbxApiException

public DbxApiException(java.lang.String requestId,
                       LocalizedText userMessage,
                       java.lang.String message)

DbxApiException

public DbxApiException(java.lang.String requestId,
                       LocalizedText userMessage,
                       java.lang.String message,
                       java.lang.Throwable cause)

Method Detail

getUserMessage

public LocalizedText getUserMessage()

Returns a human-readable message that can be displayed to the end user.

If no such message is available, then this method returns null.

Returns:

human-readable message to display to end user, or null if unavailable

buildMessage

protected static java.lang.String buildMessage(java.lang.String routeName,
                                               LocalizedText userMessage)

buildMessage

protected static java.lang.String buildMessage(java.lang.String routeName,
                                               LocalizedText userMessage,
                                               java.lang.Object errorValue)