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