FBGraphPlace.h 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. /*
  2. * Copyright 2010-present Facebook.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. #import "FBGraphLocation.h"
  18. #import "FBGraphObject.h"
  19. /*!
  20. @protocol
  21. @abstract
  22. The `FBGraphPlace` protocol enables typed access to a place object
  23. as represented in the Graph API.
  24. @discussion
  25. The `FBGraphPlace` protocol represents the most commonly used properties of a
  26. Facebook place object. It may be used to access an `NSDictionary` object that has
  27. been wrapped with an <FBGraphObject> facade.
  28. */
  29. @protocol FBGraphPlace<FBGraphObject>
  30. /*!
  31. @abstract use objectID instead
  32. @deprecated use objectID instead
  33. */
  34. @property (retain, nonatomic) NSString *id __attribute__ ((deprecated("use objectID instead")));
  35. /*!
  36. @property
  37. @abstract Typed access to the place ID.
  38. @discussion Note this typically refers to the "id" field of the graph object (i.e., equivalent
  39. to `[self objectForKey:@"id"]`) but is differently named to avoid conflicting with Apple's
  40. non-public selectors.
  41. */
  42. @property (retain, nonatomic) NSString *objectID;
  43. /*!
  44. @property
  45. @abstract Typed access to the place name.
  46. */
  47. @property (retain, nonatomic) NSString *name;
  48. /*!
  49. @property
  50. @abstract Typed access to the place category.
  51. */
  52. @property (retain, nonatomic) NSString *category;
  53. /*!
  54. @property
  55. @abstract Typed access to the place location.
  56. */
  57. @property (retain, nonatomic) id<FBGraphLocation> location;
  58. @end