Index (library API)

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

A

account - Variable in class universum.studios.android.officium.sync.SyncEvent: Account used during execution of synchronization task with SyncEvent.id.
account(Account) - Method in class universum.studios.android.officium.sync.SyncEvent.Builder: Specifies an account for which SyncEvent will be fired.
account - Variable in class universum.studios.android.officium.sync.SyncOperation: Account associated with this sync operation.
acquireAccount() - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Called to acquire current single account.
addAccount(AccountAuthenticatorResponse, String, String, String[], Bundle) - Method in class universum.studios.android.officium.account.BaseAccountAuthenticator
AUTH_TOKEN_TYPES - Static variable in class universum.studios.android.officium.account.UserAccount: Array specifying set of default authentication token types.
authority - Variable in class universum.studios.android.officium.sync.SyncOperation: Authority associated with this sync operation.
AuthRequestInterceptor - Class in universum.studios.android.officium.service.auth: An Interceptor implementation that may be used for interception of requests that require an authorization token to be sent to the server along with the request data.
AuthRequestInterceptor(AuthTokenProvider) - Constructor for class universum.studios.android.officium.service.auth.AuthRequestInterceptor: Creates a new instance of AuthRequestInterceptor with the given authorization tokenProvider.
AuthTokenProvider - Interface in universum.studios.android.officium.service.auth: Interface for providers that can provide an instance of authorization token.

B

BaseAccountAuthenticator - Class in universum.studios.android.officium.account: A AbstractAccountAuthenticator implementation that can be used as base for custom implementations of account authenticator.
BaseAccountAuthenticator(Context) - Constructor for class universum.studios.android.officium.account.BaseAccountAuthenticator: Creates a new instance of BaseAccountAuthenticator with the given context.
BaseServiceObject - Class in universum.studios.android.officium.service: Base implementation of ServiceObject for objects associated to services.
BaseServiceObject() - Constructor for class universum.studios.android.officium.service.BaseServiceObject
BaseSyncAdapter - Class in universum.studios.android.officium.sync: An AbstractThreadedSyncAdapter implementation that provides simple API for registration of SyncHandlers that are responsible for synchronization tasks handling.
BaseSyncAdapter(Context, boolean) - Constructor for class universum.studios.android.officium.sync.BaseSyncAdapter: Same as BaseSyncAdapter.BaseSyncAdapter(Context, boolean, boolean) with allowParallelSyncs parameter set to false.
BaseSyncAdapter(Context, boolean, boolean) - Constructor for class universum.studios.android.officium.sync.BaseSyncAdapter: Creates a new instance of BaseSyncAdapter with the specified context and configuration flags.
BaseSyncAdapter.EventDispatcher - Interface in universum.studios.android.officium.sync: Interface used by BaseSyncAdapter to dispatch occurred synchronization events.
BaseSyncManager - Class in universum.studios.android.officium.sync: Base class that can be used for implementation of managers responsible for requesting of synchronization operations to be performed.
BaseSyncManager(Context, String) - Constructor for class universum.studios.android.officium.sync.BaseSyncManager: Creates a new instance of BaseSyncManager with the given context and authority.
build() - Method in class universum.studios.android.officium.sync.SyncEvent.Builder: Builds a new instance of SyncEvent.
build() - Method in class universum.studios.android.officium.sync.SyncTask.Builder: Builds a new instance of SyncTask.
Builder(int) - Constructor for class universum.studios.android.officium.sync.SyncEvent.Builder: Creates a new instance of Builder with the specified id.
Builder(int) - Constructor for class universum.studios.android.officium.sync.SyncTask.Builder: Creates a new instance of Builder for the specified synchronization taskId.

C

cancel() - Method in class universum.studios.android.officium.service.ServiceCall
CANCELED - Static variable in class universum.studios.android.officium.sync.SyncTask: State indicating that SyncTask has been canceled.
cancelSync() - Method in class universum.studios.android.officium.sync.BaseSyncManager: Cancels any active or pending synchronizations that match the content authority specified for this manager and account picked for synchronization by this manager implementation.
clearAccountPassword() - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Clears the password for the current single account (if created).
clearAccountPassword(Account) - Method in class universum.studios.android.officium.account.UserAccountManager: Clears the password for the given account.
clone() - Method in class universum.studios.android.officium.service.ServiceCall: Creates a new clone of this service call with the original Retrofit call also cloned and with the same service id as specified via ServiceCall.withServiceId(int) (if any).
clone() - Method in class universum.studios.android.officium.sync.SyncTask: Makes a clone of this task with the same id and request body but with the initial state, which is SyncTask.IDLE.
code - Variable in class universum.studios.android.officium.service.ErrorResponse.Error: Code of this error.
confirmCredentials(AccountAuthenticatorResponse, Account, Bundle) - Method in class universum.studios.android.officium.account.BaseAccountAuthenticator
createAccount(A) - Method in class universum.studios.android.officium.account.UserAccountManager: Creates a new Android Account for the given userAccount.
createAccountAsync(A) - Method in class universum.studios.android.officium.account.UserAccountManager: Same as UserAccountManager.createAccount(UserAccount) where creation of the given userAccount will be executed asynchronously using AsyncTask.
createTaskFromExtras(Bundle) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Called to create instance of SyncTask from the given extras whenever BaseSyncAdapter.onPerformSync(Account, Bundle, String, ContentProviderClient, SyncResult) is invoked.

D

