com.eligor
クラス Eligor

java.lang.Object
  上位を拡張 com.eligor.Eligor

public final class Eligor
extends java.lang.Object

Contract of the content provider periodic sync control.

導入されたバージョン:
1.0.0

フィールドの概要
static java.lang.String TAG
           
 
メソッドの概要
 void applySyncPeriod()
          Apply automatic sync period with default value for all of the registered IPeriodicSyncManager.
 void applySyncPeriod(android.os.Bundle args)
          Apply automatic sync period with default value and extra arguments for all of the registered IPeriodicSyncManager.
 void applySyncPeriod(int period)
          Apply automatic sync period with the specified value in seconds for all of the registered IPeriodicSyncManager.
 void applySyncPeriod(int period, android.os.Bundle args)
          Apply automatic sync period with the specified value in seconds and extra arguments for all of the registered IPeriodicSyncManager.
 void applySyncPeriod(java.lang.String authority)
          Apply automatic sync period with the default value for the specified authority's IPeriodicSyncManager.
 void applySyncPeriod(java.lang.String authority, android.os.Bundle args)
          Apply automatic sync period with the default value and extra arguments for the specified authority's IPeriodicSyncManager.
 void applySyncPeriod(java.lang.String authority, int period)
          Apply automatic sync period with the specified value in seconds for the specified authority's IPeriodicSyncManager.
 void applySyncPeriod(java.lang.String authority, int period, android.os.Bundle args)
          Apply automatic sync period with the specified value in seconds and extra arguments for the specified authority's IPeriodicSyncManager.
 void cancelSync()
          Request to cancel currently working or enqueued sync operation for all of the registered IPeriodicSyncManager.
 void cancelSync(java.lang.String authority)
          Request to cancel currently working or enqueued sync operation for the specified authority's IPeriodicSyncManager.
static void destroy()
          Terminate and release all references of this class.
 void disableSync()
          Set sync setting as disabled for all of the registered IPeriodicSyncManager.
 void disableSync(java.lang.String authority)
          Set sync setting as disabled for the specified authority's IPeriodicSyncManager.
 void enableSync()
          Set sync setting as enabled for all of the registered IPeriodicSyncManager.
 void enableSync(java.lang.String authority)
          Set sync setting as enabled for the specified authority's IPeriodicSyncManager.
static Eligor getInstance()
          Returns a singleton instance of this class.
 IPeriodicSyncManager getPeriodicSyncManager(java.lang.String authority)
          Returns an instance of the registered periodic sync manager.
static void initialize(int defaultPeriod)
          Initialize singleton instance of this class.
 boolean isMasterSyncEnabled()
          Checks the settings whether the master automatic periodic sync is enabled or not on the phone.
 boolean isSyncable(java.lang.String authority)
          Checks if the specified provider authority is syncable or not.
 boolean isSyncActive()
          Checks if all of the registered IPeriodicSyncManager sync active.
 boolean isSyncActive(java.lang.String authority)
          Checks if the specified IPeriodicSyncManager sync active.
 boolean isSyncEnabled()
          Checks if all of the registered IPeriodicSyncManager sync enabled.
 boolean isSyncEnabled(java.lang.String authority)
          Checks if the specified IPeriodicSyncManager sync enabled.
 boolean isSyncPending()
          Checks if all of the registered IPeriodicSyncManager sync pending.
 boolean isSyncPending(java.lang.String authority)
          Checks if the specified IPeriodicSyncManager sync pending.
 void registerPeriodicSyncManager(IPeriodicSyncManager manager)
          Register periodic sync manager instance.
 void requestSync()
          Request on demand sync for all of the registered IPeriodicSyncManager.
 void requestSync(boolean enableFallback)
           
 void requestSync(android.os.Bundle args)
          Request on demand sync for all of the registered IPeriodicSyncManager with the extra arguments.
 void requestSync(android.os.Bundle args, boolean enableFallbak)
           
 void requestSync(java.lang.String authority)
          Request on demand sync for the specified authority's IPeriodicSyncManager.
 void requestSync(java.lang.String authority, boolean enableFallback)
           
 void requestSync(java.lang.String authority, android.os.Bundle args)
          Request on demand sync for the specified authority's IPeriodicSyncManager with the extra arguments.
 void requestSync(java.lang.String authority, android.os.Bundle args, boolean enableFallback)
           
 void setNotSyncable()
          Set the ContentProvider as not syncable for all of the registered IPeriodicSyncManager.
 void setNotSyncable(java.lang.String authority)
          Set the ContentProvider as not syncable for the specified authority's IPeriodicSyncManager.
 void setSyncable()
          Set the ContentProvider as syncable for all of the registered IPeriodicSyncManager.
 void setSyncable(java.lang.String authority)
          Set the ContentProvider as syncable for the specified authority's IPeriodicSyncManager.
 void unregisterPeriodicSyncManager(java.lang.String authority)
          Release registered periodic sync manager instance from this contract.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

