| commit | author | age | ||
| 655e66 | 1 | /* |
| H | 2 | * Copyright (C) 2017 Twitter, Inc. |
| 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 | */ | |
| a0a843 | 17 | |
| H | 18 | #import <Foundation/Foundation.h> |
| 19 | #import <TwitterKit/TWTRJSONConvertible.h> | |
| 20 | ||
| 21 | NS_ASSUME_NONNULL_BEGIN | |
| 22 | ||
| 23 | /** | |
| 24 | * Represents a user on Twitter. | |
| 25 | */ | |
| 26 | @interface TWTRUser : NSObject <NSCoding, NSCopying, TWTRJSONConvertible> | |
| 27 | ||
| 28 | #pragma mark - Properties | |
| 29 | ||
| 30 | /** | |
| 31 | * The ID of the Twitter User. | |
| 32 | */ | |
| 33 | @property (nonatomic, copy, readonly) NSString *userID; | |
| 34 | ||
| 35 | /** | |
| 36 | * The user's name as it appears on their profile. | |
| 37 | * | |
| 38 | * @warning This can be modified by the user at any time. | |
| 39 | */ | |
| 40 | @property (nonatomic, copy, readonly) NSString *name; | |
| 41 | ||
| 42 | /** | |
| 43 | * The user's username on Twitter. | |
| 44 | * | |
| 45 | * @warning This can be modified by the user at any time. | |
| 46 | */ | |
| 47 | @property (nonatomic, copy, readonly) NSString *screenName; | |
| 48 | ||
| 49 | /** | |
| 50 | * Whether the user has been verified by Twitter. | |
| 51 | */ | |
| 52 | @property (nonatomic, readonly) BOOL isVerified; | |
| 53 | ||
| 54 | /** | |
| 55 | * Whether the user is protected. | |
| 56 | */ | |
| 57 | @property (nonatomic, readonly) BOOL isProtected; | |
| 58 | ||
| 59 | /** | |
| 60 | * The HTTPS URL of the user's profile image. | |
| 61 | */ | |
| 62 | @property (nonatomic, copy, readonly) NSString *profileImageURL; | |
| 63 | ||
| 64 | /** | |
| 65 | * The URL of a smaller version of the user's profile image. | |
| 66 | */ | |
| 67 | @property (nonatomic, copy, readonly) NSString *profileImageMiniURL; | |
| 68 | ||
| 69 | /** | |
| 70 | * The URL of a larger version of the user's profile image. | |
| 71 | */ | |
| 72 | @property (nonatomic, copy, readonly) NSString *profileImageLargeURL; | |
| 73 | ||
| 74 | /** | |
| 75 | * The formatted version of the user's `screenName` with the `@` sign for display purposes. | |
| 76 | */ | |
| 77 | @property (nonatomic, copy, readonly) NSString *formattedScreenName; | |
| 78 | ||
| 79 | /** | |
| 80 | * Returns the URL for deeplinking to the the user's profile. | |
| 81 | */ | |
| 82 | @property (nonatomic, copy, readonly) NSURL *profileURL; | |
| 83 | ||
| 84 | @end | |
| 85 | ||
| 86 | NS_ASSUME_NONNULL_END | |