d(String, String) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#d(String, String).
d(String, String, Throwable) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#d(String, String, Throwable).
DEBUG_LOG_ENABLED - Static variable in class universum.studios.android.officium.OfficiumConfig: Deprecated.
No longer used across the library.
DEFAULT_ID - Static variable in class universum.studios.android.officium.sync.SyncTask: Default id for synchronization task.
deleteAccount(A) - Method in class universum.studios.android.officium.account.UserAccountManager: Deletes an existing Android Account for the given userAccount.
deleteAccountAsync(A) - Method in class universum.studios.android.officium.account.UserAccountManager: Same as UserAccountManager.deleteAccount(UserAccount) where deletion of the given userAccount will be executed asynchronously using AsyncTask.
dispatch(Object) - Method in interface universum.studios.android.officium.sync.BaseSyncAdapter.EventDispatcher: Called by a specific implementation of BaseSyncAdapter to dispatch the given synchronization event.
dispatchSyncEvent(Object) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Invoked whenever this sync adapter wants to dispatch the given synchronization event to its clients.

E

e(String, String) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#e(String, String).
e(String, String, Throwable) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#e(String, String, Throwable).
editProperties(AccountAuthenticatorResponse, String) - Method in class universum.studios.android.officium.account.BaseAccountAuthenticator
EMPTY - Static variable in class universum.studios.android.officium.sync.SyncTask: Empty instance of SyncTask that may be used in order to pass a sync task to a sync handler that does not require any data from a caller to perform synchronization logic.
EndPoint - Interface in universum.studios.android.officium.service: End point that may be specified for ServiceManager to provide base url for all its related services.
enqueue(ServiceCallback<T>) - Method in class universum.studios.android.officium.service.ServiceCall: Like #enqueue(Callback), but this method also obtains and returns unique id of this asynchronous request so it may be later identified through the associated service objects: ServiceCallback which results to either ServiceResponse or ServiceError.
enqueue(<any>) - Method in class universum.studios.android.officium.service.ServiceCall
equals(Object) - Method in class universum.studios.android.officium.account.UserAccount
equals(Object) - Method in class universum.studios.android.officium.sync.SyncTask
error - Variable in class universum.studios.android.officium.service.ErrorResponse: Error specified for this response during its initialization or parsed using Gson.
Error() - Constructor for class universum.studios.android.officium.service.ErrorResponse.Error
error(Exception) - Method in class universum.studios.android.officium.sync.SyncEvent.Builder: Specifies an error that occurred during synchronization.
ERROR - Static variable in class universum.studios.android.officium.sync.SyncEvent: Type flag for SyncEvent determining error occurred during synchronization.
error - Variable in class universum.studios.android.officium.sync.SyncEvent: Error that has occurred during execution of synchronization task with SyncEvent.id.
ERROR_CREATE_ACCOUNT - Static variable in class universum.studios.android.officium.account.UserAccountManager: Error code indicating that an error occurred during asynchronous execution of UserAccountManager.onCreateAccount(UserAccount) requested via UserAccountManager.createAccountAsync(UserAccount).
ERROR_DELETE_ACCOUNT - Static variable in class universum.studios.android.officium.account.UserAccountManager: Error code indicating that an error occurred during asynchronous execution of UserAccountManager.onDeleteAccount(UserAccount) requested via UserAccountManager.deleteAccountAsync(UserAccount).
ErrorResponse - Class in universum.studios.android.officium.service: A ServiceResponse that may be used to parse body of response send by a server that contains an ErrorResponse.Error object.
ErrorResponse() - Constructor for class universum.studios.android.officium.service.ErrorResponse: Creates a new instance of ErrorResponse without error.
ErrorResponse(ErrorResponse.Error) - Constructor for class universum.studios.android.officium.service.ErrorResponse: Creates a new instance of ErrorResponse with the specified error.
ErrorResponse.Error - Class in universum.studios.android.officium.service: Simple error object that can hold two attributes: Error#code and Error#message.
EventBus - Interface in universum.studios.android.officium.event: Unified interface for event bus that may be used to wrap a specific implementation of bus.
execute() - Method in class universum.studios.android.officium.service.ServiceCall
extras(Bundle) - Method in class universum.studios.android.officium.sync.SyncEvent.Builder: Specifies a bundle with extra information for the event.
extras - Variable in class universum.studios.android.officium.sync.SyncEvent: Bundle with additional extra information.

F

FAILED - Static variable in class universum.studios.android.officium.sync.SyncTask: State indicating that SyncTask has been already executed but an error occurred during its execution.
findAccountForUser(A) - Method in class universum.studios.android.officium.account.UserAccountManager: Called to find the Android Account associated with the given userAccount.
FINISH - Static variable in class universum.studios.android.officium.sync.SyncEvent: Type flag for SyncEvent determining finish of synchronization.
FINISHED - Static variable in class universum.studios.android.officium.sync.SyncTask: State indicating that SyncTask has been already executed without any error.

G

