com.eligor
インタフェース IPeriodicSyncManager

既知の実装クラスの一覧:

PreferencedPeriodicSyncManager, SimplePeriodicSyncManager

public interface IPeriodicSyncManager

Interface to deal with the wrapper of periodic sync manager.

導入されたバージョン:

1.0.0

メソッドの概要

void	applySyncPeriod(int period) Applies sync period and enqueue the sync request.
void	applySyncPeriod(int period, android.os.Bundle args) Applies sync period and enqueue the sync request.
void	cancelSync() Cancels current sync progress.
void	disableSync() Disables periodic sync.
void	enableSync() Enables periodic sync.
android.accounts.Account	getAccount() Returns Account that is associated for the periodic sync of the auhtority.
java.lang.String	getAuthority() Returns provider authority for the periodic sync.
FallbackRunnable	getFallbackRunnable()
boolean	isSyncable() Checks if the periodic sync of the provider authority is set as syncable or not.
boolean	isSyncActive() Checks if the periodic sync of the provider authority is currently working or not.
boolean	isSyncEnabled() Checks if the provider authority has been configured as automatic periodic sync enabled for the account or not.
boolean	isSyncPending() Checks if the periodic sync of the provider authority is currently pending to work or not.
void	requestSync() Request on demand sync.
void	requestSync(android.os.Bundle args) Requests on demand sync.
void	setNotSyncable() Sets the provider authority as not syncable.
void	setSyncable() Sets the provider authority as syncable.

メソッドの詳細

applySyncPeriod

void applySyncPeriod(int period)

Applies sync period and enqueue the sync request. After the successful application, the sync will automatically requested by the framework.

パラメータ:

period - the period of each sync.

関連項目:

ContentResolver.addPeriodicSync(android.accounts.Account, String, android.os.Bundle, long)

applySyncPeriod

void applySyncPeriod(int period,
                     android.os.Bundle args)

Applies sync period and enqueue the sync request. After the successful application, the sync will automatically requested by the framework.

パラメータ:

period - the period of each sync.

args - extra arguments for the request.

関連項目:

ContentResolver.addPeriodicSync(android.accounts.Account, String, android.os.Bundle, long)

requestSync

void requestSync()

Request on demand sync.

関連項目:

ContentResolver.requestSync(android.accounts.Account, String, android.os.Bundle)

requestSync

void requestSync(android.os.Bundle args)

Requests on demand sync.

パラメータ:

args - extra arguments for the request.

関連項目:

ContentResolver.requestSync(android.accounts.Account, String, android.os.Bundle)

cancelSync

void cancelSync()

Cancels current sync progress.

関連項目:

ContentResolver.cancelSync(android.accounts.Account, String)

enableSync

void enableSync()

Enables periodic sync.

関連項目:

ContentResolver.setSyncAutomatically(android.accounts.Account, String, boolean)

disableSync

void disableSync()

Disables periodic sync.

関連項目:

ContentResolver.setSyncAutomatically(android.accounts.Account, String, boolean)

setSyncable

void setSyncable()

Sets the provider authority as syncable.

関連項目:

ContentResolver.setIsSyncable(android.accounts.Account, String, int)

setNotSyncable

void setNotSyncable()

Sets the provider authority as not syncable.

関連項目:

ContentResolver.setIsSyncable(android.accounts.Account, String, int)

isSyncEnabled

boolean isSyncEnabled()

Checks if the provider authority has been configured as automatic periodic sync enabled for the account or not.

戻り値:

true if enabled, false otherwise.

関連項目:

ContentResolver.getSyncAutomatically(android.accounts.Account, String)

isSyncActive

boolean isSyncActive()

Checks if the periodic sync of the provider authority is currently working or not.

戻り値:

true if currently active, false otherwise.

関連項目:

ContentResolver.isSyncActive(android.accounts.Account, String)

isSyncPending

boolean isSyncPending()

Checks if the periodic sync of the provider authority is currently pending to work or not.

戻り値:

true if currently pending, false otherwise.

関連項目:

ContentResolver.isSyncPending(android.accounts.Account, String)

isSyncable

boolean isSyncable()

Checks if the periodic sync of the provider authority is set as syncable or not.

戻り値:

true if syncable, false otherwise.

関連項目:

ContentResolver.getIsSyncable(android.accounts.Account, String)

getAccount

@Nonnull
android.accounts.Account getAccount()

Returns Account that is associated for the periodic sync of the auhtority.

戻り値:

an account. May not be null.

getAuthority

@Nonnull
java.lang.String getAuthority()

Returns provider authority for the periodic sync.

戻り値:

an authority. May not be null.

getFallbackRunnable

@Nonnull
FallbackRunnable getFallbackRunnable()

戻り値: