Method Detail

• setOperator

   final Unit setOperator(MenigaSyncOperations operator)

  Sets the api operator for doing api calls

  Parameters:

  operator - An object that implements the MenigaSyncOperations interface for carrying out api operations on this class.

• fetch

   final Result<MenigaSync> fetch(Long syncHistoryId)

  Gets a sync object that was created by start

  Parameters:

  syncHistoryId - The id of the sync object

• start

  @Deprecated(message = "Use syncRealms instead") final Result<MenigaSync> start(Long timeout)

  Use syncRealms instead.

• start

  @Deprecated(message = "Use syncRealms instead") final Result<MenigaSync> start(Long timeout, Long interval, Interceptor<MenigaSync> onDone)

  Use syncRealms instead.

• syncRealms

   final Result<MenigaSync> syncRealms(Long timeout)

  Starts the accounts synchronization process and also returns a MenigaSync object that contains further details.

  Parameters:

  timeout - Timeout for the sync procedure.

• syncRealms

   final Result<MenigaSync> syncRealms(Long timeout, Interceptor<MenigaSync> onDone)

  Starts the accounts synchronization process and also returns a MenigaSync object that contains further details.

  Parameters:

  timeout - The amount of time the background process should try to check if the sync has completed before terminating.

• syncRealm

   final Result<MenigaSync> syncRealm(Long realmUserId, Long timeout, Interceptor<MenigaSync> onDone)

  Starts the accounts synchronization process for a specific realm and also returns a MenigaSync object that contains further details.

  Parameters:

  realmUserId - The id of the realm account user - a realm is a "department" in e.g.

  timeout - The amount of time the background process should try to check if the sync has completed before terminating.

• syncRealm

   final Result<MenigaSync> syncRealm(Long realmUserId, String sessionToken, Long timeout, Interceptor<MenigaSync> onDone)

  Starts the accounts synchronization process for a specific realm with a session token already provided. Returns a MenigaSync object once the sync procedure has been launched.

  Parameters:

  realmUserId - The id of the realm account user - a realm is a "department" in e.g.

  sessionToken - A token from a previous (e.g.

  timeout - The amount of time the background process should try to check if the sync has completed before terminating.

• getSyncStatus

   final Result<MenigaSyncStatus> getSyncStatus()

  Checks to see the status of all synchronization operations on the back end