getAccount() - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Returns the current account if it is created.
getAccountData(String) - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Returns the single data for the current single account (if created) stored under the specified key.
getAccountData(Account, String) - Method in class universum.studios.android.officium.account.UserAccountManager: Returns the single data for the given account stored under the specified key.
getAccountDataBundle(String...) - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Returns the bundle with data for the current single account (if created).
getAccountDataBundle(Account, String...) - Method in class universum.studios.android.officium.account.UserAccountManager: Returns the bundle with data for the given account.
getAccountPassword() - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Returns the password for the current single account (if created).
getAccountPassword(Account) - Method in class universum.studios.android.officium.account.UserAccountManager: Returns the password for the given account.
getAccountType() - Method in class universum.studios.android.officium.account.UserAccountManager: Returns the type of account that this manager can manage (add, rename, remove).
getApi() - Method in class universum.studios.android.officium.service.ServiceApiProvider: Returns the service api implementation specific for this api provider.
getAuthority() - Method in class universum.studios.android.officium.sync.BaseSyncManager: Returns the content authority with which has been this manager created.
getAuthToken(AccountAuthenticatorResponse, Account, String, Bundle) - Method in class universum.studios.android.officium.account.BaseAccountAuthenticator
getAuthToken(String) - Method in class universum.studios.android.officium.account.UserAccount: Returns the authentication token specified for this user account for the requested tokenType.
getAuthTokenLabel(String) - Method in class universum.studios.android.officium.account.BaseAccountAuthenticator
getAuthTokens() - Method in class universum.studios.android.officium.account.UserAccount: Returns the map with authentication tokens specified for this user account mapped to theirs types.
getAuthTokenTypes() - Method in class universum.studios.android.officium.account.UserAccount: Returns the types of authentication tokens specific for this user account.
getBaseUrl() - Method in interface universum.studios.android.officium.service.EndPoint: Returns the base url of this end point.
getBus() - Method in class universum.studios.android.officium.event.SimpleEventBus: Returns the original bus wrapped.
getContext() - Method in class universum.studios.android.officium.account.UserAccountManager: Returns the context with which has been this manager created.
getContext() - Method in class universum.studios.android.officium.sync.BaseSyncManager: Returns the context with which has been this manager created.
getData(String) - Method in class universum.studios.android.officium.account.UserAccount: Returns the data value contained within data bundle of this user account under the specified key.
getDataBundle() - Method in class universum.studios.android.officium.account.UserAccount: Returns the data bundle of this user account
getEndPoint() - Method in class universum.studios.android.officium.service.ServiceManager: Returns the end point specified for this manager.
getErrorBody() - Method in class universum.studios.android.officium.service.ServiceError: Returns the error body of the response send by the server as result to call to the associated service and request.
getErrorBodyAs(Class<T>) - Method in class universum.studios.android.officium.service.ServiceError: Returns the error body of this service error as the desired type.
getErrorCode() - Method in class universum.studios.android.officium.service.ErrorResponse: Returns the code of the error (if any) of this response.
getErrorCode() - Method in class universum.studios.android.officium.service.ServiceError: Returns the error code of the response send by the server as result to call to the associated service and request.
getErrorMessage() - Method in class universum.studios.android.officium.service.ErrorResponse: Returns the message of the error (if any) of this response.
getEventDispatcher() - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Returns the event dispatcher specified for this sync adapter.
getFailure() - Method in class universum.studios.android.officium.service.ServiceError: Returns the failure that has caused the associated service and request to fail.
getGlobalSyncHandler() - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Returns the sync handler that is responsible for global synchronization handling.
getId() - Method in class universum.studios.android.officium.sync.SyncTask: Returns the id of this task.
getLogger() - Static method in class universum.studios.android.officium.OfficiumLogging: Returns the logger used by this logging class.
getName() - Method in class universum.studios.android.officium.account.UserAccount: Returns the name specified for this user account.
getOAuthToken() - Method in class universum.studios.android.officium.account.UserAccount: Same as UserAccount.getAuthToken(String) with UserAccount.TOKEN_TYPE_O_AUTH as tokenType.
getPassword() - Method in class universum.studios.android.officium.account.UserAccount: Returns the password specified for this user account.
getRequest(Class<R>) - Method in class universum.studios.android.officium.sync.SyncTask: Returns the request specified for this task.
getRequestBody() - Method in class universum.studios.android.officium.sync.SyncTask: Returns a body of the request specified for this task.
getRequestId() - Method in class universum.studios.android.officium.service.BaseServiceObject
getRequestId() - Method in interface universum.studios.android.officium.service.ServiceObject: Returns the unique id of the request with which is this service object associated.
getServiceId() - Method in class universum.studios.android.officium.service.BaseServiceObject
getServiceId() - Method in interface universum.studios.android.officium.service.ServiceObject: Returns the id of service with which is this service object associated.
getState() - Method in class universum.studios.android.officium.sync.SyncTask: Returns the current state of this task.
getTaskId() - Method in class universum.studios.android.officium.sync.SyncHandler: Returns id of the associated synchronization task.

H

handleSync(Context, SyncOperation) - Method in class universum.studios.android.officium.sync.SyncHandler: Called to perform synchronization process that is specific for this handler.
hasAuthToken(String) - Method in class universum.studios.android.officium.account.UserAccount: Checks whether there is authentication token specified for this user account for the specified tokenType.
hasData(String) - Method in class universum.studios.android.officium.account.UserAccount: Checks whether this account has data with the specified key associated.
hasFeatures(AccountAuthenticatorResponse, Account, String[]) - Method in class universum.studios.android.officium.account.BaseAccountAuthenticator
hashCode() - Method in class universum.studios.android.officium.account.UserAccount
hashCode() - Method in class universum.studios.android.officium.sync.SyncTask

I

