Index (shoeboxed-java-api 1.0 API)

A B C D E F G H I L N P R S T U V

A

accessToken(String) - Method in class io.scanbot.shoeboxed.ShoeboxedSession.Builder
Account - Class in io.scanbot.shoeboxed.entity: Account of the user.
Account(long, String) - Constructor for class io.scanbot.shoeboxed.entity.Account
Accounts - Class in io.scanbot.shoeboxed.entity.container: Contains list of accounts.
ApiApplication - Class in io.scanbot.shoeboxed: Client of Shoeboxed API.
ApiApplication(String, String, String) - Constructor for class io.scanbot.shoeboxed.ApiApplication
appendCategories(Collection<String>) - Method in class io.scanbot.shoeboxed.entity.request.CreateDocumentRequest.Builder: Appends categories to request.
appendCategory(String) - Method in class io.scanbot.shoeboxed.entity.request.CreateDocumentRequest.Builder: Appends category to request.
AuthHandler - Class in io.scanbot.shoeboxed: Controls authorization workflow.
AuthHandler.Scope - Enum in io.scanbot.shoeboxed: Available OAuth scopes
AuthHandler.StateMismatchException - Exception in io.scanbot.shoeboxed: Thrown if state generated in AuthHandler.generateAuthorizationUrl(io.scanbot.shoeboxed.AuthHandler.Scope) does not match state passed in AuthHandler.getTokensFromAuthorizationCode(String, String) method.
AuthHandler.StateMismatchException() - Constructor for exception io.scanbot.shoeboxed.AuthHandler.StateMismatchException
AuthHandler.Tokens - Class in io.scanbot.shoeboxed: Container for access and refresh tokens
AuthHandler.Tokens(String, String) - Constructor for class io.scanbot.shoeboxed.AuthHandler.Tokens

B

build() - Method in class io.scanbot.shoeboxed.entity.request.CreateCategoryRequest.Builder
build() - Method in class io.scanbot.shoeboxed.entity.request.CreateDocumentRequest.Builder
build() - Method in class io.scanbot.shoeboxed.ShoeboxedSession.Builder

C

Categories - Class in io.scanbot.shoeboxed.entity.container: Contains list of categories
Category - Class in io.scanbot.shoeboxed.entity: Category of documents.
Category(long, String) - Constructor for class io.scanbot.shoeboxed.entity.Category
city(String) - Method in class io.scanbot.shoeboxed.entity.request.CreateDocumentRequest.Builder
createCategory(long, CreateCategoryRequest) - Method in class io.scanbot.shoeboxed.ShoeboxedApi
CreateCategoryRequest - Class in io.scanbot.shoeboxed.entity.request: Request for creation of Category on server.
CreateCategoryRequest.Builder - Class in io.scanbot.shoeboxed.entity.request: Builds CreateCategoryRequest.
CreateCategoryRequest.Builder(String) - Constructor for class io.scanbot.shoeboxed.entity.request.CreateCategoryRequest.Builder
createDocument(long, TypedFile, CreateDocumentRequest) - Method in class io.scanbot.shoeboxed.ShoeboxedApi
CreateDocumentRequest - Class in io.scanbot.shoeboxed.entity.request: Request for creation of Document on server.
CreateDocumentRequest.Builder - Class in io.scanbot.shoeboxed.entity.request: Builds CreateDocumentRequest Same instance can be used to build multiple requests.
CreateDocumentRequest.Builder() - Constructor for class io.scanbot.shoeboxed.entity.request.CreateDocumentRequest.Builder

D

deleteDocument(long, String) - Method in class io.scanbot.shoeboxed.ShoeboxedApi
description(String) - Method in class io.scanbot.shoeboxed.entity.request.CreateCategoryRequest.Builder
Document - Class in io.scanbot.shoeboxed.entity: Document in Shoeboxed service.
Document(String, String, Document.ProcessingState, Document.Type, String, String) - Constructor for class io.scanbot.shoeboxed.entity.Document
Document.ProcessingState - Enum in io.scanbot.shoeboxed.entity: Processing state of the document
Document.Type - Enum in io.scanbot.shoeboxed.entity: Type of the document

E

equals(Object) - Method in class io.scanbot.shoeboxed.entity.Account
equals(Object) - Method in class io.scanbot.shoeboxed.entity.Category
equals(Object) - Method in class io.scanbot.shoeboxed.entity.Document

F

forApplication(ApiApplication) - Static method in class io.scanbot.shoeboxed.AuthHandler
forSession(ShoeboxedSession) - Static method in class io.scanbot.shoeboxed.ShoeboxedApi

G

