DITDitto Class Reference


                    
                    
                    deviceName

Configure a custom identifier for the current device.

When using observePeers, each remote peer is represented by a short UTF-8 “device name”.

By default this will be a truncated version of the device’s hostname. It does not need to be unique among peers.

Configure the device name before calling startSync:. If it is too long it may be truncated.

Declaration

Objective-C

@property (nonatomic) NSString *_Nonnull deviceName;


                    
                    
                    persistenceDirectory

Persistence directory used to persist Ditto data.

Declaration

Objective-C

@property (nonatomic) NSURL *_Nonnull persistenceDirectory;


                    
                    
                    appID

The Ditto application ID.

Declaration

Objective-C

@property (nonatomic, readonly) NSString *_Nonnull appID;


                    
                    
                    store

Provides access to the SDK’s store functionality.

Declaration

Objective-C

@property (readonly) DITStore *_Nonnull store;


                    
                    
                    diskUsage

Provides visibility into the local disk usage for Ditto.

Declaration

Objective-C

@property (readonly) DITDiskUsage *_Nonnull diskUsage;


                    
                    
                    auth

Provides access to authentication information and methods for logging on to Ditto Cloud.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) DITAuthenticator *auth;


                    
                    
                    presence

Provides access to the SDK’s presence functionality.

Declaration

Objective-C

@property (nonatomic, readonly) DITPresence *_Nonnull presence;


                    
                    
                    identity

Provides access to the instance’s identity information.

Declaration

Objective-C

@property (nonatomic, readonly) DITIdentity *_Nonnull identity;


                    
                    
                    activated

A flag indicating whether or not the SDK has been activated with a valid license token.

Declaration

Objective-C

@property (nonatomic, readonly, getter=isActivated) BOOL activated;


                    
                    
                    syncActive

A flag indicating whether or not sync is active. Use startSync: to activate sync and stopSync to deactivate sync.

Declaration

Objective-C

@property (nonatomic, readonly, getter=isSyncActive) BOOL syncActive;


                    
                    
                    transportConfig

Assign a new transports configuration. By default peer-to-peer transports (Bluetooth, WiFi and AWDL) are enabled.

You may use this method to alter the configuration at any time. Sync will not begin until startSync is called.

Declaration

Objective-C

@property (nonatomic, copy) DITTransportConfig *_Nonnull transportConfig;


                    
                    
                    siteID

The site ID that the instance of DITDitto is using as part of its identity.

Declaration

Objective-C

@property (nonatomic, readonly) uint64_t siteID;


                    
                    
                    delegate

An optional delegate that will be called with SDK lifecycle information if defined.

Declaration

Objective-C

@property (nonatomic, weak) id<DITDittoDelegate> _Nullable delegate;


                    
                    
                    delegateEventQueue

The dispatch queue that will be used to deliver delegate events. Defaults to the main queue.

Declaration

Objective-C

@property (nonatomic) dispatch_queue_t _Nonnull delegateEventQueue;


                    
                    
                    historyTrackingEnabled

Indicates whether history tracking is enabled or not.

Warning

History Tracking is experimental and shouldn’t be used in production.

Declaration

Objective-C

@property (nonatomic, readonly, getter=isHistoryTrackingEnabled) BOOL historyTrackingEnabled;


                    
                    
                    -init

Initializes a new DITDitto. This will initialize an instance of DITDitto with the default configuration.

Declaration

Objective-C

- (nonnull instancetype)init;


                    
                    
                    -initWithIdentity:

Initializes a new DITDitto.

Declaration

Objective-C

- (nonnull instancetype)initWithIdentity:(nonnull DITIdentity *)identity;

Parameters


                                identity

Provide the identity of the entity that is interacting with Ditto.


                    
                    
                    -initWithIdentity:historyTrackingEnabled:

Initializes a new DITDitto.

Warning

History Tracking is experimental and shouldn’t be used in production.

Declaration

Objective-C

- (nonnull instancetype)initWithIdentity:(nonnull DITIdentity *)identity
                  historyTrackingEnabled:(BOOL)historyTrackingEnabled;

Parameters

`identity`	Provide the identity of the entity that is interacting with Ditto.
`historyTrackingEnabled`	Whether or not you want history tracking enabled.


                    
                    
                    -initWithIdentity:persistenceDirectory:

Initializes a new DITDitto.

Declaration

Objective-C

- (nonnull instancetype)initWithIdentity:(nonnull DITIdentity *)identity
                    persistenceDirectory:(nullable NSURL *)directory;

Parameters

`identity`	Provide the identity of the entity that is interacting with Ditto.
`directory`	The directory that will be used to persist Ditto data.


                    
                    
                    -initWithIdentity:historyTrackingEnabled:persistenceDirectory:

Initializes a new DITDitto.

Warning

History Tracking is experimental and shouldn’t be used in production.

Declaration

Objective-C

- (nonnull instancetype)initWithIdentity:(nonnull DITIdentity *)identity
                  historyTrackingEnabled:(BOOL)historyTrackingEnabled
                    persistenceDirectory:(nullable NSURL *)directory;

Parameters