i(String, String) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#i(String, String).
i(String, String, Throwable) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#i(String, String, Throwable).
id - Variable in class universum.studios.android.officium.sync.SyncEvent: Id of the synchronization task for which has been this synchronization event fired.
IDLE - Static variable in class universum.studios.android.officium.sync.SyncTask: Initial state for each new SyncTask.
intercept(Chain) - Method in class universum.studios.android.officium.service.auth.AuthRequestInterceptor
intoExtras(Bundle) - Method in class universum.studios.android.officium.sync.SyncTask: Puts all data of this task into the given extras Bundle.
invalidate() - Method in class universum.studios.android.officium.service.ServiceManager.ServicesConfiguration: Invalidates the current configuration.
invalidateAccountAuthToken(String) - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Invalidates the specified authToken for the current single account (if created).
invalidateAccountAuthToken(Account, String) - Method in class universum.studios.android.officium.account.UserAccountManager: Invalidates the specified authToken for the given account.
invalidateApi() - Method in class universum.studios.android.officium.service.ServiceApiProvider: Makes the current api implementation cached by this provider invalid so when ServiceApiProvider.getApi() is next time called a new instance of api will be requested via ServiceApiProvider.onCreateApi().
isAccountAuthenticated(String) - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Checks whether the current single account (if created) is authenticated or not.
isAccountAuthenticated(Account, String) - Method in class universum.studios.android.officium.account.UserAccountManager: Checks whether the given account is authenticated or not.
isAccountCreated() - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Checks whether there is account created or not.
isCanceled() - Method in class universum.studios.android.officium.service.ServiceCall
isError() - Method in class universum.studios.android.officium.service.ServiceError: Checks whether this service error represents an error response that has been received from the server for the associated service and request.
isExecuted() - Method in class universum.studios.android.officium.service.ServiceCall
isFailure() - Method in class universum.studios.android.officium.service.ServiceError: Checks whether this service error represents a failure that has caused the associated service and request to fail during its execution.
isSyncActive() - Method in class universum.studios.android.officium.sync.BaseSyncManager: Checks whether there is currently a synchronization being processed for the content authority specified for this manager and account picked for synchronization by this manager implementation.
isSyncPedning() - Method in class universum.studios.android.officium.sync.BaseSyncManager: Checks whether there are any pending synchronizations for the content authority specified for this manager and account picked for synchronization by this manager implementation.

L

LOG_ENABLED - Static variable in class universum.studios.android.officium.OfficiumConfig: Deprecated.
No longer used across the library.

M

mAccountType - Variable in class universum.studios.android.officium.account.UserAccountManager: Deprecated.
Use UserAccountManager.getAccountType() instead.
mAuthority - Variable in class universum.studios.android.officium.sync.BaseSyncManager: Deprecated.
Use BaseSyncManager.getAuthority() instead.
mBus - Variable in class universum.studios.android.officium.event.SimpleEventBus: Deprecated.
Use SimpleEventBus.getBus() instead.
mContext - Variable in class universum.studios.android.officium.account.UserAccountManager: Deprecated.
Use UserAccountManager.getContext() instead.
mContext - Variable in class universum.studios.android.officium.sync.BaseSyncManager: Deprecated.
Use BaseSyncManager.getContext() instead.
message - Variable in class universum.studios.android.officium.service.ErrorResponse.Error: Message of this error.
mManager - Variable in class universum.studios.android.officium.account.UserAccountManager: Account manager used to create/update/delete accounts of the type specified for this manager.
mManager - Variable in class universum.studios.android.officium.service.ServiceApi: Instance of ServiceManager used to configure and access services provided by this API.
mName - Variable in class universum.studios.android.officium.account.UserAccount: Name specified for this user account.
mPassword - Variable in class universum.studios.android.officium.account.UserAccount: Password specified for this user account.

N

nextRequestId() - Method in class universum.studios.android.officium.service.ServiceCall: Called to generate a unique id for the current service request that has been requested to be executed asynchronously via ServiceCall.enqueue(ServiceCallback).
NO_REQUEST - Static variable in interface universum.studios.android.officium.service.ServiceObject: Constant used to identify that a specific ServiceObject is not associated with any particular service request.
NO_SERVICE - Static variable in interface universum.studios.android.officium.service.ServiceObject: Constant used to identify that a specific ServiceObject is not associated with any service.

O

