| | |
| | | // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
| | | // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| | | |
| | | #import "TargetConditionals.h" |
| | | |
| | | #if !TARGET_OS_TV |
| | | |
| | | #import <Foundation/Foundation.h> |
| | | |
| | | #import <FBSDKShareKit/FBSDKGameRequestContent.h> |
| | | #import "FBSDKGameRequestContent.h" |
| | | |
| | | NS_ASSUME_NONNULL_BEGIN |
| | | |
| | | @protocol FBSDKGameRequestDialogDelegate; |
| | | |
| | | /*! |
| | | @abstract A dialog for sending game requests. |
| | | /** |
| | | A dialog for sending game requests. |
| | | */ |
| | | NS_SWIFT_NAME(GameRequestDialog) |
| | | @interface FBSDKGameRequestDialog : NSObject |
| | | |
| | | /*! |
| | | @abstract Convenience method to build up a game request with content and a delegate. |
| | | - (instancetype)init NS_DESIGNATED_INITIALIZER |
| | | NS_SWIFT_UNAVAILABLE("Use init(content:delegate:) instead"); |
| | | + (instancetype)new NS_UNAVAILABLE; |
| | | |
| | | /** |
| | | Convenience method to build up a game request with content and a delegate. |
| | | @param content The content for the game request. |
| | | @param delegate The receiver's delegate. |
| | | */ |
| | | + (instancetype)showWithContent:(FBSDKGameRequestContent *)content delegate:(id<FBSDKGameRequestDialogDelegate>)delegate; |
| | | + (instancetype)dialogWithContent:(FBSDKGameRequestContent *)content |
| | | delegate:(nullable id<FBSDKGameRequestDialogDelegate>)delegate |
| | | NS_SWIFT_NAME(init(content:delegate:)); |
| | | |
| | | /*! |
| | | @abstract The receiver's delegate or nil if it doesn't have a delegate. |
| | | /** |
| | | Convenience method to build up and show a game request with content and a delegate. |
| | | @param content The content for the game request. |
| | | @param delegate The receiver's delegate. |
| | | */ |
| | | @property (nonatomic, weak) id<FBSDKGameRequestDialogDelegate> delegate; |
| | | + (instancetype)showWithContent:(FBSDKGameRequestContent *)content |
| | | delegate:(nullable id<FBSDKGameRequestDialogDelegate>)delegate |
| | | NS_SWIFT_UNAVAILABLE("Use init(content:delegate:).show() instead"); |
| | | |
| | | /*! |
| | | @abstract The content for game request. |
| | | /** |
| | | The receiver's delegate or nil if it doesn't have a delegate. |
| | | */ |
| | | @property (nonatomic, weak, nullable) id<FBSDKGameRequestDialogDelegate> delegate; |
| | | |
| | | /** |
| | | The content for game request. |
| | | */ |
| | | @property (nonatomic, copy) FBSDKGameRequestContent *content; |
| | | |
| | | /*! |
| | | @abstract Specifies whether frictionless requests are enabled. |
| | | /** |
| | | Specifies whether frictionless requests are enabled. |
| | | */ |
| | | @property (nonatomic, assign) BOOL frictionlessRequestsEnabled; |
| | | @property (nonatomic, assign, getter=isFrictionlessRequestsEnabled) BOOL frictionlessRequestsEnabled; |
| | | |
| | | /*! |
| | | @abstract A Boolean value that indicates whether the receiver can initiate a game request. |
| | | @discussion May return NO if the appropriate Facebook app is not installed and is required or an access token is |
| | | /** |
| | | A Boolean value that indicates whether the receiver can initiate a game request. |
| | | |
| | | May return NO if the appropriate Facebook app is not installed and is required or an access token is |
| | | required but not available. This method does not validate the content on the receiver, so this can be checked before |
| | | building up the content. |
| | | @see validateWithError: |
| | | @result YES if the receiver can share, otherwise NO. |
| | | */ |
| | | - (BOOL)canShow; |
| | | |
| | | /*! |
| | | @abstract Begins the game request from the receiver. |
| | | @result YES if the receiver was able to show the dialog, otherwise NO. |
| | | @see validateWithError: |
| | | @return YES if the receiver can share, otherwise NO. |
| | | */ |
| | | @property (nonatomic, readonly) BOOL canShow; |
| | | |
| | | /** |
| | | Begins the game request from the receiver. |
| | | @return YES if the receiver was able to show the dialog, otherwise NO. |
| | | */ |
| | | - (BOOL)show; |
| | | |
| | | /*! |
| | | @abstract Validates the content on the receiver. |
| | | /** |
| | | Validates the content on the receiver. |
| | | @param errorRef If an error occurs, upon return contains an NSError object that describes the problem. |
| | | @return YES if the content is valid, otherwise NO. |
| | | */ |
| | |
| | | |
| | | @end |
| | | |
| | | /*! |
| | | @abstract A delegate for FBSDKGameRequestDialog. |
| | | @discussion The delegate is notified with the results of the game request as long as the application has permissions to |
| | | /** |
| | | A delegate for FBSDKGameRequestDialog. |
| | | |
| | | The delegate is notified with the results of the game request as long as the application has permissions to |
| | | receive the information. For example, if the person is not signed into the containing app, the shower may not be able |
| | | to distinguish between completion of a game request and cancellation. |
| | | */ |
| | | NS_SWIFT_NAME(GameRequestDialogDelegate) |
| | | @protocol FBSDKGameRequestDialogDelegate <NSObject> |
| | | |
| | | /*! |
| | | @abstract Sent to the delegate when the game request completes without error. |
| | | /** |
| | | Sent to the delegate when the game request completes without error. |
| | | @param gameRequestDialog The FBSDKGameRequestDialog that completed. |
| | | @param results The results from the dialog. This may be nil or empty. |
| | | */ |
| | | - (void)gameRequestDialog:(FBSDKGameRequestDialog *)gameRequestDialog didCompleteWithResults:(NSDictionary *)results; |
| | | - (void)gameRequestDialog:(FBSDKGameRequestDialog *)gameRequestDialog didCompleteWithResults:(NSDictionary<NSString *, id> *)results; |
| | | |
| | | /*! |
| | | @abstract Sent to the delegate when the game request encounters an error. |
| | | /** |
| | | Sent to the delegate when the game request encounters an error. |
| | | @param gameRequestDialog The FBSDKGameRequestDialog that completed. |
| | | @param error The error. |
| | | */ |
| | | - (void)gameRequestDialog:(FBSDKGameRequestDialog *)gameRequestDialog didFailWithError:(NSError *)error; |
| | | |
| | | /*! |
| | | @abstract Sent to the delegate when the game request dialog is cancelled. |
| | | /** |
| | | Sent to the delegate when the game request dialog is cancelled. |
| | | @param gameRequestDialog The FBSDKGameRequestDialog that completed. |
| | | */ |
| | | - (void)gameRequestDialogDidCancel:(FBSDKGameRequestDialog *)gameRequestDialog; |
| | | |
| | | @end |
| | | |
| | | NS_ASSUME_NONNULL_END |
| | | |
| | | #endif |