DropKit/DropIO.h File Reference

#import <UIKit/UIKit.h>
#import "DropIODrop.h"
#import "DropIOAsset.h"

Include dependency graph for DropIO.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
class	NSString(httpFormEncoding)
	NSString category to encode a string so it can be used in an HTTP POST body. More...
class	NSMutableURLRequest(httpFormEncoding)
	NSMutableURLRequest category to provide a method to set the HTTP POST body from a dictionary of parameters. More...
class	DropIO
	DropIO class which provides static DropIODrop factory methods. More...
Defines
#define	kDropIOErrorDomain   @"DropIOErrorDomain"
	DropIOErrorDomain constants for creating custom NSErrors.
#define	kDropIOErrorAction   @"action"
	NSError.userInfo key constants.
#define	kDropIOErrorMessage   @"message"
#define	kDropIOErrorResult   @"result"
#define	kDropIOErrorAPIURL   @"APIURL"
#define	kDropIOErrorCode_RateLimitExceeded   -1
	NSError.code value constants.
#define	kDropIOErrorCode_NotDropURL   -2
#define	kDropIOErrorCode_TokenInvalid   -3
#define	kDropIOErrorCode_AssetCreationFailed   -4
#define	kDropIOErrorCode_AssetDeleted   -5
#define	kDropIOErrorCode_DropDeleted   -6
#define	kDropIOErrorCode_SendToSuccess   -7
#define	kDropIOErrorCode_Unknown   -1000
#define	kDropIOErrorResult_Success   @"Success"
	NSError.userInfo result string constants.
#define	kDropIOErrorMessage_TokenInvalid   @"The token is invalid."
	NSError.userInfo message string constants.
#define	kDropIOErrorMessage_RateLimitExceeded   @"IP limit exceeded."
#define	kDropIOErrorMessage_AssetCreationFailed   @"The asset could not be created."
#define	kDropIOErrorMessage_AssetDeleted   @"The asset was destroyed."
#define	kDropIOErrorMessage_DropDeleted   @"The drop was destroyed."
#define	kDropIOParamKey_Version   @"version"
	Drop.io API parameter key constants.
#define	kDropIOParamKey_Format   @"format"
#define	kDropIOParamKey_APIKey   @"api_key"
#define	kDropIOParamKey_Name   @"name"
#define	kDropIOParamKey_AdminPassword   @"admin_password"
#define	kDropIOParamKey_GuestPassword   @"password"
#define	kDropIOParamKey_Token   @"token"
#define	kDropIOParamKey_Page   @"page"
#define	kDropIOParamKey_Title   @"title"
#define	kDropIOParamKey_Contents   @"contents"
#define	kDropIOParamKey_Url   @"url"
#define	kDropIOParamKey_Description   @"description"
#define	kDropIOParamKey_DropName   @"drop_name"
#define	kDropIOParamKey_PremiumCode   @"premium_code"
#define	kDropIOParamKey_ExpirationLength   @"expiration_length"
#define	kDropIOParamKey_GuestsCanAdd   @"guests_can_add"
#define	kDropIOParamKey_GuestsCanDelete   @"guests_can_delete"
#define	kDropIOParamKey_GuestsCanComment   @"guests_can_comment"
#define	kDropIOParamKey_Type   @"type"
#define	kDropIOParamKey_Medium   @"medium"
#define	kDropIOParamKey_Emails   @"emails"
#define	kDropIOParamKey_Message   @"message"
#define	kDropIOParamKey_FaxNumber   @"fax_number"
#define	kDropIOParamKey_AssetAPIUrl   @"assetAPIUrl"
#define	kDropIOParamValue_Format_XML   @"xml"
	Drop.io API parameter value constants.
#define	kDropIOParamValue_Format_JSON   @"json"
#define	kDropIOParamValue_Version_10   @"1.0"
#define	kDropIOParamValue_Version_Latest   kDropIOParamValue_Version_10
#define	kDropIOParamValue_Medium_Email   @"email"
#define	kDropIOParamValue_Medium_Drop   @"drop"
#define	kDropIOParamValue_Medium_Fax   @"fax"
#define	kDropIONewDropUrl   @"http://api.drop.io/drops"
	Drop.io URL constants.
#define	kDropIOUpdateDropUrlFormat   @"http://api.drop.io/drops/%@"
#define	kDropIODropUrlFormat   @"http://api.drop.io/drops/%@?%@=%@&%@=%@&%@=%@&%@=%@"
#define	kDropIOAssetsUrlFormat   @"http://api.drop.io/drops/%@/assets?%@=%@&%@=%@&%@=%@&%@=%@&%@=%d"
#define	kDropIONewAssetUrlFormat   @"http://api.drop.io/drops/%@/assets"
#define	kDropIOUpdateAssetUrlFormat   @"http://api.drop.io/drops/%@/assets/%@"
#define	kDropIOAssetUrlFormat   @"http://api.drop.io/drops/%@/assets/%@?%@=%@&%@=%@&%@=%@&%@=%@"
#define	kDropIOSendAssetUrlFormat   @"http://api.drop.io/drops/%@/assets/%@/send_to"
#define	kDropIOFileUploadUrl   @"http://assets.drop.io/upload"
#define	kDropIODropWebUrlFormat   @"http://drop.io/%@"
#define	kDropIODropMobileUrlFormat   @"http://drop.io/%@/m"
#define	kDropIODropChatUrlFormat   @"http://drop.io/%@/chat?mobile=true"
#define	kDropIODropWebAuthUrlFormat   @"http://drop.io/%@/from_api"
#define	kAssetsPerPage   30
	Number of assets returned at a time from the drop.io API assets request.
