oracle.opensync.syncagent

Class BGAgentStatus

java.lang.Object

oracle.opensync.syncagent.BGAgentStatus

public class BGAgentStatus
extends java.lang.Object

BGAgentStatus object represents the current status of sync agent.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	appName The name of the application or process which is running sync agent.
int	batteryPower Remaining battery life in %, if relevant.
java.lang.String	clientId Sync user name.
static int	DEFUNCT
java.lang.String	networkName Name of the network currently used for sync, evaluated by sync agent.
int	networkSpeed Network bandwidth, in bits per second.
static int	PAUSE_PENDING Sync agent is in the process of being paused.
static int	PAUSED Sync agent is paused.
int	processId Process id of the process which is running sync agent, if relevant for a given platform.
static int	RESUME_PENDING Sync agent is in the process of resuming.
static int	RUNNING Sync agent is running.
static int	START_PENDING Sync agent is in the process of starting.
int	statusCode Status code represented by one of the constants above.
static int	STOP_PENDING
static int	STOPPED Sync agent application is not running.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	statusName(int statusCode) Get language-specific name of a given status code

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

appName

public final java.lang.String appName

The name of the application or process which is running sync agent. On some platforms, such as Android, it is possible to run sync agent within an application process.

batteryPower

public final int batteryPower

Remaining battery life in %, if relevant.

clientId

public final java.lang.String clientId

Sync user name.

DEFUNCT

public static final int DEFUNCT

See Also:

Constant Field Values

networkName

public final java.lang.String networkName

Name of the network currently used for sync, evaluated by sync agent.

networkSpeed

public final int networkSpeed

Network bandwidth, in bits per second.

PAUSE_PENDING

public static final int PAUSE_PENDING

Sync agent is in the process of being paused.

See Also:

Constant Field Values

PAUSED

public static final int PAUSED

Sync agent is paused. When paused, none of the tasks within sync agent are running, but the resources such as memory, threads, etc. are kept for a quick resume. Pause and resume are generally faster than stop and start. When foreground sync is commenced, it will pause sync agent and later resume it after the foreground sync is finished.

See Also:

Constant Field Values

processId

public final int processId

Process id of the process which is running sync agent, if relevant for a given platform.

RESUME_PENDING

public static final int RESUME_PENDING

Sync agent is in the process of resuming.

See Also:

Constant Field Values

RUNNING

public static final int RUNNING

Sync agent is running. Any tasks within sync agent such as sync, compose, apply, rule evaluation, network evaluation and others can be active.

See Also:

Constant Field Values

START_PENDING

public static final int START_PENDING

Sync agent is in the process of starting.

See Also:

Constant Field Values

statusCode

public final int statusCode

Status code represented by one of the constants above.

STOP_PENDING

public static final int STOP_PENDING

See Also:

Constant Field Values

STOPPED

public static final int STOPPED

Sync agent application is not running.

See Also:

Constant Field Values

Method Detail

statusName

public static java.lang.String statusName(int statusCode)

Get language-specific name of a given status code

Parameters:

statusCode - status code as specified above

Returns:

the name such as "Stopped", "Running", etc. translated depending on the device language settings