generateAuthorizationUrl(AuthHandler.Scope) - Method in class io.scanbot.shoeboxed.AuthHandler: Generates URL for authentication.
getAccessToken() - Method in class io.scanbot.shoeboxed.AuthHandler.Tokens
getAccounts() - Method in class io.scanbot.shoeboxed.ShoeboxedApi
getCategories(long) - Method in class io.scanbot.shoeboxed.ShoeboxedApi
getCity() - Method in class io.scanbot.shoeboxed.entity.Document
getId() - Method in class io.scanbot.shoeboxed.ApiApplication
getId() - Method in class io.scanbot.shoeboxed.entity.Account
getId() - Method in class io.scanbot.shoeboxed.entity.Category
getId() - Method in class io.scanbot.shoeboxed.entity.Document
getLabel() - Method in class io.scanbot.shoeboxed.entity.Account
getName() - Method in class io.scanbot.shoeboxed.entity.Category
getName() - Method in class io.scanbot.shoeboxed.entity.Document
getNotes() - Method in class io.scanbot.shoeboxed.entity.Document
getProcessingState() - Method in class io.scanbot.shoeboxed.entity.Document
getQueryParams(String) - Static method in class io.scanbot.shoeboxed.util.UrlUtils
getRedirectUri() - Method in class io.scanbot.shoeboxed.ApiApplication
getRefreshToken() - Method in class io.scanbot.shoeboxed.AuthHandler.Tokens
getSecret() - Method in class io.scanbot.shoeboxed.ApiApplication
getTokens(String) - Method in class io.scanbot.shoeboxed.AuthHandler: Requests token for given URL with authentication code.
getType() - Method in class io.scanbot.shoeboxed.entity.Document

H

hashCode() - Method in class io.scanbot.shoeboxed.entity.Account
hashCode() - Method in class io.scanbot.shoeboxed.entity.Category
hashCode() - Method in class io.scanbot.shoeboxed.entity.Document

I

io.scanbot.shoeboxed - package io.scanbot.shoeboxed
io.scanbot.shoeboxed.entity - package io.scanbot.shoeboxed.entity
io.scanbot.shoeboxed.entity.container - package io.scanbot.shoeboxed.entity.container
io.scanbot.shoeboxed.entity.request - package io.scanbot.shoeboxed.entity.request
io.scanbot.shoeboxed.util - package io.scanbot.shoeboxed.util

L

list() - Method in class io.scanbot.shoeboxed.entity.container.Accounts
list() - Method in class io.scanbot.shoeboxed.entity.container.Categories

N

notes(String) - Method in class io.scanbot.shoeboxed.entity.request.CreateDocumentRequest.Builder

P

processingState(Document.ProcessingState) - Method in class io.scanbot.shoeboxed.entity.request.CreateDocumentRequest.Builder

R

refreshToken(String) - Method in class io.scanbot.shoeboxed.ShoeboxedSession.Builder
refreshTokens(String) - Method in class io.scanbot.shoeboxed.AuthHandler: Request new access token for given refresh token

S

ShoeboxedApi - Class in io.scanbot.shoeboxed: Shoeboxed API.
ShoeboxedSession - Class in io.scanbot.shoeboxed: Contains session specific information which is used to access Shoeboxed API (such as OAuth tokens)
ShoeboxedSession.Builder - Class in io.scanbot.shoeboxed: Builds ShoeboxedSession
ShoeboxedSession.Builder(ApiApplication) - Constructor for class io.scanbot.shoeboxed.ShoeboxedSession.Builder

T

toString() - Method in class io.scanbot.shoeboxed.ApiApplication
toString() - Method in class io.scanbot.shoeboxed.entity.Account: Provides String representation of Account.
toString() - Method in class io.scanbot.shoeboxed.entity.Category: Provides String representation of Category.
toString() - Method in class io.scanbot.shoeboxed.entity.Document
type(Document.Type) - Method in class io.scanbot.shoeboxed.entity.request.CreateDocumentRequest.Builder

U

UnauthorizedException - Exception in io.scanbot.shoeboxed: Thrown when API call fails with HTTP error 401 (unauthorized).
UrlUtils - Class in io.scanbot.shoeboxed.util: Utils related to operations with URL
UrlUtils() - Constructor for class io.scanbot.shoeboxed.util.UrlUtils

V

valueOf(String) - Static method in enum io.scanbot.shoeboxed.AuthHandler.Scope: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.scanbot.shoeboxed.entity.Document.ProcessingState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.scanbot.shoeboxed.entity.Document.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.scanbot.shoeboxed.AuthHandler.Scope: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.scanbot.shoeboxed.entity.Document.ProcessingState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.scanbot.shoeboxed.entity.Document.Type: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L N P R S T U V