OfficiumConfig - Class in universum.studios.android.officium: Deprecated.
No longer used across the library. For logging control use OfficiumLogging instead.
OfficiumLogging - Class in universum.studios.android.officium: Utility class used by the Officium library for logging purpose.
onAccountCreated(A) - Method in interface universum.studios.android.officium.account.UserAccountManager.AccountWatcher: Invoked whenever a new Android Account has been created for the specified userAccount after call to UserAccountManager.createAccountAsync(UserAccount).
onAccountDeleted(A) - Method in interface universum.studios.android.officium.account.UserAccountManager.AccountWatcher: Invoked whenever an old Android Account has been deleted for the specified userAccount after call to UserAccountManager.deleteAccountAsync(UserAccount).
onAccountError(A, ErrorException) - Method in interface universum.studios.android.officium.account.UserAccountManager.AccountWatcher: Invoked whenever an error occurs during execution of one of account management related tasks.
onCancelSync(Account) - Method in class universum.studios.android.officium.sync.BaseSyncManager: Invoked whenever BaseSyncManager.cancelSync() is called.
onCreateAccount(A) - Method in class universum.studios.android.officium.account.UserAccountManager: Invoked whenever UserAccountManager.createAccount(UserAccount) or UserAccountManager.createAccountAsync(UserAccount) is called to create new Android Account.
onCreateApi() - Method in class universum.studios.android.officium.service.ServiceApiProvider: Invoked whenever ServiceApiProvider.getApi() is called and there is no instance of api specific for this provider instantiated whether due to first call to ServiceApiProvider.getApi() or due to invalidation of the previous api instance via ServiceApiProvider.invalidateApi().
onCreateServicesConfiguration(Class<?>) - Method in class universum.studios.android.officium.service.ServiceManager: Invoked whenever ServiceManager.servicesConfiguration(Class) or ServiceManager.services(Class) is called for the first time for the specified servicesInterface.
onDeleteAccount(A) - Method in class universum.studios.android.officium.account.UserAccountManager: Invoked whenever UserAccountManager.createAccount(UserAccount) or UserAccountManager.createAccountAsync(UserAccount) is called to create new Android Account.
onDispatchError(ServiceError) - Method in class universum.studios.android.officium.service.ServiceCallback: Invoked to dispatch the given error object to its receivers.
onDispatchResponse(R) - Method in class universum.studios.android.officium.service.ServiceCallback: Invoked to dispatch the given responseBody object to its receivers.
onFailure(<any>, Throwable) - Method in class universum.studios.android.officium.service.ServiceCallback
onGlobalSyncFailed(SyncOperation, Exception) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Invoked whenever BaseSyncAdapter.onPerformGlobalSync(SyncOperation) is invoked and there is thrown the given error exception during its execution.
onGlobalSyncFinished(SyncOperation) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Invoked whenever BaseSyncAdapter.onPerformGlobalSync(SyncOperation) finishes without any error.
onHandleSync(Context, SyncOperation, Request) - Method in class universum.studios.android.officium.sync.SyncHandler: Invoked whenever SyncHandler.handleSync(Context, SyncOperation) is called to perform synchronization specific for this handler.
onPerformGlobalSync(SyncOperation) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Invoked whenever BaseSyncAdapter.onPerformSync(Account, Bundle, String, ContentProviderClient, SyncResult) is invoked and the extras Bundle does not contain data for a specific SyncTask but rather for a global SyncTask.
onPerformSync(Account, Bundle, String, ContentProviderClient, SyncResult) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter
onPerformSync(SyncOperation) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Invoked whenever BaseSyncAdapter.onPerformSync(Account, Bundle, String, ContentProviderClient, SyncResult) is invoked and the extras Bundle does contain data for a specific SyncTask.
onPrepareApi(A) - Method in class universum.studios.android.officium.service.ServiceApiProvider: Invoked whenever ServiceApiProvider.getApi() is called to make some additional preparation of the given api instance before it is returned to the user.
onResponse(<any>, <any>) - Method in class universum.studios.android.officium.service.ServiceCallback
onSyncError(Context, SyncOperation, Request, Exception) - Method in class universum.studios.android.officium.sync.SyncHandler: Invoked whenever SyncHandler.onHandleSync(Context, SyncOperation, SyncTask.Request) is invoked and there is thrown the given error exception during its execution.
onSyncFailed(SyncOperation, Exception) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Invoked whenever BaseSyncAdapter.onPerformSync(SyncOperation) is invoked and there is thrown the given error exception during its execution.
onSyncFinished(SyncOperation) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Invoked whenever BaseSyncAdapter.onPerformSync(SyncOperation) finishes without any error.
onSyncTaskStateChanged(SyncTask, Account) - Method in class universum.studios.android.officium.sync.BaseSyncManager
onSyncTaskStateChanged(SyncTask, Account) - Method in interface universum.studios.android.officium.sync.OnSyncTaskStateChangeListener: Invoked whenever a state of the specified syncTask has been changed.
OnSyncTaskStateChangeListener - Interface in universum.studios.android.officium.sync: Listener that may be used to receive callback whenever a state of a particular SyncTask is changed.

P

peekAccountAuthToken(String) - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Returns the authentication token for the current single account (if created) stored for the specified authTokenType.
peekAccountAuthToken(Account, String) - Method in class universum.studios.android.officium.account.UserAccountManager: Returns the authentication token for the given account stored for the specified authTokenType.
peekToken() - Method in interface universum.studios.android.officium.service.auth.AuthTokenProvider: Returns the auth token provided by this token provided.
PENDING - Static variable in class universum.studios.android.officium.sync.SyncTask: State indicating that SyncTask is in pending state waiting to be executed.
PERMISSION_AUTHENTICATE_ACCOUNTS - Static variable in class universum.studios.android.officium.account.UserAccountManager: Value for Android permission to AUTHENTICATE accounts.
PERMISSION_GET_ACCOUNTS - Static variable in class universum.studios.android.officium.account.UserAccountManager: Value for Android permission to GET accounts.
PERMISSION_MANAGE_ACCOUNTS - Static variable in class universum.studios.android.officium.account.UserAccountManager: Value for Android permission to MANAGE accounts.
pickAccountForSync() - Method in class universum.studios.android.officium.sync.BaseSyncManager: Called to pick account for the current synchronization related request dispatched to this manager.
post(Object) - Method in interface universum.studios.android.officium.event.EventBus: Posts the specified event to all handlers registered on this event bus.
post(Object) - Method in class universum.studios.android.officium.event.SimpleEventBus: Delegates to Bus#post(Object).
post(Object) - Method in class universum.studios.android.officium.event.UiEventBus
progress(int) - Method in class universum.studios.android.officium.sync.SyncEvent.Builder: Specifies a progress of running synchronization.
PROGRESS - Static variable in class universum.studios.android.officium.sync.SyncEvent: Type flag for SyncEvent determining progress of synchronization.
progress - Variable in class universum.studios.android.officium.sync.SyncEvent: Current progress of synchronization task with SyncEvent.id.
putAuthToken(String, String) - Method in class universum.studios.android.officium.account.UserAccount: Puts the given token into authentication tokens of this user account under the specified tokenType as key.
putData(String, String) - Method in class universum.studios.android.officium.account.UserAccount: Puts the given data into data bundle of this user account under the specified key.
putOAuthToken(String) - Method in class universum.studios.android.officium.account.UserAccount: Same as UserAccount.putAuthToken(String, String) with UserAccount.TOKEN_TYPE_O_AUTH as tokenType.

