FBSDKGameRequestContent Class Reference
Inherits from | NSObject |
Conforms to | FBSDKCopying NSSecureCoding |
Declared in | FBSDKGameRequestContent.h |
Tasks
-
actionType
property -
– isEqualToGameRequestContent:
-
data
property -
filters
property -
message
property -
objectID
property -
recipients
property -
recipientSuggestions
property -
suggestions
property -
title
property -
to
property
Properties
actionType
Used when defining additional context about the nature of the request.
@property (nonatomic, assign) FBSDKGameRequestActionType actionType
Discussion
The parameter ‘objectID’ is required if the action type is either ‘FBSDKGameRequestSendActionType’ or ‘FBSDKGameRequestAskForActionType’. @seealso objectID
Declared In
FBSDKGameRequestContent.h
data
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.
@property (nonatomic, copy) NSString *data
Declared In
FBSDKGameRequestContent.h
filters
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.
@property (nonatomic, assign) FBSDKGameRequestFilter filters
Discussion
The parameter name is preserved to be consistent with the counter part on desktop.
Declared In
FBSDKGameRequestContent.h
message
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.
@property (nonatomic, copy) NSString *message
Declared In
FBSDKGameRequestContent.h
objectID
The Open Graph object ID of the object being sent. @seealso actionType
@property (nonatomic, copy) NSString *objectID
Declared In
FBSDKGameRequestContent.h
recipientSuggestions
An array of user IDs that will be included in the dialog as the first suggested friends. Cannot be used together with filters.
@property (nonatomic, copy) NSArray *recipientSuggestions
Discussion
This is equivalent to the “suggestions” parameter when using the web game request dialog.
Declared In
FBSDKGameRequestContent.h
recipients
An array of user IDs, usernames or invite tokens (NSString) of people to send request.
@property (nonatomic, copy) NSArray *recipients
Discussion
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.
Declared In
FBSDKGameRequestContent.h
suggestions
Use recipientSuggestions
instead. (Deprecated: Use recipientSuggestions
instead.)
@property (nonatomic, copy) NSArray *suggestions
Declared In
FBSDKGameRequestContent.h
Instance Methods
isEqualToGameRequestContent:
Compares the receiver to another game request content.
- (BOOL)isEqualToGameRequestContent:(FBSDKGameRequestContent *)content
Parameters
- content
The other content
Return Value
YES if the receiver’s values are equal to the other content’s values; otherwise NO
Declared In
FBSDKGameRequestContent.h