`identity`	Provide the identity of the entity that is interacting with Ditto.
`historyTrackingEnabled`	Whether or not you want history tracking enabled.
`directory`	The directory that will be used to persist Ditto data.


                    
                    
                    -startSync:

Starts the network transports. Ditto will connect to other devices and sync with them where appropriate.

By default Ditto will enable all peer-to-peer transport types. On iOS this means Bluetooth, WiFi and AWDL. The network configuration can be customized using the setTransportConfig method.

You must have activated Ditto with a successful call to setLicenseToken before starting sync.

Declaration

Objective-C

- (BOOL)startSync:(NSError *_Nullable *_Nullable)error;

Parameters


                                error

On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Return Value

YES if sync was successfully started. NO otherwise.


                    
                    
                    -stopSync

Stops all network transports.

You may continue to use the database locally but no data will sync to or from other devices.

Declaration

Objective-C

- (void)stopSync;


                    
                    
                    -updateTransportConfig:

Convenience method to update the current transport config of the receiver.

Invokes the block with a mutable copy of the current transport config which you can alter to your liking. The updated transport config is then set on the receiver.

You may use this method to alter the configuration at any time. Sync will not begin until startSync is invoked.

Declaration

Objective-C

- (void)updateTransportConfig:
    (nonnull void (^)(DITMutableTransportConfig *_Nonnull))block;


                    
                    
                    -setOfflineOnlyLicenseToken:error:

Activate an offline DITDitto instance by setting a license token. You cannot sync data across instances using an offline (Development, OfflinePlayground, Manual or SharedKey) DITDitto instance before you have activated it.

Declaration

Objective-C

- (BOOL)setOfflineOnlyLicenseToken:(nonnull NSString *)licenseToken
                             error:(NSError *_Nullable *_Nullable)error;

Parameters

`licenseToken`	The license token to activate the `DITDitto` instance with, which you can find on the Ditto portal (https://portal.ditto.live).
`error`	On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Return Value

YES if the license token was successfully set and the DITDitto instance is now activated for sync. NO otherwise.


                    
                    
                    -transportDiagnostics:

Request bulk status information about the transports.

This is mostly intended for statistical or debugging purposes.

Declaration

Objective-C

- (nullable DITTransportDiagnostics *)transportDiagnostics:
    (NSError *_Nullable *_Nullable)error;

Parameters


                                error

On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Return Value

An instance of DITTransportDiagnostics or nil if there was an error.


                    
                    
                    -observePeers:

Deprecated

Use [self.presence observe:] instead.

Request information about Ditto peers in range of this device.

This method returns an observer which should be held as long as updates are required. A newly registered observer will have a peers update delivered to it immediately. From then on it will be invoked repeatedly when Ditto devices come and go, or the active connections to them change.

@deprecated use [self.presence observe:] instead.

Declaration

Objective-C

- (nonnull id<DITObserver>)observePeers:
    (nonnull void (^)(NSArray<DITRemotePeer *> *_Nonnull))callback;


                    
                    
                    -observePeersV2:

Deprecated

Use [self.presence observe:] instead.

Request information about Ditto peers in range of this device.

This method returns an observer which should be held as long as updates are required. A newly registered observer will have a peers update delivered to it immediately. From then on it will be invoked repeatedly when Ditto devices come and go, or the active connections to them change.

@deprecated use [self.presence observe:] instead.

Declaration

Objective-C

- (nonnull id<DITObserver>)observePeersV2:
    (nonnull void (^)(NSString *_Nonnull))callback;


                    
                    
                    -sdkVersion

Returns a string identifying the version of the Ditto SDK.

Declaration

Objective-C

- (nonnull NSString *)sdkVersion;


                    
                    
                    +defaultDittoDirectory:

The default location of Ditto data files when no persistence directory is specified.

Declaration

Objective-C

+ (nonnull NSURL *)defaultDittoDirectory:(nonnull NSFileManager *)fileManager;


                    
                    
                    -runGarbageCollection

Removes all sync metadata for any remote peers which aren’t currently connected. This method shouldn’t usually be called. Manually running garbage collection often will result in slower sync times. Ditto automatically runs a garbage a collection process in the background at optimal times.

Manually running garbage collection is typically only useful during testing if large amounts of data are being generated. Alternatively, if an entire data set is to be evicted and it’s clear that maintaining this metadata isn’t necessary, then garbage collection could be run after evicting the old data.

Declaration

Objective-C

- (void)runGarbageCollection;


                    
                    
                    -disableSyncWithV2:

Explicitly opt-in to disabling the ability to sync with Ditto peers running any version of the SDK in the v2 series of releases.

Assuming this succeeds then this peer will only be able to sync with other peers using SDKs in the v3 series of releases. Note that this disabling of sync spreads to peers that sync with a peer that has disabled, or has (transitively) had disabled, syncing with v2 SDK peers.

Declaration

Objective-C

- (BOOL)disableSyncWithV2:(NSError *_Nullable *_Nullable)error;

Parameters


                                error

On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information. You may specify nil for this parameter if you do not want the error information.

Return Value

YES if the operation was successful. NO otherwise.