/core/externals/update-engine/externals/gdata-objectivec-client/Source/Clients/YouTube/GDataQueryYouTube.h

  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//
 17//  GDataQueryYouTube.h
 18//
 19
 20#if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_YOUTUBE_SERVICE
 21
 22#import "GDataQuery.h"
 23
 24#undef _EXTERN
 25#undef _INITIALIZE_AS
 26#ifdef GDATAQUERYYOUTUBE_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 kGDataYouTubeOrderByUpdated   _INITIALIZE_AS(@"updated");
 35_EXTERN NSString* const kGDataYouTubeOrderByViewCount _INITIALIZE_AS(@"viewCount");
 36_EXTERN NSString* const kGDataYouTubeOrderByRating    _INITIALIZE_AS(@"rating");
 37_EXTERN NSString* const kGDataYouTubeOrderByRelevance _INITIALIZE_AS(@"relevance");
 38
 39_EXTERN NSString* const kGDataYouTubePeriodToday     _INITIALIZE_AS(@"today");
 40_EXTERN NSString* const kGDataYouTubePeriodThisWeek  _INITIALIZE_AS(@"this_week");
 41_EXTERN NSString* const kGDataYouTubePeriodThisMonth _INITIALIZE_AS(@"this_month");
 42_EXTERN NSString* const kGDataYouTubePeriodAllTime   _INITIALIZE_AS(@"all_time");
 43
 44_EXTERN NSString* const kGDataYouTubeSafeSearchNone     _INITIALIZE_AS(@"none");
 45_EXTERN NSString* const kGDataYouTubeSafeSearchStrict   _INITIALIZE_AS(@"strict");
 46_EXTERN NSString* const kGDataYouTubeSafeSearchModerate _INITIALIZE_AS(@"moderate");
 47
 48_EXTERN NSString* const kGDataYouTubeCaptionTrackFormatSubviewer  _INITIALIZE_AS(@"sbv");
 49_EXTERN NSString* const kGDataYouTubeCaptionTrackFormatSubrip     _INITIALIZE_AS(@"srt");
 50
 51// http://code.google.com/apis/youtube/reference.html#Parameters
 52
 53@interface GDataQueryYouTube : GDataQuery 
 54  
 55+ (GDataQueryYouTube *)youTubeQueryWithFeedURL:(NSURL *)feedURL;
 56
 57- (void)setVideoQuery:(NSString *)str;
 58- (NSString *)videoQuery;
 59
 60- (void)setFormat:(NSString *)str;
 61- (NSString *)format;
 62
 63- (void)setCaptionTrackFormat:(NSString *)str;
 64- (NSString *)captionTrackFormat;
 65
 66- (void)setTimePeriod:(NSString *)str;
 67- (NSString *)timePeriod;
 68
 69// restriction is a country code or IP address
 70- (void)setRestriction:(NSString *)str;
 71- (NSString *)restriction;
 72
 73// language restriction is a ISO 639-1 2-letter language code
 74- (void)setLanguageRestriction:(NSString *)str;
 75- (NSString *)languageRestriction;
 76
 77// location as latitude,longitude
 78- (void)setLocation:(NSString *)str;
 79- (NSString *)location;
 80
 81// radius like "100km" with units "ft", "mi", "m", or "km"
 82- (void)setLocationRadius:(NSString *)str;
 83- (NSString *)locationRadius;
 84
 85- (void)setHasCaptions:(BOOL)flag;
 86- (BOOL)hasCaptions;
 87
 88- (void)setShouldRequire3D:(BOOL)flag;
 89- (BOOL)shouldRequire3D;
 90
 91// put video entries into link elements for activity feed entries
 92- (void)setShouldInline:(BOOL)flag;
 93- (BOOL)shouldInline;
 94
 95- (void)setUploader:(NSString *)str;
 96- (NSString *)uploader;
 97
 98// safeSearch replaces allowRacy
 99- (void)setSafeSearch:(NSString *)str;
100- (NSString *)safeSearch;
101
102@end
103
104#endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_YOUTUBE_SERVICE