App Registration Keys

These constants are the keys in an app registration -- a dictionary that says what an app can do. More...

Defines
#define	kILAppIdentifier   @"ILAppIdentifier"
	String. A unique identifier for your app. Automatically taken from CFBundleIdentifier if not given.
#define	kILAppVisibleName   @"ILAppVisibleName"
	String. Localized, user-visible name for your app. Automatically taken from CFBundleDisplayName or CFBundleName or the bundle's name on the filesystem if not present.
#define	kILAppReceiveItemURLScheme   @"ILAppReceiveItemURLScheme"
	String. The URL scheme that can be used to send items to this application.
#define	kILAppSupportedActions   @"ILAppSupportedActions"
	Array of strings, 'actions'.
#define	kILAppSupportedReceivedItemsUTIs   @"ILAppSupportedReceivedItemsUTIs"
	Array of strings.
#define	kILAppSupportsReceivingMultipleItems   @"ILAppSupportsReceivingMultipleItems"
	Boolean (NSNumber). If YES, sending multiple items in the same request is meaningful. If NO (default), sending multiple items will only cause the first item to be received.
#define	kILAppSupportsReceivingMultipleTypes   @"ILAppSupportsReceivingMultipleTypes"
	Boolean (NSNumber). If YES, sending multiple items of multiple types in the same request is meaningful. If NO (default), sending multiple items will only cause the first item to be received. If an app sets this flag, it also must set kILAppSupportsReceivingMultipleItems to YES. (SwapKit 1.1 or later is required to send or receive requests with multiple items of multiple types.).
#define	kILAppRegistrationUUID   @"ILAppRegistrationUUID"
	String. Used to avoid registering multiple times. Will be ignored and overwritten by the internal registration machinery if given during registration, but will be returned by ILSwapRegistration::applicationRegistrations and related methods.
#define	kILAppVersion   @"ILAppVersion"
	Property list object. The bundle version (CFBundleVersion in Info.plist). Used to update the registration after an app update. Will be ignored and overwritten by the internal registration machinery if given during registration, but will be returned by ILSwapRegistration::applicationRegistrations and related methods.

---

Detailed Description

These constants are the keys in an app registration -- a dictionary that says what an app can do.

You can -- indeed, if you use SwapKit, you're expected to -- add a registration for your app, and you can query the services for all registrations on the system. These constants are used:

• in Info.plist, in a dictionary under the ILSwapRegistration key, if you're using didFinishLaunchingWithOptions: (ILSwapService) (much easier), or
• as an argument to ILSwapService::registerWithAttributes:, if you are using it, less commonly, or
• in the dictionaries returned by ILSwapService::applicationRegistrations and related methods (and in dictionaries passed to any ...Registration: argument).

Note that if a key is marked "optional" below, and it has a default value, then you can expect to find it in dictionaries returned by ILSwapService::applicationRegistrations and registrationForApplicationWithIdentifier: (ILSwapService) with the default value set. Keys marked as optional without a default may be missing from those dictionaries if unspecified.

---

Define Documentation

#define kILAppSupportedActions   @"ILAppSupportedActions"

Array of strings, 'actions'.

An action marks the intended use of the received data for the receiving application. For example, an application may receive text to be made into a message, or a mood message change, so it can define two actions for that. The default action is "ILReceive" (that is, "Do your thing, whatever it is").

The default for this key is '()' (the empty array) if you specify no types in the kILAppSupportedReceivedItemsUTIs key (or if that key is missing), or '(ILReceive)' (just the default action) otherwise.

PLEASE NOTE: If you specify custom actions AND you also want to receive stuff for the default action, you have to mention it explicitly. Example: '(ILReceive, new-tweet, new-direct-message)'. TODO: A better architecture to specify which actions apply to which types.

Definition at line 70 of file ILSwapService.h.

#define kILAppSupportedReceivedItemsUTIs   @"ILAppSupportedReceivedItemsUTIs"

Array of strings.

UTIs advertised as accepted for receiving. Default is '()' (ie. nothing).

Definition at line 75 of file ILSwapService.h.