/Source/externals/GData/Source/Clients/Analytics/GDataServiceGoogleAnalytics.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//  GDataServiceGoogleAnalytics.h
18//
19
20#if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_ANALYTICS_SERVICE
21
22#import "GDataServiceGoogle.h"
23
24#undef _EXTERN
25#undef _INITIALIZE_AS
26#ifdef GDATASERVICEGOOGLEANALYTICS_DEFINE_GLOBALS
27#define _EXTERN
28#define _INITIALIZE_AS(x) =x
29#else
30#define _EXTERN GDATA_EXTERN
31#define _INITIALIZE_AS(x)
32#endif
33
34_EXTERN NSString* const kGDataGoogleAnalyticsDefaultAccountFeed _INITIALIZE_AS(@"https://www.google.com/analytics/feeds/accounts/default");
35
36@interface GDataServiceGoogleAnalytics : GDataServiceGoogle
37
38// clients may use these fetch methods of GDataServiceGoogle
39//
40// feed fetch calls must specify the expected object return class,
41// [GDataFeedAnalyticsAccount class] or [GDataFeedAnalyticsData class]
42//
43//  - (GDataServiceTicket *)fetchFeedWithURL:(NSURL *)feedURL feedClass:(Class)feedClass delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
44//  - (GDataServiceTicket *)fetchFeedWithQuery:(GDataQuery *)query feedClass:(Class)feedClass delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
45//
46// entry fetch calls must specify the expected object return class,
47// [GDataEntryAnalyticsAccount class] or [GDataEntryAnalyticsData class]
48//
49//  - (GDataServiceTicket *)fetchEntryWithURL:(NSURL *)entryURL entryClass:(Class)entryClass delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
50//
51// Additional calls:
52//
53//  - (GDataServiceTicket *)fetchEntryByInsertingEntry:(GDataEntryBase *)entryToInsert forFeedURL:(NSURL *)feedURL delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
54//  - (GDataServiceTicket *)fetchEntryByUpdatingEntry:(GDataEntryBase *)entryToUpdate delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
55//  - (GDataServiceTicket *)deleteEntry:(GDataEntryBase *)entryToDelete delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
56//  - (GDataServiceTicket *)deleteResourceURL:(NSURL *)resourceEditURL ETag:(NSString *)etag delegate:(id)delegate didFinishSelector:(SEL)finishedSelector;
57//
58// finishedSelector has a signature like this for feed fetches:
59// - (void)serviceTicket:(GDataServiceTicket *)ticket finishedWithFeed:(GDataFeedBase *)feed error:(NSError *)error;
60//
61// or this for entry fetches:
62// - (void)serviceTicket:(GDataServiceTicket *)ticket finishedWithEntry:(GDataEntryBase *)entry error:(NSError *)error;
63//
64// The class of the returned feed or entry is determined by the URL fetched.
65
66@end
67
68#endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_ANALYTICS_SERVICE