R

register(Object) - Method in interface universum.studios.android.officium.event.EventBus: Registers the specified object as handler and producer on this event bus.
register(Object) - Method in class universum.studios.android.officium.event.SimpleEventBus: Delegates to Bus#register(Object).
registerTaskHandler(SyncHandler) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Registers a sync handler that will be used by this sync adapter for synchronization handling of a SyncTask associated with the given handler via SyncHandler.getTaskId().
registerWatcher(UserAccountManager.AccountWatcher<A>) - Method in class universum.studios.android.officium.account.UserAccountManager: Registers a watcher to be notified whenever a new user account is created or an old one deleted.
removeData(String) - Method in class universum.studios.android.officium.account.UserAccount: Removes the data specified for this account for the specified key.
request() - Method in class universum.studios.android.officium.service.ServiceCall
request(R) - Method in class universum.studios.android.officium.sync.SyncTask.Builder: Specifies a request for the synchronization task to build.
requestGlobalSync() - Method in class universum.studios.android.officium.sync.BaseSyncManager: Same as BaseSyncManager.requestSync(SyncTask) with sync task with SyncTask.DEFAULT_ID id.
requestId() - Method in class universum.studios.android.officium.service.ServiceCall: Deprecated.
Use ServiceCall.nextRequestId() instead.
requestSync(SyncTask) - Method in class universum.studios.android.officium.sync.BaseSyncManager: Requests synchronization operation to be performed for the specified syncTask.
retrofit() - Method in class universum.studios.android.officium.service.ServiceManager.ServicesConfiguration: Returns the Retrofit instance for the current configuration.
retrofitBuilder() - Method in class universum.studios.android.officium.service.ServiceManager.ServicesConfiguration: Returns the Retrofit builder that is used to build instance of Retrofit and instance of services PROXY for this services configuration.
RUNNING - Static variable in class universum.studios.android.officium.sync.SyncTask: State indicating that SyncTask is currently being executed.

S

