Make the provider functional

1 files changed, 48 insertions, 0 deletions

diff --git a/QSBookmarkProvider.h b/QSBookmarkProvider.h
new file mode 100644
index 0000000..735ae82
--- /dev/null
+++ b/QSBookmarkProvider.h
@@ -0,0 +1,48 @@
+//
+//  QSBookmarkProvider.h
+//  QSDeliciousPlugIn
+//
+//  Protocol for social bookmark providers
+//
+
+#import <Foundation/Foundation.h>
+#import "SocialSite.h"
+
+@class QSObject;
+
+@protocol QSBookmarkProvider <NSObject>
+
+@required
+/**
+ * Check if this provider can handle the given site configuration
+ */
+- (BOOL)canHandleSite:(SocialSite)site username:(NSString *)username password:(NSString *)password host:(NSString *)host;
+
+/**
+ * Fetch bookmarks for the given configuration
+ * Returns an NSArray of QSObject instances
+ */
+- (NSArray *)fetchBookmarksForSite:(SocialSite)site username:(NSString *)username password:(NSString *)password host:(NSString *)host includeTags:(BOOL)includeTags;
+
+/**
+ * Get the supported site for this provider
+ */
+- (SocialSite)supportedSite;
+
+/**
+ * Get display name for this provider
+ */
+- (NSString *)providerName;
+
+@optional
+/**
+ * Get bookmarks for a specific tag (used for child loading)
+ */
+- (NSArray *)fetchBookmarksForTag:(NSString *)tag site:(SocialSite)site username:(NSString *)username password:(NSString *)password host:(NSString *)host;
+
+/**
+ * Get the tag URL type identifier for this provider
+ */
+- (NSString *)tagURLType;
+
+@end
\ No newline at end of file