Next Previous

Retired Document

Important: The information in this document is deprecated in Mac OS X v10.7; don't use it for new development. Instead use the iCloud extensions to the NSFileManager class to share file-based data and use the NSUbiquitousKeyValueStore class to share preferences. Use the Address Book framework to access shared contact data and use the Calendar Store framework to access shared calendar data.

Viewing Sync Client State

After verifying that your schema is registered, you should verify that your client—an application, server, or device—successfully registered with the sync engine. Specifically, you need to verify that the client description properties are correct. You can also view the sync state of each entity synced by your client.

Download the SimpleStickies sample code project to follow along in this chapter.

Viewing Client Properties

Your client should register with the sync engine after it launches and provide it with a client description property list as described in Registering Clients. Follow these steps to examine the client properties stored in the sync engine:

Launch your client.
Build and run SimpleStickies in Xcode or your client.
Launch Syncrospector.
Choose Clients from the left-side pop-up menu to see the registered clients.
You should see SimpleStickies listed as one of the registered clients in the Clients table below the toolbar. All the properties displayed in this table, except Last Sync, are properties you set when registering a client described in Client Description Properties. The Last Sync column displays the date the client last synced or never if it has not synced yet.
Select your client in the table and click Summary to view its properties.
The Summary pane displays more client description properties, as shown in Figure 3-1.
Figure 3-1 The summary pane

Viewing Sync Session State

You can examine the known state of each sync session.

Follow the steps in Viewing Client Properties to select your client.
Click Sync State to see the entities synced by this client in the table below.
The Sync State table displays the entity name, the date it was last synced, the status of that sync, and how the sync engine plans to sync it the next time, as shown in Figure 3-2. For example, since SimpleStickies already synced at launch, the next time it syncs it will fast sync (only changes are pushed and pulled). Read Sync Engine for a description of all the sync modes. The number in the Gen column is an identifier for the sync session where the entity was last synced.
Figure 3-2 The Sync State pane

Viewing Registered Entities

You need to specify both the entities and the entity properties that a client syncs as part of the client description property list described in Client Description Properties. Use Syncrospector to verify that your client is syncing the correct entities and properties.

Follow the steps in Viewing Client Properties to select your client.
Click Registration to see the entities and properties that the client syncs.
Select an entity in the column on the left in the Registration pane to view the entity properties in the column on the right, as shown in Figure 3-3.
Figure 3-3 The registration pane

Next Previous