/Source/externals/GData/Source/Clients/Photos/GDataPhotoElements.h

  1/* Copyright (c) 2007 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//  GDataPhotoElements.h
 18//
 19
 20#if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_PHOTOS_SERVICE
 21
 22#import "GDataObject.h"
 23#import "GDataValueConstruct.h"
 24
 25#undef _EXTERN
 26#undef _INITIALIZE_AS
 27#ifdef GDATAPHOTOELEMENTS_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// values for GDataPhotoAccess
 36_EXTERN NSString* const kGDataPhotoAccessPrivate _INITIALIZE_AS(@"private");
 37_EXTERN NSString* const kGDataPhotoAccessProtected _INITIALIZE_AS(@"protected"); // "sign-in required"
 38_EXTERN NSString* const kGDataPhotoAccessPublic _INITIALIZE_AS(@"public");
 39_EXTERN NSString* const kGDataPhotoAccessAll _INITIALIZE_AS(@"all");
 40
 41// values for GDataPhotoVideoStatus
 42_EXTERN NSString* const kGDataPhotoStatusPending _INITIALIZE_AS(@"pending");
 43_EXTERN NSString* const kGDataPhotoStatusReady   _INITIALIZE_AS(@"ready");
 44_EXTERN NSString* const kGDataPhotoStatusFinal   _INITIALIZE_AS(@"final");
 45_EXTERN NSString* const kGDataPhotoStatusFailed  _INITIALIZE_AS(@"failed");
 46
 47
 48// http://code.google.com/apis/picasaweb/reference.html#gphoto_reference
 49
 50// album id, like <gphoto:albumid>5024425138</gphoto:albumid>
 51@interface GDataPhotoAlbumID : GDataValueElementConstruct <GDataExtension>
 52@end
 53
 54// comment count, like <gphoto:commentCount>11</gphoto:commentCount>
 55@interface GDataPhotoCommentCount : GDataValueElementConstruct <GDataExtension>
 56@end
 57
 58// comment count, like <gphoto:commentingEnabled>true</gphoto:commentingEnabled>
 59@interface GDataPhotoCommentingEnabled : GDataValueElementConstruct <GDataExtension>
 60@end
 61
 62// photo ID, like <gphoto:id>512131187</gphoto:id>
 63@interface GDataPhotoGPhotoID : GDataValueElementConstruct <GDataExtension>
 64@end
 65
 66// max photos per album, like <gphoto:maxPhotosPerAlbum>1000</gphoto:maxPhotosPerAlbum>
 67@interface GDataPhotoMaxPhotosPerAlbum : GDataValueElementConstruct <GDataExtension>
 68@end
 69
 70// nickname, like <gphoto:nickname>Jane Smith</gphoto:nickname>
 71@interface GDataPhotoNickname : GDataValueElementConstruct <GDataExtension>
 72@end
 73
 74// current quota, like <gphoto:quotacurrent>312459331</gphoto:quotacurrent>
 75@interface GDataPhotoQuotaUsed : GDataValueElementConstruct <GDataExtension>
 76@end
 77
 78// max quota, like <gphoto:quotalimit>1385222385</gphoto:quotalimit>
 79@interface GDataPhotoQuotaLimit : GDataValueElementConstruct <GDataExtension>
 80@end
 81
 82// thumbnail URL, like <gphoto:thumbnail>http://picasaweb.google.com/image/.../Hello.jpg</gphoto:thumbnail>
 83@interface GDataPhotoThumbnail : GDataValueElementConstruct <GDataExtension>
 84@end
 85
 86// user, like <gphoto:user>Jane</gphoto:user>
 87@interface GDataPhotoUser : GDataValueElementConstruct <GDataExtension>
 88@end
 89
 90// access, like <gphoto:access>public</gphoto:access>
 91@interface GDataPhotoAccess : GDataValueElementConstruct <GDataExtension>
 92@end
 93
 94// current album bytes, like <gphoto:bytesUsed>11876307</gphoto:bytesUsed>
 95@interface GDataPhotoBytesUsed : GDataValueElementConstruct <GDataExtension>
 96@end
 97
 98// location, like <gphoto:location>Tokyo, Japan</gphoto:location>
 99@interface GDataPhotoLocation : GDataValueElementConstruct <GDataExtension>
100@end
101
102// number of photos in an album, <gphoto:numphotos>237</gphoto:numphotos>
103@interface GDataPhotoNumberUsed : GDataValueElementConstruct <GDataExtension>
104@end
105
106// remaining photos which may be added to album,
107// <gphoto:numphotosremaining>763</gphoto:numphotosremaining>
108@interface GDataPhotoNumberLeft : GDataValueElementConstruct <GDataExtension>
109@end
110
111// checksum for optimistic concurrency, <gphoto:checksum>987123</gphoto:checksum>
112@interface GDataPhotoChecksum : GDataValueElementConstruct <GDataExtension>
113@end
114
115// photo height in pixels, like <gphoto:height>1200</gphoto:height>
116@interface GDataPhotoHeight : GDataValueElementConstruct <GDataExtension>
117@end
118
119// unapplied rotation in int degrees, <gphoto:rotation>90</gphoto:rotation>  
120@interface GDataPhotoRotation : GDataValueElementConstruct <GDataExtension>
121@end
122
123// photo size in bytes <gphoto:size>149351</gphoto:size> 
124@interface GDataPhotoSize : GDataValueElementConstruct <GDataExtension>
125@end
126
127// photo timestamp, in milliseconds since 1-January-1970, 
128// like <gphoto:timestamp>1168640584000</gphoto:timestamp>  
129@interface GDataPhotoTimestamp : GDataValueElementConstruct <GDataExtension>
130+ (GDataPhotoTimestamp *)timestampWithDate:(NSDate *)date;
131- (NSDate *)dateValue;
132- (void)setDateValue:(NSDate *)date;
133@end
134
135// photo width in pixels, <gphoto:width>1600</gphoto:width>
136@interface GDataPhotoWidth : GDataValueElementConstruct <GDataExtension>
137@end
138
139// video upload status, like <gphoto:videostatus>pending</gphoto:videostatus>
140//
141// see constants listed above
142@interface GDataPhotoVideoStatus : GDataValueElementConstruct <GDataExtension>
143@end
144
145// photo ID for the current comment, <gphoto:photoid>301521187</gphoto:photoid>
146@interface GDataPhotoPhotoID : GDataValueElementConstruct <GDataExtension>
147@end
148
149// number of appearances of the current tag, <gphoto:weight>3</gphoto:weight>
150@interface GDataPhotoWeight : GDataValueElementConstruct <GDataExtension>
151@end
152
153//
154// elements introduced in V2
155//
156
157// description of containing album, like
158// <gphoto:albumdesc>My picture collection</gphoto:albumdesc>
159@interface GDataPhotoAlbumDesc : GDataValueElementConstruct <GDataExtension>
160@end
161
162// title of containing, like
163// <gphoto:albumtitle>My album</gphoto:albumtitle>
164@interface GDataPhotoAlbumTitle : GDataValueElementConstruct <GDataExtension>
165@end
166
167// snippet matching search text, like
168// <gphoto:snippet>...happy birthday...</gphoto:snippet>
169@interface GDataPhotoSnippet : GDataValueElementConstruct <GDataExtension>
170@end
171
172// type of snippet from search text, like
173// <gphoto:snippettype>PHOTO_DESCRIPTION<gphoto:snippettype>
174@interface GDataPhotoSnippetType : GDataValueElementConstruct <GDataExtension>
175@end
176
177// truncation flag for serach results, like
178// <gphoto:truncated>1<gphoto:truncated>
179@interface GDataPhotoTruncated : GDataValueElementConstruct <GDataExtension>
180@end
181
182#endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_PHOTOS_SERVICE