#define	kDropMaxAssets   (10*kAssetsPerPage)
	Maximum number of drop assets we can hold in memory at once.

---

Define Documentation

#define kAssetsPerPage   30

Number of assets returned at a time from the drop.io API assets request.

Referenced by DropIODrop::addAsset:, DropIODrop::countAssetsInAssetPages:, and DropIODrop::lastAssetPageIndex.

#define kDropIOAssetsUrlFormat   @"http://api.drop.io/drops/%@/assets?%@=%@&%@=%@&%@=%@&%@=%@&%@=%d"

#define kDropIOAssetUrlFormat   @"http://api.drop.io/drops/%@/assets/%@?%@=%@&%@=%@&%@=%@&%@=%@"

#define kDropIODropChatUrlFormat   @"http://drop.io/%@/chat?mobile=true"

#define kDropIODropMobileUrlFormat   @"http://drop.io/%@/m"

#define kDropIODropUrlFormat   @"http://api.drop.io/drops/%@?%@=%@&%@=%@&%@=%@&%@=%@"

#define kDropIODropWebAuthUrlFormat   @"http://drop.io/%@/from_api"

#define kDropIODropWebUrlFormat   @"http://drop.io/%@"

#define kDropIOErrorAction   @"action"

NSError.userInfo key constants.

#define kDropIOErrorAPIURL   @"APIURL"

#define kDropIOErrorCode_AssetCreationFailed   -4

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorCode_AssetDeleted   -5

Referenced by DropIOAsset::delete, and XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorCode_DropDeleted   -6

Referenced by DropIODrop::delete, and XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorCode_NotDropURL   -2

#define kDropIOErrorCode_RateLimitExceeded   -1

NSError.code value constants.

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorCode_SendToSuccess   -7

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:, and DropIOAsset::sendWithParameters:.

#define kDropIOErrorCode_TokenInvalid   -3

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorCode_Unknown   -1000

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorDomain   @"DropIOErrorDomain"

DropIOErrorDomain constants for creating custom NSErrors.

Error Domain constant

#define kDropIOErrorMessage   @"message"

#define kDropIOErrorMessage_AssetCreationFailed   @"The asset could not be created."

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorMessage_AssetDeleted   @"The asset was destroyed."

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorMessage_DropDeleted   @"The drop was destroyed."

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorMessage_RateLimitExceeded   @"IP limit exceeded."

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorMessage_TokenInvalid   @"The token is invalid."

NSError.userInfo message string constants.

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOErrorResult   @"result"

#define kDropIOErrorResult_Success   @"Success"

NSError.userInfo result string constants.

Referenced by XMLToObjectParser::parseXMLData:fromNodeName:toObject:parseError:.

#define kDropIOFileUploadUrl   @"http://assets.drop.io/upload"

#define kDropIONewAssetUrlFormat   @"http://api.drop.io/drops/%@/assets"

#define kDropIONewDropUrl   @"http://api.drop.io/drops"

Drop.io URL constants.

#define kDropIOParamKey_AdminPassword   @"admin_password"

#define kDropIOParamKey_APIKey   @"api_key"

#define kDropIOParamKey_AssetAPIUrl   @"assetAPIUrl"

#define kDropIOParamKey_Contents   @"contents"

#define kDropIOParamKey_Description   @"description"

#define kDropIOParamKey_DropName   @"drop_name"

#define kDropIOParamKey_Emails   @"emails"

#define kDropIOParamKey_ExpirationLength   @"expiration_length"

#define kDropIOParamKey_FaxNumber   @"fax_number"

#define kDropIOParamKey_Format   @"format"

#define kDropIOParamKey_GuestPassword   @"password"

#define kDropIOParamKey_GuestsCanAdd   @"guests_can_add"

#define kDropIOParamKey_GuestsCanComment   @"guests_can_comment"

#define kDropIOParamKey_GuestsCanDelete   @"guests_can_delete"

#define kDropIOParamKey_Medium   @"medium"

#define kDropIOParamKey_Message   @"message"

#define kDropIOParamKey_Name   @"name"

#define kDropIOParamKey_Page   @"page"

#define kDropIOParamKey_PremiumCode   @"premium_code"

#define kDropIOParamKey_Title   @"title"

#define kDropIOParamKey_Token   @"token"

#define kDropIOParamKey_Type   @"type"

#define kDropIOParamKey_Url   @"url"

#define kDropIOParamKey_Version   @"version"

Drop.io API parameter key constants.

#define kDropIOParamValue_Format_JSON   @"json"

#define kDropIOParamValue_Format_XML   @"xml"

Drop.io API parameter value constants.

#define kDropIOParamValue_Medium_Drop   @"drop"

#define kDropIOParamValue_Medium_Email   @"email"

#define kDropIOParamValue_Medium_Fax   @"fax"

#define kDropIOParamValue_Version_10   @"1.0"

#define kDropIOParamValue_Version_Latest   kDropIOParamValue_Version_10

#define kDropIOSendAssetUrlFormat   @"http://api.drop.io/drops/%@/assets/%@/send_to"

#define kDropIOUpdateAssetUrlFormat   @"http://api.drop.io/drops/%@/assets/%@"

#define kDropIOUpdateDropUrlFormat   @"http://api.drop.io/drops/%@"

#define kDropMaxAssets   (10*kAssetsPerPage)

Maximum number of drop assets we can hold in memory at once.

Should be a multiple of kAssetsPerPage.

See also:

- canLoadAllAssets (DropIODrop)

Referenced by DropIODrop::canLoadAllAssets.