FBSDKAppGroupContent.h 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. // Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
  2. //
  3. // You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
  4. // copy, modify, and distribute this software in source code or binary form for use
  5. // in connection with the web services and APIs provided by Facebook.
  6. //
  7. // As with any software that integrates with the Facebook platform, your use of
  8. // this software is subject to the Facebook Developer Principles and Policies
  9. // [http://developers.facebook.com/policy/]. This copyright notice shall be
  10. // included in all copies or substantial portions of the software.
  11. //
  12. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  13. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  14. // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  15. // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  16. // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  17. // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  18. #import <Foundation/Foundation.h>
  19. #import <FBSDKCoreKit/FBSDKCopying.h>
  20. #import <FBSDKCoreKit/FBSDKMacros.h>
  21. /*!
  22. @typedef NS_ENUM(NSUInteger, FBSDKAppGroupPrivacy)
  23. @abstract Specifies the privacy of a group.
  24. */
  25. typedef NS_ENUM(NSUInteger, FBSDKAppGroupPrivacy)
  26. {
  27. /*! Anyone can see the group, who's in it and what members post. */
  28. FBSDKAppGroupPrivacyOpen = 0,
  29. /*! Anyone can see the group and who's in it, but only members can see posts. */
  30. FBSDKAppGroupPrivacyClosed,
  31. };
  32. /*!
  33. @abstract Converts an FBSDKAppGroupPrivacy to an NSString.
  34. */
  35. FBSDK_EXTERN NSString *NSStringFromFBSDKAppGroupPrivacy(FBSDKAppGroupPrivacy privacy);
  36. /*!
  37. @abstract A model for creating an app group.
  38. */
  39. @interface FBSDKAppGroupContent : NSObject <FBSDKCopying, NSSecureCoding>
  40. /*!
  41. @abstract The description of the group.
  42. */
  43. @property (nonatomic, copy) NSString *groupDescription;
  44. /*!
  45. @abstract The name of the group.
  46. */
  47. @property (nonatomic, copy) NSString *name;
  48. /*!
  49. @abstract The privacy for the group.
  50. */
  51. @property (nonatomic, assign) FBSDKAppGroupPrivacy privacy;
  52. /*!
  53. @abstract Compares the receiver to another app group content.
  54. @param content The other content
  55. @return YES if the receiver's values are equal to the other content's values; otherwise NO
  56. */
  57. - (BOOL)isEqualToAppGroupContent:(FBSDKAppGroupContent *)content;
  58. @end