/Source/externals/GData/Source/Clients/Maps/GDataServiceGoogleMaps.h

 1/* Copyright (c) 2009 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//
17//  GDataServiceGoogleMaps.h
18//
19
20
21#if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_MAPS_SERVICE
22
23#import "GDataServiceGoogle.h"
24
25#undef _EXTERN
26#undef _INITIALIZE_AS
27#ifdef GDATASERVICEGOOGLEMAPS_DEFINE_GLOBALS
28#define _EXTERN
29#define _INITIALIZE_AS(x) =x
30#else
31#define _EXTERN GDATA_EXTERN
32#define _INITIALIZE_AS(x)
33#endif
34
35// projections
36_EXTERN NSString* const kGDataMapsProjectionFull       _INITIALIZE_AS(@"full");
37_EXTERN NSString* const kGDataMapsProjectionBookmarked _INITIALIZE_AS(@"bookmarked");
38_EXTERN NSString* const kGDataMapsProjectionOwned      _INITIALIZE_AS(@"owned");
39_EXTERN NSString* const kGDataMapsProjectionPublic     _INITIALIZE_AS(@"public");
40_EXTERN NSString* const kGDataMapsProjectionUnlisted   _INITIALIZE_AS(@"unlisted");
41
42
43@interface GDataServiceGoogleMaps : GDataServiceGoogle
44
45// Utility for making feed URLs.
46//
47// For the authenticated user, pass kGDataServiceDefaultUser
48//
49// Projections are listed above
50+ (NSURL *)mapsFeedURLForUserID:(NSString *)userID
51                     projection:(NSString *)projection;
52
53// clients may use these fetch methods of GDataServiceGoogle
54//
55//  - (GDataServiceTicket *)fetchFeedWithURL:(NSURL *)feedURL delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
56//  - (GDataServiceTicket *)fetchFeedWithQuery:(GDataQuery *)query delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
57//  - (GDataServiceTicket *)fetchEntryWithURL:(NSURL *)entryURL delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
58//  - (GDataServiceTicket *)fetchEntryByInsertingEntry:(GDataEntryBase *)entryToInsert forFeedURL:(NSURL *)feedURL delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
59//  - (GDataServiceTicket *)fetchEntryByUpdatingEntry:(GDataEntryBase *)entryToUpdate delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
60//  - (GDataServiceTicket *)deleteEntry:(GDataEntryBase *)entryToDelete delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
61//  - (GDataServiceTicket *)deleteResourceURL:(NSURL *)resourceEditURL ETag:(NSString *)etag delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
62//  - (GDataServiceTicket *)fetchFeedWithBatchFeed:(GDataFeedBase *)batchFeed forBatchFeedURL:(NSURL *)feedURL delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
63//
64// finishedSelector has a signature like this for feed fetches:
65// - (void)serviceTicket:(GDataServiceTicket *)ticket finishedWithFeed:(GDataFeedBase *)feed error:(NSError *)error;
66//
67// or this for entry fetches:
68// - (void)serviceTicket:(GDataServiceTicket *)ticket finishedWithEntry:(GDataEntryBase *)entry error:(NSError *)error;
69//
70// The class of the returned feed or entry is determined by the URL fetched.
71
72+ (NSString *)serviceRootURLString;
73
74@end
75
76#endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_MAPS_SERVICE