| commit | author | age | ||
| bad748 | 1 | // Copyright (c) 2014-present, Facebook, Inc. All rights reserved. |
| W | 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 | ||
| 19 | #import <Foundation/Foundation.h> | |
| 20 | ||
| 21 | #import <FBSDKCoreKit/FBSDKCopying.h> | |
| 22 | ||
| 23 | /*! | |
| 24 | @abstract Represents a single hashtag that can be used with the share dialog. | |
| 25 | */ | |
| 26 | @interface FBSDKHashtag : NSObject <FBSDKCopying, NSSecureCoding> | |
| 27 | ||
| 28 | /*! | |
| 29 | @abstract Convenience method to build a new hashtag with a string identifier. Equivalent to setting the | |
| 30 | `stringRepresentation` property. | |
| 31 | @param hashtagString The hashtag string. | |
| 32 | */ | |
| 33 | + (instancetype)hashtagWithString:(NSString *)hashtagString; | |
| 34 | ||
| 35 | /*! | |
| 36 | @abstract The hashtag string. | |
| 37 | @discussion You are responsible for making sure that `stringRepresentation` is a valid hashtag (a single '#' followed | |
| 38 | by one or more word characters). Invalid hashtags are ignored when sharing content. You can check validity with the | |
| 39 | `valid` property. | |
| 40 | @return The hashtag string. | |
| 41 | */ | |
| 42 | @property (nonatomic, readwrite, copy) NSString *stringRepresentation; | |
| 43 | ||
| 44 | /*! | |
| 45 | @abstract Tests if a hashtag is valid. | |
| 46 | @discussion A valid hashtag matches the regular expression "#\w+": A single '#' followed by one or more | |
| 47 | word characters. | |
| 48 | @return YES if the hashtag is valid, NO otherwise. | |
| 49 | */ | |
| 50 | @property (nonatomic, readonly, assign, getter=isValid) BOOL valid; | |
| 51 | ||
| 52 | /*! | |
| 53 | @abstract Compares the receiver to another hashtag. | |
| 54 | @param hashtag The other hashtag | |
| 55 | @return YES if the receiver is equal to the other hashtag; otherwise NO | |
| 56 | */ | |
| 57 | - (BOOL)isEqualToHashtag:(FBSDKHashtag *)hashtag; | |
| 58 | ||
| 59 | @end | |