TAG

public static final java.lang.String TAG
メソッドの詳細

initialize

public static void initialize(int defaultPeriod)
Initialize singleton instance of this class.

パラメータ:
defaultPeriod - default period of the automatic sync.

getInstance

public static Eligor getInstance()
Returns a singleton instance of this class.

戻り値:
this instance.

destroy

public static void destroy()
Terminate and release all references of this class.


isMasterSyncEnabled

public boolean isMasterSyncEnabled()
Checks the settings whether the master automatic periodic sync is enabled or not on the phone.

戻り値:
true if enabled on the master setting, false otherwise.

registerPeriodicSyncManager

public void registerPeriodicSyncManager(IPeriodicSyncManager manager)
Register periodic sync manager instance.

パラメータ:
manager - periodic sync manager for the Account and authority.

getPeriodicSyncManager

@Nullable
public IPeriodicSyncManager getPeriodicSyncManager(java.lang.String authority)
Returns an instance of the registered periodic sync manager.

パラメータ:
authority - the periodic sync manager is associated with.
戻り値:
periodic sync manager. null if not registered for the authority.

unregisterPeriodicSyncManager

public void unregisterPeriodicSyncManager(java.lang.String authority)
Release registered periodic sync manager instance from this contract.

パラメータ:
authority - the periodic sync manager is associated with.

applySyncPeriod

public void applySyncPeriod()
Apply automatic sync period with default value for all of the registered IPeriodicSyncManager.


applySyncPeriod

public void applySyncPeriod(android.os.Bundle args)
Apply automatic sync period with default value and extra arguments for all of the registered IPeriodicSyncManager.

パラメータ:
args - extra arguments for the AbstractThreadedSyncAdapter.

applySyncPeriod

public void applySyncPeriod(int period)
Apply automatic sync period with the specified value in seconds for all of the registered IPeriodicSyncManager.

パラメータ:
period - automatic sync period in seconds.

applySyncPeriod

public void applySyncPeriod(int period,
                            android.os.Bundle args)
Apply automatic sync period with the specified value in seconds and extra arguments for all of the registered IPeriodicSyncManager.

パラメータ:
period - automatic sync period in seconds.
args - extra arguments for the AbstractThreadedSyncAdapter.

applySyncPeriod

public void applySyncPeriod(java.lang.String authority)
Apply automatic sync period with the default value for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.

applySyncPeriod

public void applySyncPeriod(java.lang.String authority,
                            int period)
Apply automatic sync period with the specified value in seconds for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.
period - automatic sync period in seconds.

applySyncPeriod

public void applySyncPeriod(java.lang.String authority,
                            android.os.Bundle args)
Apply automatic sync period with the default value and extra arguments for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.
args - extra arguments for the AbstractThreadedSyncAdapter.

applySyncPeriod

public void applySyncPeriod(java.lang.String authority,
                            int period,
                            android.os.Bundle args)
