1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
|
using System;
namespace FlickrNet
{
/// <summary>
/// Summary description for PhotoSearchOptions.
/// </summary>
[Serializable]
public class PhotoSearchOptions
{
private string _userId;
private string _tags;
private TagMode _tagMode = TagMode.None;
private string _machineTags;
private MachineTagMode _machineTagMode = MachineTagMode.None;
private string _text;
private DateTime _minUploadDate = DateTime.MinValue;
private DateTime _maxUploadDate = DateTime.MinValue;
private DateTime _minTakenDate = DateTime.MinValue;
private DateTime _maxTakenDate = DateTime.MinValue;
private System.Collections.ArrayList _licenses = new System.Collections.ArrayList();
private PhotoSearchExtras _extras = PhotoSearchExtras.None;
private int _perPage = 0;
private int _page = 0;
private PhotoSearchSortOrder _sort = PhotoSearchSortOrder.None;
private PrivacyFilter _privacyFilter = PrivacyFilter.None;
private BoundaryBox _boundaryBox = new BoundaryBox();
private string _groupId;
/// <summary>
/// Creates a new instance of the search options.
/// </summary>
public PhotoSearchOptions()
{
}
/// <summary>
/// Creates a new instance of the search options, setting the UserId property to the parameter
/// passed in.
/// </summary>
/// <param name="userId">The ID of the User to search for.</param>
public PhotoSearchOptions(string userId) : this(userId, null, TagMode.AllTags, null)
{
}
/// <summary>
/// Create an instance of the <see cref="PhotoSearchOptions"/> for a given user ID and tag list.
/// </summary>
/// <param name="userId">The ID of the User to search for.</param>
/// <param name="tags">The tags (comma delimited) to search for. Will match all tags.</param>
public PhotoSearchOptions(string userId, string tags) : this( userId, tags, TagMode.AllTags, null)
{
}
/// <summary>
/// Create an instance of the <see cref="PhotoSearchOptions"/> for a given user ID and tag list,
/// with the selected tag mode.
/// </summary>
/// <param name="userId">The ID of the User to search for.</param>
/// <param name="tags">The tags (comma delimited) to search for.</param>
/// <param name="tagMode">The <see cref="TagMode"/> to use to search.</param>
public PhotoSearchOptions(string userId, string tags, TagMode tagMode) : this( userId, tags, tagMode, null)
{
}
/// <summary>
/// Create an instance of the <see cref="PhotoSearchOptions"/> for a given user ID and tag list,
/// with the selected tag mode, and containing the selected text.
/// </summary>
/// <param name="userId">The ID of the User to search for.</param>
/// <param name="tags">The tags (comma delimited) to search for.</param>
/// <param name="tagMode">The <see cref="TagMode"/> to use to search.</param>
/// <param name="text">The text to search for in photo title and descriptions.</param>
public PhotoSearchOptions(string userId, string tags, TagMode tagMode, string text)
{
this.UserId = userId;
this.Tags = tags;
this.TagMode = tagMode;
this.Text = text;
}
/// <summary>
/// The user Id of the user to search on. Defaults to null for no specific user.
/// </summary>
public string UserId
{
get { return _userId; }
set { _userId = value; }
}
/// <summary>
/// The group id of the group to search within.
/// </summary>
public string GroupId
{
get { return _groupId; }
set { _groupId = value; }
}
/// <summary>
/// A comma delimited list of tags
/// </summary>
public string Tags
{
get { return _tags; }
set { _tags = value; }
}
/// <summary>
/// Tag mode can either be 'all', or 'any'. Defaults to <see cref="FlickrNet.TagMode.AllTags"/>
/// </summary>
public TagMode TagMode
{
get { return _tagMode; }
set { _tagMode = value; }
}
internal string TagModeString
{
get
{
switch(_tagMode)
{
case TagMode.None:
return "";
case TagMode.AllTags:
return "all";
case TagMode.AnyTag:
return "any";
case TagMode.Boolean:
return "bool";
default:
return "";
}
}
}
/// <summary>
/// Search for the given machine tags.
/// </summary>
/// <remarks>
/// See http://www.flickr.com/services/api/flickr.photos.search.html for details
/// on how to search for machine tags.
/// </remarks>
public string MachineTags
{
get { return _machineTags; } set { _machineTags = value; }
}
/// <summary>
/// The machine tag mode.
/// </summary>
/// <remarks>
/// Allowed values are any and all. It defaults to any if none specified.
/// </remarks>
public MachineTagMode MachineTagMode
{
get { return _machineTagMode; } set { _machineTagMode = value; }
}
internal string MachineTagModeString
{
get
{
switch(_machineTagMode)
{
case MachineTagMode.None:
return "";
case MachineTagMode.AllTags:
return "all";
case MachineTagMode.AnyTag:
return "any";
default:
return "";
}
}
}
/// <summary>
/// Search for the given text in photo titles and descriptions.
/// </summary>
public string Text
{
get { return _text; }
set { _text = value; }
}
/// <summary>
/// Minimum date uploaded. Defaults to <see cref="DateTime.MinValue"/> which
/// signifies that the value is not to be used.
/// </summary>
public DateTime MinUploadDate
{
get { return _minUploadDate; }
set { _minUploadDate = value; }
}
/// <summary>
/// Maximum date uploaded. Defaults to <see cref="DateTime.MinValue"/> which
/// signifies that the value is not to be used.
/// </summary>
public DateTime MaxUploadDate
{
get { return _maxUploadDate; }
set { _maxUploadDate = value; }
}
/// <summary>
/// Minimum date taken. Defaults to <see cref="DateTime.MinValue"/> which
/// signifies that the value is not to be used.
/// </summary>
public DateTime MinTakenDate
{
get { return _minTakenDate; }
set { _minTakenDate = value; }
}
/// <summary>
/// Maximum date taken. Defaults to <see cref="DateTime.MinValue"/> which
/// signifies that the value is not to be used.
/// </summary>
public DateTime MaxTakenDate
{
get { return _maxTakenDate; }
set { _maxTakenDate = value; }
}
/// <summary>
/// Only return licenses with the selected license number.
/// See http://www.flickr.com/services/api/flickr.photos.licenses.getInfo.html
/// for more details on the numbers to use.
/// </summary>
[Obsolete("Use AddLicense/RemoveLicense to add/remove licenses")]
public int License
{
get
{
if( _licenses.Count == 0 )
return 0;
else
return (int)_licenses[0];
}
set
{
if( _licenses.Count == 0 )
_licenses.Add(value);
else
_licenses[0] = value;
}
}
/// <summary>
/// Returns a copy of the licenses to be searched for.
/// </summary>
public int[] Licenses
{
get
{
return (int[])_licenses.ToArray(typeof(int));
}
}
/// <summary>
/// Adds a new license to the list of licenses to be searched for.
/// </summary>
/// <param name="license">The number of the license to search for.</param>
public void AddLicense(int license)
{
if( !_licenses.Contains(license) ) _licenses.Add(license);
}
/// <summary>
/// Removes a license from the list of licenses to be searched for.
/// </summary>
/// <param name="license">The number of the license to remove.</param>
public void RemoveLicense(int license)
{
if( _licenses.Contains(license) ) _licenses.Remove(license);
}
/// <summary>
/// Optional extras to return, defaults to all. See <see cref="PhotoSearchExtras"/> for more details.
/// </summary>
public PhotoSearchExtras Extras
{
get { return _extras; }
set { _extras = value; }
}
/// <summary>
/// Number of photos to return per page. Defaults to 100.
/// </summary>
public int PerPage
{
get { return _perPage; }
set { _perPage = value; }
}
/// <summary>
/// The page to return. Defaults to page 1.
/// </summary>
public int Page
{
get { return _page; }
set
{
if( value < 0 ) throw new ArgumentOutOfRangeException("Page", "Must be greater than 0");
_page = value;
}
}
/// <summary>
/// The sort order of the returned list. Default is <see cref="PhotoSearchSortOrder.None"/>.
/// </summary>
public PhotoSearchSortOrder SortOrder
{
get { return _sort; }
set { _sort = value; }
}
/// <summary>
/// The privacy fitler to filter the search on.
/// </summary>
public PrivacyFilter PrivacyFilter
{
get { return _privacyFilter; }
set { _privacyFilter = value; }
}
/// <summary>
/// The boundary box for which to search for geo location photos.
/// </summary>
public BoundaryBox BoundaryBox
{
get { return _boundaryBox; }
set
{
if( value == null )
_boundaryBox = new BoundaryBox();
else
_boundaryBox = value;
}
}
/// <summary>
/// The accuracy of the search for geo location photos.
/// </summary>
/// <remarks>
/// Can also be set as a property of the <see cref="BoundaryBox"/> property.
/// </remarks>
public GeoAccuracy Accuracy
{
get { return _boundaryBox==null?GeoAccuracy.None:_boundaryBox.Accuracy; }
set
{
if (_boundaryBox==null) { _boundaryBox = new BoundaryBox(); }
_boundaryBox.Accuracy = value;
}
}
internal string ExtrasString
{
get { return Utils.ExtrasToString(Extras); }
}
internal string SortOrderString
{
get { return Utils.SortOrderToString(_sort); }
}
}
}
|