// Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
|
//
|
// You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
|
// copy, modify, and distribute this software in source code or binary form for use
|
// in connection with the web services and APIs provided by Facebook.
|
//
|
// As with any software that integrates with the Facebook platform, your use of
|
// this software is subject to the Facebook Developer Principles and Policies
|
// [http://developers.facebook.com/policy/]. This copyright notice shall be
|
// included in all copies or substantial portions of the software.
|
//
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
// 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 <Foundation/Foundation.h>
|
|
@protocol FBSDKAppGroupJoinDialogDelegate;
|
|
/*!
|
@abstract A dialog for joining app groups.
|
*/
|
@interface FBSDKAppGroupJoinDialog : NSObject
|
|
/*!
|
@abstract Convenience method to build up an app group dialog with content and a delegate.
|
@param groupID The ID for the group.
|
@param delegate The receiver's delegate.
|
*/
|
+ (instancetype)showWithGroupID:(NSString *)groupID
|
delegate:(id<FBSDKAppGroupJoinDialogDelegate>)delegate;
|
|
/*!
|
@abstract The receiver's delegate or nil if it doesn't have a delegate.
|
*/
|
@property (nonatomic, weak) id<FBSDKAppGroupJoinDialogDelegate> delegate;
|
|
/*!
|
@abstract The ID for group.
|
*/
|
@property (nonatomic, copy) NSString *groupID;
|
|
/*!
|
@abstract A Boolean value that indicates whether the receiver can initiate an app group dialog.
|
@discussion 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 app group dialog from the receiver.
|
@result YES if the receiver was able to show the dialog, otherwise NO.
|
*/
|
- (BOOL)show;
|
|
/*!
|
@abstract 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.
|
*/
|
- (BOOL)validateWithError:(NSError *__autoreleasing *)errorRef;
|
|
@end
|
|
/*!
|
@abstract A delegate for FBSDKAppGroupJoinDialog.
|
@discussion The delegate is notified with the results of the app group 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 an app group request and cancellation.
|
*/
|
@protocol FBSDKAppGroupJoinDialogDelegate <NSObject>
|
|
/*!
|
@abstract Sent to the delegate when the app group request completes without error.
|
@param appGroupJoinDialog The FBSDKAppGroupJoinDialog that completed.
|
@param results The results from the dialog. This may be nil or empty.
|
*/
|
- (void)appGroupJoinDialog:(FBSDKAppGroupJoinDialog *)appGroupJoinDialog didCompleteWithResults:(NSDictionary *)results;
|
|
/*!
|
@abstract Sent to the delegate when the app group request encounters an error.
|
@param appGroupJoinDialog The FBSDKAppGroupJoinDialog that completed.
|
@param error The error.
|
*/
|
- (void)appGroupJoinDialog:(FBSDKAppGroupJoinDialog *)appGroupJoinDialog didFailWithError:(NSError *)error;
|
|
/*!
|
@abstract Sent to the delegate when the app group dialog is cancelled.
|
@param appGroupJoinDialog The FBSDKAppGroupJoinDialog that completed.
|
*/
|
- (void)appGroupJoinDialogDidCancel:(FBSDKAppGroupJoinDialog *)appGroupJoinDialog;
|
|
@end
|