ServiceApi<M extends ServiceManager> - Class in universum.studios.android.officium.service: ServiceApi represents an access layer for a single services interface or set of such service interfaces.
ServiceApi(M) - Constructor for class universum.studios.android.officium.service.ServiceApi: Creates a new instance of ServiceApi with the specified service manager.
ServiceApiProvider<A> - Class in universum.studios.android.officium.service: ServiceApiProvider represents a provider that can provide an instance of ServiceApi implementation.
ServiceApiProvider() - Constructor for class universum.studios.android.officium.service.ServiceApiProvider
ServiceCall<T> - Class in universum.studios.android.officium.service: A Call implementation that wraps original Retrofit call to provide functionality that supports association of ServiceCallback with the related service along with service request.
ServiceCall(<any>) - Constructor for class universum.studios.android.officium.service.ServiceCall: Creates a new instance of ServiceCall with the given original Retrofit call.
ServiceCallback<R> - Class in universum.studios.android.officium.service: Base implementation of Callback that may be used to receive a response for a particular service request asynchronously and dispatch it to its receivers.
ServiceCallback() - Constructor for class universum.studios.android.officium.service.ServiceCallback
ServiceError - Class in universum.studios.android.officium.service: A BaseServiceObject implementation that represents an error occurred during service execution.
ServiceError(int, ResponseBody) - Constructor for class universum.studios.android.officium.service.ServiceError: Creates a new instance of ServiceError with the specified errorCode and errorBody received from the server as error response for the associated service and request.
ServiceError(Throwable) - Constructor for class universum.studios.android.officium.service.ServiceError: Creates a new instance of ServiceError with the specified failure.
ServiceError(ServiceError) - Constructor for class universum.studios.android.officium.service.ServiceError: Creates a new instance of ServiceError with data of the given one.
ServiceManager - Class in universum.studios.android.officium.service: Manager that may be used for accessing of multiple instances of services (theirs PROXYies) and also of theirs configuration.
ServiceManager() - Constructor for class universum.studios.android.officium.service.ServiceManager: Creates a new instance of ServiceManager without specified end point.
ServiceManager(EndPoint) - Constructor for class universum.studios.android.officium.service.ServiceManager: Creates a new instance of ServiceManager with the specified endPoint.
ServiceManager.ServicesConfiguration<S> - Class in universum.studios.android.officium.service: Class used for configuration of a specific Retrofit services interface.
ServiceObject - Interface in universum.studios.android.officium.service: Interface for objects that may be associated with services and theirs requests.
ServiceResponse - Class in universum.studios.android.officium.service: A BaseServiceObject implementation for service objects used to parse body of response send by a server.
ServiceResponse() - Constructor for class universum.studios.android.officium.service.ServiceResponse
services(Class<S>) - Method in class universum.studios.android.officium.service.ServiceApi: Returns an instance of services PROXY for the specified servicesInterface.
services(Class<S>) - Method in class universum.studios.android.officium.service.ServiceManager: Returns the PROXY instance for the requested servicesInterface.
servicesConfiguration(Class<S>) - Method in class universum.studios.android.officium.service.ServiceApi: Returns the configuration for services with the specified servicesInterface.
servicesConfiguration(Class<S>) - Method in class universum.studios.android.officium.service.ServiceManager: Returns the services configuration object for the requested servicesInterface.
setAccountAuthToken(String, String) - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Sets an authentication token for the current single account (if created) with the specified authTokenType.
setAccountAuthToken(Account, String, String) - Method in class universum.studios.android.officium.account.UserAccountManager: Sets an authentication token for the given account with the specified authTokenType.
setAccountData(String, String) - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Sets a single data value for the current single account (if created) with the specified key.
setAccountData(Account, String, String) - Method in class universum.studios.android.officium.account.UserAccountManager: Sets a single data value for the given account with the specified key.
setAccountDataBundle(Bundle) - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Sets a bundle with data for the current single account (if created).
setAccountDataBundle(Account, Bundle) - Method in class universum.studios.android.officium.account.UserAccountManager: Sets a bundle with data for the given account.
setAccountPassword(String) - Method in class universum.studios.android.officium.account.SingleUserAccountManager: Sets a password for the current single account (if created).
setAccountPassword(Account, String) - Method in class universum.studios.android.officium.account.UserAccountManager: Sets a password for the given account.
setDataBundle(Bundle) - Method in class universum.studios.android.officium.account.UserAccount: Sets a data bundle for this user account.
setDataCrypto(Crypto) - Method in class universum.studios.android.officium.account.UserAccountManager: Sets an implementation of Crypto that should be used by this account manager to perform account data encryption/decryption operations.
setEndPoint(String) - Method in class universum.studios.android.officium.service.ServiceManager: Same as ServiceManager.setEndPoint(EndPoint) with EndPoint instance providing the given baseUrl as its base url via EndPoint.getBaseUrl().
setEndPoint(EndPoint) - Method in class universum.studios.android.officium.service.ServiceManager: Sets an end point for this manager.
setErrorBodyConverter(<any>) - Method in class universum.studios.android.officium.service.ServiceError: Sets a converter that should be used to covert error body of this service error to the desired object when ServiceError.getErrorBodyAs(Class) is called.
setEventDispatcher(BaseSyncAdapter.EventDispatcher) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Sets an dispatcher that is used by this sync adapter to dispatch synchronization events.
setGlobalSyncHandler(SyncHandler) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Sets a sync handler that is responsible for global synchronization handling.
setKeyEncrypto(Encrypto) - Method in class universum.studios.android.officium.account.UserAccountManager: Sets an implementation of Encrypto that should be used by this account manager to perform account data keys encryption operation.
setLogger(Logger) - Static method in class universum.studios.android.officium.OfficiumLogging: Sets a logger to be used by this logging class to print out logs into console.
setOnTaskStateChangeListener(OnSyncTaskStateChangeListener) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Registers a callback to be invoked whenever a state is changed for a particular SyncTask within this sync adapter.
setPassword(String) - Method in class universum.studios.android.officium.account.UserAccount: Sets a new password for this account.
setRequestId(String) - Method in class universum.studios.android.officium.service.BaseServiceObject
setRequestId(String) - Method in interface universum.studios.android.officium.service.ServiceObject: Sets an id of the request with which is this service object associated.
setServiceId(int) - Method in class universum.studios.android.officium.service.BaseServiceObject
setServiceId(int) - Method in interface universum.studios.android.officium.service.ServiceObject: Specifies an id of the service with which is this service object associated.
shouldRequestSync(SyncTask, Account) - Method in class universum.studios.android.officium.sync.BaseSyncManager: Called from BaseSyncManager.requestSync(SyncTask) to check whether a synchronization should be requested for the specified syncTask and account.
SimpleEventBus - Class in universum.studios.android.officium.event: An EventBus implementation that wraps Bus provided by the Otto library.
SimpleEventBus() - Constructor for class universum.studios.android.officium.event.SimpleEventBus: Same as SimpleEventBus.SimpleEventBus(Bus) with default instance of Bus.
SimpleEventBus(Bus) - Constructor for class universum.studios.android.officium.event.SimpleEventBus: Creates a new instance of SimpleEventBus that wraps the specified bus.
SingleUserAccountManager<A extends UserAccount> - Class in universum.studios.android.officium.account: A UserAccountManager implementation that can be used for Android applications that allow only one account to be created for a user.
SingleUserAccountManager(Context, String) - Constructor for class universum.studios.android.officium.account.SingleUserAccountManager: Creates a new instance of SingleUserAccountManager for the specified accountType.
START - Static variable in class universum.studios.android.officium.sync.SyncEvent: Type flag for SyncEvent determining start of synchronization.
startAutomaticSync() - Method in class universum.studios.android.officium.sync.BaseSyncManager: Starts automatic synchronization for the content authority specified for this manager and account picked for synchronization by this manager implementation.
stopAutomaticSync() - Method in class universum.studios.android.officium.sync.BaseSyncManager: Stops automatic synchronization for the content authority specified for this manager and account picked for synchronization by this manager implementation.
SyncEvent - Class in universum.studios.android.officium.sync: Event that can be fired/post for receivers that listen for state of a concrete synchronization process/task.
SyncEvent.Builder - Class in universum.studios.android.officium.sync: Builder that can be used to create a new instance of SyncEvent.
SyncHandler<Request extends SyncTask.Request,Result> - Class in universum.studios.android.officium.sync: Base class for handlers that are used by BaseSyncAdapter to handle synchronization process for a specific SyncTasks.
SyncHandler(int) - Constructor for class universum.studios.android.officium.sync.SyncHandler: Same as SyncHandler.SyncHandler(int, Class) without classOfRequest specified.
SyncHandler(int, Class<Request>) - Constructor for class universum.studios.android.officium.sync.SyncHandler: Creates a new instance of SyncHandler with the specified taskId and classOfRequest.
SyncOperation - Class in universum.studios.android.officium.sync: SyncOperation contains data that are describing a specific synchronization request to be executed in BaseSyncAdapter.
SyncTask<R extends SyncTask.Request> - Class in universum.studios.android.officium.sync: Task that can be used to request synchronization via implementation of BaseSyncManager.
SyncTask(SyncTask) - Constructor for class universum.studios.android.officium.sync.SyncTask: Creates a new instance of SyncTask with data of the given one.
SyncTask(SyncTask.Builder<R>) - Constructor for class universum.studios.android.officium.sync.SyncTask: Creates a new instance of SyncTask with data specified within the given builder.
SyncTask(Bundle) - Constructor for class universum.studios.android.officium.sync.SyncTask: Creates a new instance of SyncTask with data specified within the given extras Bundle.
SyncTask.Builder<R extends SyncTask.Request> - Class in universum.studios.android.officium.sync: Builder that can be used to create a new instance of SyncTask.
SyncTask.EmptyRequest - Class in universum.studios.android.officium.sync: A SyncTask.Request implementation that may be used for SyncHandlers that does not require any synchronization request.
SyncTask.Request - Interface in universum.studios.android.officium.sync: Required interface for all synchronization requests.
SyncTask.State - Annotation Type in universum.studios.android.officium.sync: Defines an annotation for determining set of available states for SyncTask.