Apply automatic sync period with the specified value in seconds and extra arguments for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.
period - automatic sync period in seconds.
args - extra arguments for the AbstractThreadedSyncAdapter.

requestSync

public void requestSync()
Request on demand sync for all of the registered IPeriodicSyncManager.


requestSync

public void requestSync(boolean enableFallback)

requestSync

public void requestSync(android.os.Bundle args)
Request on demand sync for all of the registered IPeriodicSyncManager with the extra arguments.

パラメータ:
args - extra arguments for the AbstractThreadedSyncAdapter.

requestSync

public void requestSync(android.os.Bundle args,
                        boolean enableFallbak)

requestSync

public void requestSync(java.lang.String authority)
Request on demand sync for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.

requestSync

public void requestSync(java.lang.String authority,
                        boolean enableFallback)

requestSync

public void requestSync(java.lang.String authority,
                        android.os.Bundle args)
Request on demand sync for the specified authority's IPeriodicSyncManager with the extra arguments.

パラメータ:
authority - the periodic sync manager is associated with.
args - extra arguments for the AbstractThreadedSyncAdapter.

requestSync

public void requestSync(java.lang.String authority,
                        android.os.Bundle args,
                        boolean enableFallback)

cancelSync

public void cancelSync()
Request to cancel currently working or enqueued sync operation for all of the registered IPeriodicSyncManager.


cancelSync

public void cancelSync(java.lang.String authority)
Request to cancel currently working or enqueued sync operation for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.

enableSync

public void enableSync()
Set sync setting as enabled for all of the registered IPeriodicSyncManager.


enableSync

public void enableSync(java.lang.String authority)
Set sync setting as enabled for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.

disableSync

public void disableSync()
Set sync setting as disabled for all of the registered IPeriodicSyncManager.


disableSync

public void disableSync(java.lang.String authority)
Set sync setting as disabled for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.

setSyncable

public void setSyncable()
Set the ContentProvider as syncable for all of the registered IPeriodicSyncManager.


setSyncable

public void setSyncable(java.lang.String authority)
Set the ContentProvider as syncable for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.

setNotSyncable

public void setNotSyncable()
Set the ContentProvider as not syncable for all of the registered IPeriodicSyncManager.


setNotSyncable

public void setNotSyncable(java.lang.String authority)
Set the ContentProvider as not syncable for the specified authority's IPeriodicSyncManager.

パラメータ:
authority - the periodic sync manager is associated with.

isSyncEnabled

public boolean isSyncEnabled()
Checks if all of the registered IPeriodicSyncManager sync enabled.

戻り値:
true all sync is enabled, false otherwise.

isSyncEnabled

public boolean isSyncEnabled(java.lang.String authority)
Checks if the specified IPeriodicSyncManager sync enabled.

パラメータ:
authority - the periodic sync manager is associated with.
戻り値:
true if the sync of the authority enabled, false otherwise.

isSyncActive

public boolean isSyncActive()
Checks if all of the registered IPeriodicSyncManager sync active.

戻り値:
true all sync is active, false otherwise.

isSyncActive

public boolean isSyncActive(java.lang.String authority)
Checks if the specified IPeriodicSyncManager sync active.

パラメータ:
authority - the periodic sync manager is associated with.
戻り値:
true if the sync of the authority active, false otherwise.

isSyncPending

public boolean isSyncPending()
Checks if all of the registered IPeriodicSyncManager sync pending.

戻り値:
true all sync is pending, false otherwise.

isSyncPending

public boolean isSyncPending(java.lang.String authority)
Checks if the specified IPeriodicSyncManager sync pending.

パラメータ:
authority - the periodic sync manager is associated with.
戻り値:
true if the sync of the authority is pending, false otherwise.

isSyncable

public boolean isSyncable(java.lang.String authority)
Checks if the specified provider authority is syncable or not.

パラメータ:
authority - the periodic sync manager is associated with.
戻り値:
true if syncable, false otherwise.