---

Sync Services Constants Reference

Overview

This chapter describes the types and constants found in the Sync Services:

Constants

Enumerations

ISyncChange—Change Types

typedef int ISyncChangeType;
enum __ISyncChangeType {
   ISyncChangeTypeAdd=1,
   ISyncChangeTypeModify,
   ISyncChangeTypeDelete
};

Discussion

These types are described in ISyncChange Class Reference.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

SyncServices/ISyncChange.h

ISyncClient—Client Status

typedef SInt32 ISyncStatus;
enum __ISyncStatus {
   ISyncStatusRunning=1,
   ISyncStatusSuccess,
   ISyncStatusWarnings,
   ISyncStatusErrors,
   ISyncStatusCancelled,
   ISyncStatusFailed,
   ISyncStatusNever
};

Discussion

These types are described in ISyncClient Class Reference.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

SyncServices/ISyncClient.h

ISyncSessionDriver—Preferred Sync Mode

typedef enum {
   ISyncSessionDriverModeFast = 1,
   ISyncSessionDriverModeSlow,
   ISyncSessionDriverModeRefresh,
} ISyncSessionDriverMode;

Discussion

These types are described in ISyncSessionDriverDataSource Protocol Reference.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

SyncServices/ISyncSessionDriver.h

ISyncSessionDriver—Status of Applying Changes

typedef enum {
   ISyncSessionDriverChangeRefused = 0,
   ISyncSessionDriverChangeAccepted,
   ISyncSessionDriverChangeIgnored,
   ISyncSessionDriverChangeError
} ISyncSessionDriverChangeResult;

Discussion

These types are described in ISyncSessionDriverDataSource Protocol Reference.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

SyncServices/ISyncSessionDriver.h

Error Codes

Codes for errors that can occur when using an ISyncSessionDriver object or other Sync Services classes.

enum {
   ISyncSessionClientAlreadySyncingError =        100,
   ISyncSessionUserCanceledSessionError =         101,
   ISyncSessionDriverRegistrationError =          200,
   ISyncSessionDriverPullFailureError =           201,
   ISyncSessionDriverFatalError =                 300
};

Constants

ISyncSessionClientAlreadySyncingError

Error code that indicates the client is already syncing.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h

ISyncSessionUserCanceledSessionError

Error code that indicates the user canceled the sync session.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h

ISyncSessionDriverRegistrationError

Error code that indicates the session driver failed to register the client.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h

ISyncSessionDriverPullFailureError

Error code that indicates the session driver failed to pull records.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h

ISyncSessionDriverFatalError

Error code that indicates an ISyncSessionDriver received a fatal error.

Available in Mac OS X v10.5 and later.

Declared in SyncServicesErrors.h

Availability

• Available in Mac OS X v10.5 and later.

Declared In

SyncServices/SyncServicesErrors.h

Global Variables

ISyncChange—Property Keys

extern NSString * const ISyncChangePropertyActionKey;
extern NSString * const ISyncChangePropertySet;
extern NSString * const ISyncChangePropertyClear;
extern NSString * const ISyncChangePropertyNameKey;
extern NSString * const ISyncChangePropertyValueKey;

Discussion

These constants are defined in ISyncChange Class Reference.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

SyncServices/ISyncChange.h

ISyncClient—Client Types

extern NSString * const ISyncClientTypeApplication;
extern NSString * const ISyncClientTypeDevice;
extern NSString * const ISyncClientTypeServer;
extern NSString * const ISyncClientTypePeer;

Discussion

These constants are defined in ISyncClient Class Reference.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

SyncServices/ISyncClient.h

ISyncManager—Exceptions

extern NSString * const ISyncServerUnavailableException

Discussion

This constant is defined in ISyncManager Class Reference.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

SyncServices/ISyncManager.h

ISyncSession—Exceptions

extern NSString * const ISyncSessionCancelledException;
extern NSString * const ISyncSessionUnavailableException;
extern NSString * const ISyncInvalidRecordException;
extern NSString * const ISyncInvalidRecordIdentifiersKey;
extern NSString * const ISyncInvalidRecordReasonsKey;
extern NSString * const ISyncInvalidRecordsKey;
extern NSString * const ISyncInvalidEntityException;
extern NSString * const ISyncUnsupportedEntityException;

Discussion

These constants are defined in ISyncSession Class Reference.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

SyncServices/ISyncSession.h

ISyncSession—Key

extern NSString * const ISyncRecordEntityNameKey;

Discussion

These constants are defined in ISyncSession Class Reference.

Availability

• Available in Mac OS X v10.4 and later.

Declared In

SyncServices/ISyncSession.h

ISyncErrorDomain

Domain for errors that occurred using Sync Services classes and methods.

NSString *const ISyncErrorDomain;

Availability

• Available in Mac OS X v10.5 and later.

Declared In

SyncServices/SyncServicesErrors.h

---