DropKit/DropIODrop.h

Go to the documentation of this file.

//
//  DropIODrop.h
//  DropIO
//
//  Created by Chris Patterson on 11/10/08.
//  Copyright 2008 Chris Patterson. All rights reserved.
//

#import <UIKit/UIKit.h>

@class DropIOAsset;
@class DropIONote;
@class DropIOLink;
@class DropIODocument;
@class DropIOImage;

typedef enum {
    AssetSortOrder_Date = 0,    // Sort assets by date descending (like "blog" view)
    AssetSortOrder_Type = 1,    // Sort assets by type name ascending (like "media" view)
    AssetSortOrder_Title = 2,   // Sort assets by asset name ascending
    AssetSortOrder_API = 3      // Don't sort assets -- list them in the order they come from the API.
} AssetSortOrder;

typedef enum {
    kDropFeedFormat_RSS = 0,
    kDropFeedFormat_Dropcast
} DropFeedFormat;

@interface DropIODrop : NSObject {

    NSString*       name;                   
    NSString*       password;               
    
    NSString*       adminPassword;          
    NSString*       guestPassword;          
    NSString*       adminToken;             
    NSString*       guestToken;             
    
    NSString*       email;                  
    NSString*       voicemail;              
    NSString*       conference;             
    
    NSString*       rss;                    
    NSString*       fax;                    
    NSString*       hiddenUploadUrl;        
    
    NSString*       expirationLength;       
    NSUInteger      currentBytes;           
    NSUInteger      maxBytes;               

    NSUInteger      assetCount;             

    BOOL            guestsCanAdd;           
    BOOL            guestsCanDelete;        
    BOOL            guestsCanComment;       
    
    NSString*       premiumCode;            
    
    NSMutableArray* assetPages;             
    
    NSString*       title;                  
    AssetSortOrder  sortOrder;              
    NSMutableArray* sortedAssets;           
    NSIndexSet*     sortedPageIndexes;      
    
    BOOL            loadingAssets;          
}

@property (nonatomic, retain) NSString*         name;
@property (nonatomic, retain) NSString*         password;

@property (nonatomic, retain) NSString*         adminPassword;
@property (nonatomic, retain) NSString*         guestPassword;
@property (nonatomic, retain) NSString*         adminToken;
@property (nonatomic, retain) NSString*         guestToken;

@property (nonatomic, retain) NSString*         email;
@property (nonatomic, retain) NSString*         voicemail;
@property (nonatomic, retain) NSString*         conference;

@property (nonatomic, retain) NSString*         rss;
@property (nonatomic, retain) NSString*         fax;
@property (nonatomic, retain) NSString*         hiddenUploadUrl;

@property (nonatomic, retain) NSString*         expirationLength;
@property (nonatomic)         NSUInteger        currentBytes;
@property (nonatomic)         NSUInteger        maxBytes;

@property (nonatomic)         NSUInteger        assetCount;

@property (nonatomic)         BOOL              guestsCanAdd;
@property (nonatomic)         BOOL              guestsCanDelete;
@property (nonatomic)         BOOL              guestsCanComment;

@property (nonatomic, retain) NSString*         premiumCode;

@property (retain)            NSMutableArray*   assetPages;

@property (nonatomic, retain) NSString*         title;
@property (nonatomic)         AssetSortOrder    sortOrder;
@property (nonatomic, retain) NSMutableArray*   sortedAssets;
@property (nonatomic, retain) NSIndexSet*       sortedPageIndexes;

@property                     BOOL              loadingAssets;

// Accessors returning above properties as NSURLs
- (NSURL*) emailURL;        // returns a "mailto:" URL.
- (NSURL*) voicemailURL;    // returns a "tel:" URL.
- (NSURL*) conferenceURL;   // returns a "tel:" URL.
- (NSURL*) rssURL;
- (NSURL*) faxURL;
- (NSURL*) hiddenUploadURL;

- (NSURL*) dropURL;
- (NSURL*) apiURL;
- (NSURL*) dropcastURL;     // returns an "itpc:" URL from the rss URL.
- (NSURL*) feedURLForFormat:(DropFeedFormat)format;
- (NSURL*) mobileURL;
- (NSURL*) chatURL;
- (NSURL*) webAuthURL;

// Asset URLs
- (NSURL*) URLForAssetsPage:(NSUInteger)assetsPage;
- (NSURL*) URLForAssetNamed:(NSString*)assetName;

