Documentation

Constants

All the public Constants, Enums and Unions in CoreObject

Constants

Default

NSString* const kCOBranchLabel

The key that corresponds to the branch name in -[COBranch metadatata] .

See also -[COBranch name] .

NSString* const kCOLibraryIdentifierBookmark

A unique identifier to mark the library listing the bookmarks in the store. See also -[COEditingContext bookmarkLibrary] .

NSString* const kCOLibraryIdentifierMusic

A unique identifier to mark the library listing the music tracks in the store.

See also -[COEditingContext musicLibrary] .

NSString* const kCOLibraryIdentifierNote

A unique identifier to mark the library listing the notes in the store. See also -[COEditingContext noteLibrary] .

NSString* const kCOLibraryIdentifierPhoto

A unique identifier to mark the library listing the pictures in the store.

See also -[COEditingContext photoLibrary] .

NSString* const kCOLibraryIdentifierTag

A unique identifier to mark the library listing the tags in the store.

See also -[COEditingContext tagLibrary] .

NSString* const COEditingContextDidChangeNotification

Posted when any changes are committed to this editing context root, including changes committed in another process.

The userInfo dictionary contains the command produced by the commit, under the key kCOCommandKey. For a commit was produced by an undo/redo action (see COUndoTrack) or changes committed in another processes, the dictionary doesn't contain the command.

The kCOCommandKey object is provided just for debugging purpose (e.g. to log each commit done locally, while not reporting concurrent commits from other processes that trigger an automatic reloading).

The sender is the affected COEditingContext object.

NSString* const kCOCommandKey

See userInfo explanation in COEditingContextDidChangeNotification.

NSString* const COInsertedObjectsKey

User info dictionary key for COObjectGraphContextObjectsDidChangeNotification.

The value is an NSSet of ETUUID objects.

NSString* const COObjectGraphContextBeginBatchChangeNotification
Description forthcoming.
NSString* const COObjectGraphContextEndBatchChangeNotification
Description forthcoming.
NSString* const COObjectGraphContextObjectsDidChangeNotification

Posted during -[COObjectGraphContext acceptAllChanges] .

This notifcation will tell you about all possible mutations that can happen to a COObjectGraphContext over its lifetime (inserting objects, updating objects, reverting changes**, reloading a new state).

The userInfo dictionary contains the following keys:

COInsertedObjectsKey
the inserted object UUIDs
COUpdatedObjectsKey
the updated object UUIDs

** It's not totally clear if this should cause a notification to be sent or not, since the graph is reverted to the state it was in when the last COObjectGraphContextObjectsDidChangeNotification was set. See -[TestObjectGraphContext testNotificationAfterDiscardForPersistentContext]

TODO: Rename to DidAcceptChangesNotification

See also COObjectGraphContextWillRelinquishObjectsNotification.

NSString* const COObjectGraphContextWillRelinquishObjectsNotification

Posted when a garbage collection phase is run by COObjectGraphContext.

This notification will tell you about the objects to be relinquished by the object graph context, under the key CORelinquishedObjectsKey.

You must use it to discard all non-persistent references hold on these objects, just before these references become invalid. For example, UI controllers must usually observe this notification.

Object graph context changes reported by COObjectGraphContextDidChangeNotification can result in objects to be relinquished, on the next garbage collection phase.

NSString* const CORelinquishedObjectsKey

User info dictionary key for COObjectGraphContextWillRelinquishObjectsNotification.

The value is a NSArray of COObjects.

The relinquished objects are objects to be released by the object graph context, during a garbage collection phase, because they are not referenced in a persistent relationship for the current state.

NSString* const COUpdatedObjectsKey

User info dictionary key for COObjectGraphContextObjectsDidChangeNotification.

The value is an NSSet of ETUUID objects.

NSString* const COPersistentRootDidChangeNotification

Posted when any changes are committed to this persistent root, including changes committed in another process.

The userInfo dictionary is nil. The sender is the affected COPersistentRoot object.

NSString* kCOCoreObjectErrorDomain

The error domain to identity errors emitted by CoreObject itself, and not some other layers such as Foundation or POSIX.

NSInteger kCOValidationError
NSInteger kCOValidationMultipleErrorsError
NSString* const COUndoTrackDidChangeNotification

Posted when a new undo track command is recorded, or the current command is changed.

This notification will tell you about COUndoTrack changes exposed through the COTrack protocol:

basic undo/redo or a move to a past or future state along the track
-[COTrack currentNode] has changed
new commit, including selective undo
a new node has been recorded in -[COTrack nodes]

It is not posted when the track is reloaded.

The user info dictionary contains the key: kCOundoTrackName. Note: tracks are append-only, so node removal is not supported.

NSString* const kCOUndoTrackName

Key in the userInfo dictionary for COUndoTrackDidChangeNotification.

The value is an NSString containing the track name of the track that changed.

NSString* kCOCommitMetadataIdentifier

The key used to identify -[COCommitDescriptor identifier] among the commit metadata.

NSString* kCOCommitMetadataShortDescription

The key used to identify -[COCommitDescriptor shortDescription] among the commit metadata.

NSString* kCOCommitMetadataShortDescriptionArguments

The optional key used to identify -[COCommitDescriptor shortDescriptionArguments] among the commit metadata.

The value must be a string array that can used to interpolate the format string of -[COCommitDescriptor shortDescription] and -[COCommitDescriptor localizedShortDescription] .

NSString* kCOCommitMetadataTypeDescription

The key used to identify -[COCommitDescriptor typeDescription] among the commit metadata.

NSString* kCOObjectEntityNameProperty

Description forthcoming.
NSString* kCOObjectIsSharedProperty
Description forthcoming.