/core/externals/update-engine/externals/gdata-objectivec-client/Source/Clients/Photos/GDataEntryPhoto.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//  GDataEntryPhoto.h
 18//
 19
 20#if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_PHOTOS_SERVICE
 21
 22#import "GDataEntryPhotoBase.h"
 23#import "GDataGeo.h"
 24#import "GDataMediaGroup.h"
 25#import "GDataEXIFTags.h"
 26
 27@interface GDataEntryPhoto : GDataEntryPhotoBase
 28
 29+ (GDataEntryPhoto *)photoEntry;
 30
 31// uploading photo data 
 32- (void)setPhotoData:(NSData *)data; // data will retained by the entry
 33- (NSData *)photoData;
 34
 35- (void)setPhotoMIMEType:(NSString *)str;
 36- (NSString *)photoMIMEType;
 37
 38// getters and setters
 39
 40// to move a photo to another album, set the photo entry's albumID
 41// to the album's GPhotoID and update the photo entry (with
 42// fetchPhotoEntryByUpdatingEntry:) 
 43- (NSString *)albumID;
 44- (void)setAlbumID:(NSString *)str;
 45
 46- (NSString *)checksum;
 47- (void)setChecksum:(NSString *)str;
 48
 49- (NSNumber *)commentCount; // int
 50- (void)setCommentCount:(NSNumber *)num;
 51
 52- (NSNumber *)commentsEnabled; // bool
 53- (void)setCommentsEnabled:(NSNumber *)num;
 54
 55- (NSNumber *)height; // long long
 56- (void)setHeight:(NSNumber *)num;
 57
 58- (NSNumber *)rotation; // int
 59- (void)setRotation:(NSNumber *)num;
 60
 61- (NSNumber *)size; // long long
 62- (void)setSize:(NSNumber *)num;
 63
 64- (GDataPhotoTimestamp *)timestamp; // use stringValue or date methods on timestamp
 65- (void)setTimestamp:(GDataPhotoTimestamp *)str;
 66
 67- (NSNumber *)width; // long long
 68- (void)setWidth:(NSNumber *)num;
 69
 70- (NSString *)videoStatus;
 71- (void)setVideoStatus:(NSString *)str;  
 72
 73// setGeoLocation requires an instance of a subclass of GDataGeo, not an
 74// instance of GDataGeo; see GDataGeo.h
 75- (GDataGeo *)geoLocation;
 76- (void)setGeoLocation:(GDataGeo *)geo;
 77
 78- (GDataMediaGroup *)mediaGroup;
 79- (void)setMediaGroup:(GDataMediaGroup *)obj;
 80
 81- (GDataEXIFTags *)EXIFTags;
 82- (void)setEXIFTags:(GDataEXIFTags *)tags;
 83
 84//
 85// search result elements introduced in V2
 86//
 87
 88- (NSString *)albumDescription;
 89- (void)setAlbumDescription:(NSString *)str;
 90
 91- (NSString *)albumTitle;
 92- (void)setAlbumTitle:(NSString *)str;
 93
 94- (NSString *)snippet;
 95- (void)setSnippet:(NSString *)str;
 96
 97// snippet type constants are in GDataPhotoConstants.h, like
 98// kGDataPhotoSnippetTypeAlbumTitle
 99- (NSString *)snippetType;
100- (void)setSnippetType:(NSString *)str;
101
102- (NSNumber *)truncated; // int, 0 or 1
103- (void)setTruncated:(NSNumber *)num;
104
105@end
106
107#endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_PHOTOS_SERVICE