// Getting NSIndexSets and asset page indexes
- (NSIndexSet*) indexSetForAllAssetPages;
- (NSUInteger) lastAssetPageIndex;

// Loading Assets
- (void) loadAssetPages:(NSIndexSet*)pageIndexes;
- (void) loadAssetPagesInBackground:(NSIndexSet*)pageIndexes;
- (void) loadAllAssets;
- (void) loadAllAssetsInBackground;

// Unloading Assets
- (void) unloadAssetPages:(NSIndexSet*)pageIndexes;
- (void) unloadAllAssets;

// Reloading Assets
- (void) reloadAssetPages:(NSIndexSet*)pageIndexes;
- (void) reloadAssetPagesInBackground:(NSIndexSet*)pageIndexes;
- (void) reloadAllAssets;
- (void) reloadAllAssetsInBackground;

// Checking for Loaded Assets
- (BOOL) areAssetPagesLoaded:(NSIndexSet*)pageIndexes;
- (BOOL) areAllAssetsLoaded;

// Sorting Assets
- (void) sortAssetPages:(NSIndexSet*)pageIndexes;
- (void) sortAllAssets;

// Counting Assets
- (NSUInteger) countAssetsInAssetPages:(NSIndexSet*)pageIndexes;
- (NSUInteger) countAllAssets;
- (NSUInteger) countAssetsOfType:(NSString*)assetType inAssetPages:(NSIndexSet*)pageIndexes;
- (NSUInteger) countAllAssetsOfType:(NSString*)assetType;

// Finding Assets
- (DropIOAsset*) findAssetNamed:(NSString*)assetName inAssetPages:(NSIndexSet*)pageIndexes loadIfMissing:(BOOL)loadFlag;
- (DropIOAsset*) findAssetNamed:(NSString*)assetName loadAllIfMissing:(BOOL)loadFlag;
- (DropIOAsset*) assetAtIndex:(NSUInteger)index inAssetPages:(NSIndexSet*)pageIndexes;

// Adding/Removing Assets
- (void) addAsset:(DropIOAsset*)asset;
- (void) removeAsset:(DropIOAsset*)asset;
- (void) removeAssetAtIndex:(NSUInteger)index inAssetPages:(NSIndexSet*)pageIndexes;

// Creating Assets
- (DropIOAsset*)    assetOperation:(NSString*)opString atUrl:(NSString*)urlStr withParameters:(NSDictionary*)params;
- (DropIOAsset*)    assetWithParameters:(NSDictionary*)propDict;
- (DropIONote*)     noteWithTitle:(NSString*)noteTitle contents:(NSString*)text;
- (DropIOLink*)     linkWithTitle:(NSString*)linkTitle url:(NSURL*)linkURL description:(NSString*)linkDesc;
- (DropIODocument*) docWithFilename:(NSString*)fileName data:(NSData*)docData mimeType:(NSString*)docMimeType;
- (DropIOImage*)    imageWithName:(NSString*)imgName data:(NSData*)imgData format:(NSString*)imgDataFormat;

// Calling the Drop
- (void) recordVoicemail;
- (void) conferenceCall;

// Return best available token; ie. admin then guest then (optionally) password. Returns a blank string if all are nil.
- (NSString*)bestTokenIncludingPassword:(BOOL)includePassword;

// Determine access privileges for button enablement
- (BOOL) canAdd;
- (BOOL) canEdit;
- (BOOL) canDelete;
- (BOOL) canComment;
- (BOOL) canLoadAllAssets;

// Update and Delete
- (void) update;
- (void) delete;

// Deprecated methods for drops whose assetCount < kDropMaxAssets
- (void) loadAssets;                                    // replaced by loadAllAssets
- (void) unloadAssets;                                  // replaced by unloadAllAssets
- (void) reloadAssets;                                  // replaced by reloadAllAssets
- (BOOL) areAssetsLoaded;                               // replaced by areAllAssetsLoaded
- (void) sortAssets;                                    // replaced by sortAllAssets
- (NSInteger) countAssetsOfType:(NSString*)assetType;   // replaced by countAllAssetsOfType:
- (DropIOAsset*) findAssetNamed:(NSString*)assetName loadIfMissing:(BOOL)loadFlag;
- (DropIOAsset*) assetAtIndex:(NSInteger)index;
- (void) removeAssetAtIndex:(NSInteger)index;


@end

---