| 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 | ||
| e81c27 | 21 | NS_ASSUME_NONNULL_BEGIN |
| H | 22 | |
| 9febd9 | 23 | /** |
| W | 24 | Describes the callback for fetchDeferredAppLink. |
| 13e53a | 25 | @param url the url representing the deferred App Link |
| H | 26 | @param error the error during the request, if any |
| bad748 | 27 | |
| 9febd9 | 28 | |
| W | 29 | The url may also have a fb_click_time_utc query parameter that |
| bad748 | 30 | represents when the click occurred that caused the deferred App Link to be created. |
| W | 31 | */ |
| e81c27 | 32 | typedef void (^FBSDKURLBlock)(NSURL *_Nullable url, NSError *_Nullable error) |
| H | 33 | NS_SWIFT_NAME(URLBlock); |
| bad748 | 34 | |
| W | 35 | |
| 9febd9 | 36 | /** |
| W | 37 | Class containing App Links related utility methods. |
| bad748 | 38 | */ |
| e81c27 | 39 | NS_SWIFT_NAME(AppLinkUtility) |
| bad748 | 40 | @interface FBSDKAppLinkUtility : NSObject |
| e81c27 | 41 | |
| H | 42 | - (instancetype)init NS_UNAVAILABLE; |
| 43 | + (instancetype)new NS_UNAVAILABLE; | |
| bad748 | 44 | |
| 9febd9 | 45 | /** |
| W | 46 | Call this method from the main thread to fetch deferred applink data if you use Mobile App |
| bad748 | 47 | Engagement Ads (https://developers.facebook.com/docs/ads-for-apps/mobile-app-ads-engagement). |
| W | 48 | This may require a network round trip. If successful, the handler is invoked with the link |
| 49 | data (this will only return a valid URL once, and future calls will result in a nil URL | |
| 50 | value in the callback). | |
| 51 | ||
| 13e53a | 52 | @param handler the handler to be invoked if there is deferred App Link data |
| bad748 | 53 | |
| 9febd9 | 54 | |
| W | 55 | The handler may contain an NSError instance to capture any errors. In the |
| bad748 | 56 | common case where there simply was no app link data, the NSError instance will be nil. |
| W | 57 | |
| 58 | This method should only be called from a location that occurs after any launching URL has | |
| 59 | been processed (e.g., you should call this method from your application delegate's | |
| 60 | applicationDidBecomeActive:). | |
| 61 | */ | |
| e81c27 | 62 | + (void)fetchDeferredAppLink:(nullable FBSDKURLBlock)handler; |
| bad748 | 63 | |
| W | 64 | /* |
| e81c27 | 65 | Call this method to fetch promotion code from the url, if it's present. |
| bad748 | 66 | |
| 13e53a | 67 | @param url App Link url that was passed to the app. |
| bad748 | 68 | |
| 13e53a | 69 | @return Promotion code string. |
| bad748 | 70 | |
| 9febd9 | 71 | |
| W | 72 | Call this method to fetch App Invite Promotion Code from applink if present. |
| bad748 | 73 | This can be used to fetch the promotion code that was associated with the invite when it |
| W | 74 | was created. This method should be called with the url from the openURL method. |
| 75 | */ | |
| e81c27 | 76 | + (nullable NSString *)appInvitePromotionCodeFromURL:(NSURL *)url; |
| bad748 | 77 | |
| W | 78 | @end |
| e81c27 | 79 | |
| H | 80 | NS_ASSUME_NONNULL_END |
