/externals/gdata-objectivec-client/Source/Clients/Books/GDataServiceGoogleBooks.h

http://update-engine.googlecode.com/ · C++ Header · 77 lines · 20 code · 15 blank · 42 comment · 1 complexity · 41eb34efe92c4c7c0990d49b8fee3d60 MD5 · raw file

  1. /* Copyright (c) 2008 Google Inc.
  2. *
  3. * Licensed under the Apache License, Version 2.0 (the "License");
  4. * you may not use this file except in compliance with the License.
  5. * You may obtain a copy of the License at
  6. *
  7. * http://www.apache.org/licenses/LICENSE-2.0
  8. *
  9. * Unless required by applicable law or agreed to in writing, software
  10. * distributed under the License is distributed on an "AS IS" BASIS,
  11. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. * See the License for the specific language governing permissions and
  13. * limitations under the License.
  14. */
  15. //
  16. // GDataServiceGoogleBooks.h
  17. //
  18. #if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_BOOKS_SERVICE
  19. #import "GDataServiceGoogle.h"
  20. #undef _EXTERN
  21. #undef _INITIALIZE_AS
  22. #ifdef GDATASERVICEGOOGLEBOOKS_DEFINE_GLOBALS
  23. #define _EXTERN
  24. #define _INITIALIZE_AS(x) =x
  25. #else
  26. #define _EXTERN GDATA_EXTERN
  27. #define _INITIALIZE_AS(x)
  28. #endif
  29. // feed for querying all volumes
  30. _EXTERN NSString* const kGDataGoogleBooksVolumeFeed _INITIALIZE_AS(@"http://books.google.com/books/feeds/volumes");
  31. _EXTERN NSString* const kGDataGoogleBooksLibraryCollection _INITIALIZE_AS(@"library");
  32. @interface GDataServiceGoogleBooks : GDataServiceGoogle
  33. // feeds for the authenticated user's annotations and collections
  34. // pass nil as volume ID for the URL to the volumes feed
  35. // (previously kGDataGoogleBooksDefaultVolumeFeed)
  36. + (NSURL *)booksURLForVolumeID:(NSString *)volumeID;
  37. // pass kGDataGoogleBooksLibraryCollection for the default library's volumes
  38. // (previously kGDataGoogleBooksDefaultCollectionFeed)
  39. + (NSURL *)booksURLForCollectionID:(NSString *)collectionID;
  40. // URL for the feed of the user's collections
  41. + (NSURL *)collectionsURL;
  42. // clients may use these fetch methods of GDataServiceGoogle
  43. //
  44. // - (GDataServiceTicket *)fetchFeedWithURL:(NSURL *)feedURL delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
  45. // - (GDataServiceTicket *)fetchFeedWithQuery:(GDataQuery *)query delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
  46. // - (GDataServiceTicket *)fetchEntryWithURL:(NSURL *)entryURL delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
  47. // - (GDataServiceTicket *)fetchEntryByInsertingEntry:(GDataEntryBase *)entryToInsert forFeedURL:(NSURL *)feedURL delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
  48. // - (GDataServiceTicket *)fetchEntryByUpdatingEntry:(GDataEntryBase *)entryToUpdate delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
  49. // - (GDataServiceTicket *)deleteEntry:(GDataEntryBase *)entryToDelete delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
  50. // - (GDataServiceTicket *)deleteResourceURL:(NSURL *)resourceEditURL ETag:(NSString *)etag delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
  51. // - (GDataServiceTicket *)fetchFeedWithBatchFeed:(GDataFeedBase *)batchFeed forBatchFeedURL:(NSURL *)feedURL delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
  52. //
  53. // finishedSelector has a signature like this for feed fetches:
  54. // - (void)serviceTicket:(GDataServiceTicket *)ticket finishedWithFeed:(GDataFeedBase *)feed error:(NSError *)error;
  55. //
  56. // or this for entry fetches:
  57. // - (void)serviceTicket:(GDataServiceTicket *)ticket finishedWithEntry:(GDataEntryBase *)entry error:(NSError *)error;
  58. //
  59. // The class of the returned feed or entry is determined by the URL fetched.
  60. + (NSString *)serviceRootURLString;
  61. @end
  62. #endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_BOOKS_SERVICE