T

task - Variable in class universum.studios.android.officium.sync.SyncOperation: Task associated with this sync operation.
TOKEN_TYPE_O_AUTH - Static variable in class universum.studios.android.officium.account.UserAccount: Type key for the OAuth token.
toString() - Method in class universum.studios.android.officium.service.ErrorResponse.Error
toString() - Method in class universum.studios.android.officium.service.ErrorResponse
toString() - Method in class universum.studios.android.officium.service.ServiceError
toString() - Method in class universum.studios.android.officium.sync.SyncTask
type(int) - Method in class universum.studios.android.officium.sync.SyncEvent.Builder: Specifies a type of SyncEvent that will be fired.
type - Variable in class universum.studios.android.officium.sync.SyncEvent: Type of this synchronization event.

U

UiEventBus - Class in universum.studios.android.officium.event: A SimpleEventBus implementation that may be used for event buses that should post their events on the Main thread.
UiEventBus() - Constructor for class universum.studios.android.officium.event.UiEventBus: Same as UiEventBus.UiEventBus(Bus) with default instance of Bus.
UiEventBus(Bus) - Constructor for class universum.studios.android.officium.event.UiEventBus: Creates a new instance of UiEventBus that wraps the specified bus.
UNAUTHORIZED - Static variable in interface universum.studios.android.officium.service.auth.AuthTokenProvider: Provider instance that may be used for unauthorized requests that does not require authorization token to be send to an application server.
universum.studios.android.officium - package universum.studios.android.officium
universum.studios.android.officium.account - package universum.studios.android.officium.account
universum.studios.android.officium.event - package universum.studios.android.officium.event
universum.studios.android.officium.service - package universum.studios.android.officium.service
universum.studios.android.officium.service.auth - package universum.studios.android.officium.service.auth
universum.studios.android.officium.sync - package universum.studios.android.officium.sync
unregister(Object) - Method in interface universum.studios.android.officium.event.EventBus: Unregisters the specified object as handler and producer from this event bus.
unregister(Object) - Method in class universum.studios.android.officium.event.SimpleEventBus: Delegates to Bus#unregister(Object).
unregisterTaskHandler(SyncHandler) - Method in class universum.studios.android.officium.sync.BaseSyncAdapter: Un-registers previously registered sync handler.
unregisterWatcher(UserAccountManager.AccountWatcher<A>) - Method in class universum.studios.android.officium.account.UserAccountManager: Unregisters the given watcher from the registered ones.
updateCredentials(AccountAuthenticatorResponse, Account, String, Bundle) - Method in class universum.studios.android.officium.account.BaseAccountAuthenticator
UserAccount - Class in universum.studios.android.officium.account: Class representing a simple holder for user data used when creating Accounts via UserAccountManager.
UserAccount(String) - Constructor for class universum.studios.android.officium.account.UserAccount: Same as UserAccount.UserAccount(String, String) with null password.
UserAccount(String, String) - Constructor for class universum.studios.android.officium.account.UserAccount: Creates a new instance of UserAccount with the specified name and password.
UserAccountManager<A extends UserAccount> - Class in universum.studios.android.officium.account: Wrapper for AccountManager that can be used to simplify management of an Android application accounts.
UserAccountManager(Context, String) - Constructor for class universum.studios.android.officium.account.UserAccountManager: Creates a new instance of UserAccountManager for the specified accountType.
UserAccountManager.AccountWatcher<A extends UserAccount> - Interface in universum.studios.android.officium.account: Watcher that may be used to listen for callbacks fired whenever a new Android Account is created or deleted asynchronously for its associated UserAccount.

V

v(String, String) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#v(String, String).
v(String, String, Throwable) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#v(String, String, Throwable).

W

w(String, String) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#w(String, String).
w(String, Throwable) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#w(String, Throwable).
w(String, String, Throwable) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#w(String, String, Throwable).
withServiceId(int) - Method in class universum.studios.android.officium.service.ServiceCall: Specifies id of the service to be this call associated with.
wtf(String, String) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#wtf(String, String).
wtf(String, Throwable) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#wtf(String, Throwable).
wtf(String, String, Throwable) - Static method in class universum.studios.android.officium.OfficiumLogging: Delegates to Logger#wtf(String, String, Throwable).

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