| | |
| | | |
| | | #import <Foundation/Foundation.h> |
| | | |
| | | NS_ASSUME_NONNULL_BEGIN |
| | | |
| | | #if __IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_10_0 |
| | | |
| | | /** |
| | |
| | | |
| | | Error codes from the SDK in the range 0-99 are reserved for this domain. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorDomain const FBSDKErrorDomain; |
| | | FOUNDATION_EXPORT NSErrorDomain const FBSDKErrorDomain |
| | | NS_SWIFT_NAME(ErrorDomain); |
| | | |
| | | #else |
| | | |
| | |
| | | |
| | | Error codes from the SDK in the range 0-99 are reserved for this domain. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorDomain; |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorDomain |
| | | NS_SWIFT_NAME(ErrorDomain); |
| | | |
| | | #endif |
| | | |
| | |
| | | If the invalid argument is a collection, the collection can be found with this key and the individual |
| | | invalid item can be found with FBSDKErrorArgumentValueKey. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorArgumentCollectionKey; |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorArgumentCollectionKey |
| | | NS_SWIFT_NAME(ErrorArgumentCollectionKey); |
| | | |
| | | /** |
| | | The userInfo key for the invalid argument name for errors with FBSDKErrorInvalidArgument. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorArgumentNameKey; |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorArgumentNameKey |
| | | NS_SWIFT_NAME(ErrorArgumentNameKey); |
| | | |
| | | /** |
| | | The userInfo key for the invalid argument value for errors with FBSDKErrorInvalidArgument. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorArgumentValueKey; |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorArgumentValueKey |
| | | NS_SWIFT_NAME(ErrorArgumentValueKey); |
| | | |
| | | /** |
| | | The userInfo key for the message for developers in NSErrors that originate from the SDK. |
| | | |
| | | The developer message will not be localized and is not intended to be presented within the app. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorDeveloperMessageKey; |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorDeveloperMessageKey |
| | | NS_SWIFT_NAME(ErrorDeveloperMessageKey); |
| | | |
| | | /** |
| | | The userInfo key describing a localized description that can be presented to the user. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorLocalizedDescriptionKey; |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorLocalizedDescriptionKey |
| | | NS_SWIFT_NAME(ErrorLocalizedDescriptionKey); |
| | | |
| | | /** |
| | | The userInfo key describing a localized title that can be presented to the user, used with `FBSDKLocalizedErrorDescriptionKey`. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorLocalizedTitleKey; |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKErrorLocalizedTitleKey |
| | | NS_SWIFT_NAME(ErrorLocalizedTitleKey); |
| | | |
| | | /* |
| | | @methodgroup FBSDKGraphRequest error userInfo keys |
| | |
| | | |
| | | See `FBSDKGraphErrorRecoveryProcessor` and `[FBSDKGraphRequest disableErrorRecovery]`. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorKey; |
| | | |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorCategoryKey |
| | | DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestErrorKey instead"); |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorKey |
| | | NS_SWIFT_NAME(GraphRequestErrorKey); |
| | | |
| | | /* |
| | | The userInfo key for the Graph API error code. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorGraphErrorCodeKey; |
| | | |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorGraphErrorCode |
| | | DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestErrorGraphErrorCodeKey instead"); |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorGraphErrorCodeKey |
| | | NS_SWIFT_NAME(GraphRequestErrorGraphErrorCodeKey); |
| | | |
| | | /* |
| | | The userInfo key for the Graph API error subcode. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorGraphErrorSubcodeKey; |
| | | |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorGraphErrorSubcode |
| | | DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestErrorGraphErrorSubcodeKey instead"); |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorGraphErrorSubcodeKey |
| | | NS_SWIFT_NAME(GraphRequestErrorGraphErrorSubcodeKey); |
| | | |
| | | /* |
| | | The userInfo key for the HTTP status code. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorHTTPStatusCodeKey; |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorHTTPStatusCodeKey |
| | | NS_SWIFT_NAME(GraphRequestErrorHTTPStatusCodeKey); |
| | | |
| | | /* |
| | | The userInfo key for the raw JSON response. |
| | | */ |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorParsedJSONResponseKey; |
| | | FOUNDATION_EXPORT NSErrorUserInfoKey const FBSDKGraphRequestErrorParsedJSONResponseKey |
| | | NS_SWIFT_NAME(GraphRequestErrorParsedJSONResponseKey); |
| | | |
| | | #else |
| | | |
| | |
| | | If the invalid argument is a collection, the collection can be found with this key and the individual |
| | | invalid item can be found with FBSDKErrorArgumentValueKey. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorArgumentCollectionKey; |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorArgumentCollectionKey |
| | | NS_SWIFT_NAME(ErrorArgumentCollectionKey); |
| | | |
| | | /** |
| | | The userInfo key for the invalid argument name for errors with FBSDKErrorInvalidArgument. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorArgumentNameKey; |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorArgumentNameKey |
| | | NS_SWIFT_NAME(ErrorArgumentNameKey); |
| | | |
| | | /** |
| | | The userInfo key for the invalid argument value for errors with FBSDKErrorInvalidArgument. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorArgumentValueKey; |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorArgumentValueKey |
| | | NS_SWIFT_NAME(ErrorArgumentValueKey); |
| | | |
| | | /** |
| | | The userInfo key for the message for developers in NSErrors that originate from the SDK. |
| | | |
| | | The developer message will not be localized and is not intended to be presented within the app. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorDeveloperMessageKey; |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorDeveloperMessageKey |
| | | NS_SWIFT_NAME(ErrorDeveloperMessageKey); |
| | | |
| | | /** |
| | | The userInfo key describing a localized description that can be presented to the user. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorLocalizedDescriptionKey; |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorLocalizedDescriptionKey |
| | | NS_SWIFT_NAME(ErrorLocalizedDescriptionKey); |
| | | |
| | | /** |
| | | The userInfo key describing a localized title that can be presented to the user, used with `FBSDKLocalizedErrorDescriptionKey`. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorLocalizedTitleKey; |
| | | FOUNDATION_EXPORT NSString *const FBSDKErrorLocalizedTitleKey |
| | | NS_SWIFT_NAME(ErrorLocalizedTitleKey); |
| | | |
| | | /* |
| | | @methodgroup FBSDKGraphRequest error userInfo keys |
| | |
| | | |
| | | See `FBSDKGraphErrorRecoveryProcessor` and `[FBSDKGraphRequest disableErrorRecovery]`. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorKey; |
| | | |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorCategoryKey |
| | | DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestErrorKey instead"); |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorKey |
| | | NS_SWIFT_NAME(GraphRequestErrorKey); |
| | | |
| | | /* |
| | | The userInfo key for the Graph API error code. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorGraphErrorCodeKey; |
| | | |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorGraphErrorCode |
| | | DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestErrorGraphErrorCodeKey instead"); |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorGraphErrorCodeKey |
| | | NS_SWIFT_NAME(GraphRequestErrorGraphErrorCodeKey); |
| | | |
| | | /* |
| | | The userInfo key for the Graph API error subcode. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorGraphErrorSubcodeKey; |
| | | |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorGraphErrorSubcode |
| | | DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestErrorGraphErrorSubcodeKey instead"); |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorGraphErrorSubcodeKey |
| | | NS_SWIFT_NAME(GraphRequestErrorGraphErrorSubcodeKey); |
| | | |
| | | /* |
| | | The userInfo key for the HTTP status code. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorHTTPStatusCodeKey; |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorHTTPStatusCodeKey |
| | | NS_SWIFT_NAME(GraphRequestErrorHTTPStatusCodeKey); |
| | | |
| | | /* |
| | | The userInfo key for the raw JSON response. |
| | | */ |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorParsedJSONResponseKey; |
| | | FOUNDATION_EXPORT NSString *const FBSDKGraphRequestErrorParsedJSONResponseKey |
| | | NS_SWIFT_NAME(GraphRequestErrorParsedJSONResponseKey); |
| | | |
| | | #endif |
| | | |
| | | /* |
| | | @methodgroup Common Code Block typedefs |
| | | */ |
| | | |
| | | /** |
| | | Success Block |
| | | */ |
| | | typedef void (^FBSDKCodeBlock)(void) |
| | | NS_SWIFT_NAME(CodeBlock); |
| | | |
| | | /** |
| | | Error Block |
| | | */ |
| | | typedef void (^FBSDKErrorBlock)(NSError *_Nullable error) |
| | | NS_SWIFT_NAME(ErrorBlock); |
| | | |
| | | /** |
| | | Success Block |
| | | */ |
| | | typedef void (^FBSDKSuccessBlock)(BOOL success, NSError *_Nullable error) |
| | | NS_SWIFT_NAME(SuccessBlock); |
| | | |
| | | /* |
| | | @methodgroup Enums |
| | | */ |
| | | |
| | | #ifndef NS_ERROR_ENUM |
| | | #define NS_ERROR_ENUM(_domain, _name) \ |
| | |
| | | #endif |
| | | |
| | | /** |
| | | FBSDKError |
| | | FBSDKCoreError |
| | | Error codes for FBSDKErrorDomain. |
| | | */ |
| | | typedef NS_ERROR_ENUM(FBSDKErrorDomain, FBSDKError) |
| | | typedef NS_ERROR_ENUM(FBSDKErrorDomain, FBSDKCoreError) |
| | | { |
| | | /** |
| | | Reserved. |
| | |
| | | Indicates an app switch to the browser (typically for a dialog) failed. |
| | | */ |
| | | FBSDKErrorBrowserUnavailable, |
| | | }; |
| | | |
| | | /** |
| | | Indicates that a bridge api interaction was interrupted. |
| | | */ |
| | | FBSDKErrorBridgeAPIInterruption, |
| | | } NS_SWIFT_NAME(CoreError); |
| | | |
| | | /** |
| | | FBSDKGraphRequestError |
| | |
| | | FBSDKGraphRequestErrorTransient = 1, |
| | | /** Indicates the error can be recovered (such as requiring a login). A recoveryAttempter will be provided with the error instance that can take UI action. */ |
| | | FBSDKGraphRequestErrorRecoverable = 2 |
| | | }; |
| | | } NS_SWIFT_NAME(GraphRequestError); |
| | | |
| | | /** |
| | | a formal protocol very similar to the informal protocol NSErrorRecoveryAttempting |
| | | */ |
| | | NS_SWIFT_UNAVAILABLE("") |
| | | @protocol FBSDKErrorRecoveryAttempting<NSObject> |
| | | |
| | | /** |
| | |
| | | |
| | | The value passed for didRecover must be YES if error recovery was completely successful, NO otherwise. |
| | | */ |
| | | - (void)attemptRecoveryFromError:(NSError *)error optionIndex:(NSUInteger)recoveryOptionIndex delegate:(id)delegate didRecoverSelector:(SEL)didRecoverSelector contextInfo:(void *)contextInfo; |
| | | |
| | | - (void)attemptRecoveryFromError:(NSError *)error |
| | | optionIndex:(NSUInteger)recoveryOptionIndex |
| | | delegate:(nullable id)delegate |
| | | didRecoverSelector:(SEL)didRecoverSelector |
| | | contextInfo:(nullable void *)contextInfo; |
| | | @end |
| | | |
| | | /** |
| | | Deprecated |
| | | */ |
| | | typedef NS_ENUM(NSInteger, FBSDKErrorCode) |
| | | { |
| | | FBSDKReservedErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorReserved instead") = 0, |
| | | FBSDKEncryptionErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorEncryption instead"), |
| | | FBSDKInvalidArgumentErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorInvalidArgument instead"), |
| | | FBSDKUnknownErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorUnknown instead"), |
| | | FBSDKNetworkErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorNetwork instead"), |
| | | FBSDKAppEventsFlushErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorAppEventsFlush instead"), |
| | | FBSDKGraphRequestNonTextMimeTypeReturnedErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorGraphRequestNonTextMimeTypeReturned instead"), |
| | | FBSDKGraphRequestProtocolMismatchErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorGraphRequestProtocolMismatch instead"), |
| | | FBSDKGraphRequestGraphAPIErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorGraphRequestGraphAPI instead"), |
| | | FBSDKDialogUnavailableErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorDialogUnavailable instead"), |
| | | FBSDKAccessTokenRequiredErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorAccessTokenRequired instead"), |
| | | FBSDKAppVersionUnsupportedErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorAppVersionUnsupported instead"), |
| | | FBSDKBrowserUnavailableErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorBrowserUnavailable instead"), |
| | | FBSDKBrowswerUnavailableErrorCode DEPRECATED_MSG_ATTRIBUTE("use FBSDKErrorBrowserUnavailable instead") = FBSDKBrowserUnavailableErrorCode, |
| | | } DEPRECATED_MSG_ATTRIBUTE("use FBSDKError instead"); |
| | | |
| | | /** |
| | | Deprecated |
| | | */ |
| | | typedef NS_ENUM(NSUInteger, FBSDKGraphRequestErrorCategory) |
| | | { |
| | | FBSDKGraphRequestErrorCategoryOther DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestErrorOther instead") = 0, |
| | | FBSDKGraphRequestErrorCategoryTransient DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestErrorTransient instead") = 1, |
| | | FBSDKGraphRequestErrorCategoryRecoverable DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestErrorRecoverable instead") = 2 |
| | | } DEPRECATED_MSG_ATTRIBUTE("use FBSDKGraphRequestError instead"); |
| | | NS_ASSUME_NONNULL_END |