beginSynchronize

Sends a message to the Unwired Server to synchronize data between the client and the server. There are two different beginSynchronize APIs, one with no parameters that synchronizes all the groups, and one that takes a list of groups.

The synchronization completes in the background through an asynchronous message exchange with the server. If application code needs to know when the synchronization is complete, a callback handler that implements the onSynchronize method must be registered with the database class.

In RBS, beginSynchronize creates a synchronize request, and puts it in the request queue; the synchronization thread processes the sync request, and does the synchronization automatically in the background. The synchronization thread can combine several synchronization requests and send them to the server. For each synchronization request, a SUPSynchronizationStatus_STARTING status is sent to the onSynchronize user callback function before the synchronization, and a SUPSynchronizationStatus_FINISHING status is sent to onSynchronize after the synchronization.

Syntax

+(void) beginSynchronize[:(SUPObjectList*)synchronizationGroups] [withContext:(NSString*)context]

Parameters

synchronizationGroups – specifies a list of a list of SUPSynchronizationGroup objects representing the groups to be synchronized. If omitted, begin synchronizing data for all groups.
Note: This parameter is not relevant for DOE packages; pass a null value to this parameter.
context – a reference string used when the server responds to the synchronization request. For more information on the onSynchronize callback handler method, see Callback Handlers in Developer Guide for iOS.

Returns

None.

Examples

Synchronize Data between Client and Server – Synchronize data for SUP101DB for all synchronization groups.
```
// Sync all groups

[SUP101SUP101DB beginSynchronize];
```

Synchronize a Particular Group – Synchronize data for SUP101DB for the SUP101 group.

// Sync all groups

[SUP101SUP101DB beginSynchronize];

// Sync just for particular groups. In this case, we just synchronize one group, 
// the group for the SUP101Customer MBO.

SUPObjectList *sgs = [SUPObjectList getInstance];
[sgs add:[SUP101Customer getSynchronizationGroup]];
[SUP101SUP101DB beginSynchronize:sgs withContext:@"customergroupcontext"];