| 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 | ||
| 20 | NS_ASSUME_NONNULL_BEGIN | |
| 21 | ||
| 22 | /** | |
| 23 | * Constants for notifications that are posted from TwitterKit. These are posted on the default notification center. | |
| 24 | */ | |
| 25 | ||
| 26 | #pragma mark - Tweet Action Notifications | |
| 27 | ||
| 28 | /** | |
| 29 | * Notification indicating a Tweet was selected. | |
| 30 | */ | |
| 655e66 | 31 | FOUNDATION_EXTERN NSString *const TWTRDidSelectTweetNotification; |
| a0a843 | 32 | |
| H | 33 | /** |
| 34 | * Notification indicating the Tweet detail view was shown for a given Tweet. | |
| 35 | */ | |
| 655e66 | 36 | FOUNDATION_EXTERN NSString *const TWTRDidShowTweetDetailNotification; |
| a0a843 | 37 | |
| H | 38 | /** |
| 39 | * Notification indicating the user has selected to share Tweet. | |
| 40 | */ | |
| 655e66 | 41 | FOUNDATION_EXTERN NSString *const TWTRWillShareTweetNotification; |
| a0a843 | 42 | |
| H | 43 | /** |
| 44 | * Notification indicating the Tweet was shared. | |
| 45 | */ | |
| 655e66 | 46 | FOUNDATION_EXTERN NSString *const TWTRDidShareTweetNotification; |
| a0a843 | 47 | |
| H | 48 | /** |
| 49 | * Notification indicating the user has cancelled sharing of the Tweet. | |
| 50 | */ | |
| 655e66 | 51 | FOUNDATION_EXTERN NSString *const TWTRCancelledShareTweetNotification; |
| a0a843 | 52 | |
| H | 53 | /** |
| 54 | * Notification indicating the user has liked a Tweet. | |
| 55 | */ | |
| 655e66 | 56 | FOUNDATION_EXTERN NSString *const TWTRDidLikeTweetNotification; |
| a0a843 | 57 | |
| H | 58 | /** |
| 59 | * Notification indicating the user has unliked a Tweet. | |
| 60 | */ | |
| 655e66 | 61 | FOUNDATION_EXTERN NSString *const TWTRDidUnlikeTweetNotification; |
| a0a843 | 62 | |
| H | 63 | #pragma mark - Media Notifications |
| 64 | ||
| 65 | /** | |
| 66 | * Notification indicating the the playback state of a video | |
| 67 | * has changed. | |
| 68 | * | |
| 69 | * object: The UIView emitting these notifications | |
| 70 | * userInfo: {TWTRVideoPlaybackStateKey: TWTRVideoStateValuePlaying} | |
| 71 | * {TWTRVideoPlaybackStateKey: TWTRVideoStateValuePaused} | |
| 72 | * {TWTRVideoPlaybackStateKey: TWTRVideoStateValueCompleted} | |
| 73 | */ | |
| 655e66 | 74 | FOUNDATION_EXTERN NSString *const TWTRVideoPlaybackStateChangedNotification; |
| a0a843 | 75 | |
| H | 76 | /** |
| 77 | * User info key for the state of video playback. | |
| 78 | */ | |
| 655e66 | 79 | FOUNDATION_EXTERN NSString *const TWTRVideoPlaybackStateKey; |
| a0a843 | 80 | |
| H | 81 | /** |
| 82 | * User info values for the state of video playback. | |
| 83 | */ | |
| 655e66 | 84 | FOUNDATION_EXTERN NSString *const TWTRVideoStateValuePlaying; |
| H | 85 | FOUNDATION_EXTERN NSString *const TWTRVideoStateValuePaused; |
| 86 | FOUNDATION_EXTERN NSString *const TWTRVideoStateValueCompleted; | |
| a0a843 | 87 | |
| H | 88 | #pragma mark - Presentation Notifications |
| 89 | ||
| 90 | /** | |
| 91 | * Notification indicating that the video view controller will | |
| 92 | * be presented. | |
| 93 | * | |
| 94 | * object: The UIViewController hosting the video view | |
| 95 | * userInfo: {TWTRVideoTypeKey: TWTRVideoTypeGIF} | |
| 96 | * {TWTRVideoTypeKey: TWTRVideoTypeStandard} | |
| 97 | * {TWTRVideoTypeKey: TWTRVideoTypeVine} | |
| 98 | */ | |
| 655e66 | 99 | FOUNDATION_EXTERN NSString *const TWTRWillPresentVideoNotification; |
| a0a843 | 100 | |
| H | 101 | /** |
| 102 | * Notification indicating that the video view controller has | |
| 103 | * been dismissed. | |
| 104 | * | |
| 105 | * object: The UIViewController hosting the video view | |
| 106 | */ | |
| 655e66 | 107 | FOUNDATION_EXTERN NSString *const TWTRDidDismissVideoNotification; |
| a0a843 | 108 | |
| H | 109 | /** |
| 110 | * The key to fetch the type of video being displayed in a | |
| 111 | * TWTRVideoViewController. | |
| 112 | */ | |
| 655e66 | 113 | FOUNDATION_EXTERN NSString *const TWTRVideoTypeKey; |
| a0a843 | 114 | |
| H | 115 | /** |
| 116 | * User info values for the type of video being displayed | |
| 117 | * in a TWTRVideoViewController. | |
| 118 | */ | |
| 655e66 | 119 | FOUNDATION_EXTERN NSString *const TWTRVideoTypeGIF; |
| H | 120 | FOUNDATION_EXTERN NSString *const TWTRVideoTypeStandard; |
| 121 | FOUNDATION_EXTERN NSString *const TWTRVideoTypeVine; | |
| a0a843 | 122 | |
| H | 123 | #pragma mark - Notification User Info |
| 124 | ||
| 125 | /** | |
| 126 | * User info key to fetch the associated Tweet in the notification. | |
| 127 | */ | |
| 655e66 | 128 | FOUNDATION_EXTERN NSString *const TWTRNotificationInfoTweet; |
| a0a843 | 129 | |
| H | 130 | /** |
| 131 | * A notification which is posted when a user logs out of Twitter. | |
| 132 | * The notification will contain a user dictionary which contains | |
| 133 | * the user id which is being logged out. Note, this notification may | |
| 134 | * be posted as a result of starting the Twitter object. | |
| 135 | */ | |
| 655e66 | 136 | FOUNDATION_EXTERN NSString *const TWTRUserDidLogOutNotification; |
| H | 137 | FOUNDATION_EXTERN NSString *const TWTRLoggedOutUserIDKey; |
| a0a843 | 138 | |
| H | 139 | /** |
| 140 | * A notification which is posted when a user logs in to Twitter. | |
| 141 | * The notification will contain a user dictionary which contains | |
| 142 | * the user id which is being logged in. Note, this notification may | |
| 143 | * be posted as a result of starting the Twitter object. | |
| 144 | */ | |
| 655e66 | 145 | FOUNDATION_EXTERN NSString *const TWTRUserDidLogInNotification; |
| H | 146 | FOUNDATION_EXTERN NSString *const TWTRLoggedInUserIDKey; |
| a0a843 | 147 | |
| H | 148 | NS_ASSUME_NONNULL_END |
