iOS SDK Version
FBSDKShareKit Reference

FBSDKGameRequestContent

@interfaceFBSDKGameRequestContent:NSObject<NSCopying,NSObject,FBSDKSharingValidation,NSSecureCoding>
A model for a game request.
  • Used when defining additional context about the nature of the request.
    The parameter ‘objectID’ is required if the action type is either ‘FBSDKGameRequestSendActionType’ or ‘FBSDKGameRequestAskForActionType’.
    See also
    SeeAlso:objectID

    Declaration

    Objective-C
    @property(nonatomic,assign,unsafe_unretained,readwrite)FBSDKGameRequestActionTypeactionType;
    Swift
    varactionType:GameRequestActionType{getset}
  • Compares the receiver to another game request content.

    Declaration

    Objective-C
    -(BOOL)isEqualToGameRequestContent:(nonnullFBSDKGameRequestContent*)content;
    Swift
    funcisEqual(tocontent:GameRequestContent)->Bool

    Parameters

    Return Value

    YES if the receiver’s values are equal to the other content’s values; otherwise NO
  • Additional freeform data you may pass for tracking. This will be stored as part of the request objects created. The maximum length is 255 characters.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite,nullable)NSString*data;
    Swift
    vardata:String?{getset}
  • This controls the set of friends someone sees if a multi-friend selector is shown. It is FBSDKGameRequestNoFilter by default, meaning that all friends can be shown. If specify as FBSDKGameRequestAppUsersFilter, only friends who use the app will be shown. On the other hands, use FBSDKGameRequestAppNonUsersFilter to filter only friends who do not use the app.
    The parameter name is preserved to be consistent with the counter part on desktop.

    Declaration

    Objective-C
    @property(nonatomic,assign,unsafe_unretained,readwrite)FBSDKGameRequestFilterfilters;
    Swift
    varfilters:GameRequestFilter{getset}
  • A plain-text message to be sent as part of the request. This text will surface in the App Center view of the request, but not on the notification jewel. Required parameter.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite)NSString*_Nonnullmessage;
    Swift
    varmessage:String{getset}
  • The Open Graph object ID of the object being sent.
    See also
    SeeAlso:actionType

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite)NSString*_NonnullobjectID;
    Swift
    varobjectID:String{getset}
  • An array of user IDs, usernames or invite tokens (NSString) of people to send request.
    These may or may not be a friend of the sender. If this is specified by the app, the sender will not have a choice of recipients. If not, the sender will see a multi-friend selector
    This is equivalent to the “to” parameter when using the web game request dialog.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite)NSArray<NSString*>*_Nonnullrecipients;
    Swift
    varrecipients:[String]{getset}
  • An array of user IDs that will be included in the dialog as the first suggested friends. Cannot be used together with filters.
    This is equivalent to the “suggestions” parameter when using the web game request dialog.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite)NSArray<NSString*>*_NonnullrecipientSuggestions;
    Swift
    varrecipientSuggestions:[String]{getset}
  • The title for the dialog.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite)NSString*_Nonnulltitle;
    Swift
    vartitle:String{getset}
  • The call to action for the dialog.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite)NSString*_Nonnullcta;
    Swift
    varcta:String{getset}