FBSDKGameRequestContent - Документация

FBSDKGameRequestContent

Доступна более новая версия данного класса. Посетите текущую версию.

A model for a game request.

Conforms to:	`FBSDKCopying, NSSecureCoding`
Superclass:	`NSObject`
Declared in:	`FBSDKGameRequestContent.h`

Свойства

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'.

Объявлен в: 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;

Объявлен в: 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.

Объявлен в: 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;

Объявлен в: FBSDKGameRequestContent.h

objectID

The Open Graph object ID of the object being sent.

@property (nonatomic,
    copy) NSString *objectID;

Объявлен в: 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.

Объявлен в: 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.

Объявлен в: FBSDKGameRequestContent.h

suggestions

@property (nonatomic,
    copy) NSArray *suggestions __attribute__ ((deprecated("use recipientSuggestions instead"

Объявлен в: FBSDKGameRequestContent.h

title

The title for the dialog.

@property (nonatomic,
    copy) NSString *title;

Объявлен в: FBSDKGameRequestContent.h

to

@property (nonatomic,
    copy) NSArray *to __attribute__ ((deprecated("use recipients instead"

Объявлен в: FBSDKGameRequestContent.h

Методы экземпляров

isEqualToGameRequestContent:

Compares the receiver to another game request content.

Параметр	Описание
`content`	The other content

- (BOOL) isEqualToGameRequestContent:(FBSDKGameRequestContent *)content;

Объявлен в: FBSDKGameRequestContent.h

Директивы Typedef

NS_ENUM

Additional context about the nature of the request.

typedef NS_ENUM(NSUInteger, FBSDKGameRequestActionType) { 
    /*! No action type */
    FBSDKGameRequestActionTypeNone = 0, /*! Send action type: The user is sending an object to the friends. 
        */
    FBSDKGameRequestActionTypeSend, /*! Ask For action type: The user is asking for an object from friends. 
        */
    FBSDKGameRequestActionTypeAskFor, /*! Turn action type: It is the turn of the friends to play against the user in a match. (no object) 
        */
    FBSDKGameRequestActionTypeTurn, 
};

Константа	Описание
`FBSDKGameRequestActionTypeNone`	No action type

Discussion:

FBSDKGameRequestActionType)

Объявлен в: FBSDKGameRequestContent.h

NS_ENUM

Filter for who can be displayed in the multi-friend selector.

typedef NS_ENUM(NSUInteger, FBSDKGameRequestFilter) { 
    /*! No filter, all friends can be displayed. */
    FBSDKGameRequestFilterNone = 0, /*! Friends using the app can be displayed. 
        */
    FBSDKGameRequestFilterAppUsers, /*! Friends not using the app can be displayed. 
        */
    FBSDKGameRequestFilterAppNonUsers, 
};

Константа	Описание
`FBSDKGameRequestFilterNone`	No filter, all friends can be displayed.

Discussion:

FBSDKGameRequestFilters)

Объявлен в: FBSDKGameRequestContent.h

NS_ENUM(NSUInteger,

Additional context about the nature of the request.

typedef NS_ENUM(NSUInteger, FBSDKGameRequestActionType) { 
    /*! No action type */
    FBSDKGameRequestActionTypeNone = 0, /*! Send action type: The user is sending an object to the friends. 
        */
    FBSDKGameRequestActionTypeSend, /*! Ask For action type: The user is asking for an object from friends. 
        */
    FBSDKGameRequestActionTypeAskFor, /*! Turn action type: It is the turn of the friends to play against the user in a match. (no object) 
        */
    FBSDKGameRequestActionTypeTurn, 
};

Константа	Описание
`FBSDKGameRequestActionTypeNone`	No action type
`FBSDKGameRequestActionTypeSend`	Send action type: The user is sending an object to the friends.
`FBSDKGameRequestActionTypeAskFor`	Ask For action type: The user is asking for an object from friends.
`FBSDKGameRequestActionTypeTurn`	Turn action type: It is the turn of the friends to play against the user in a match. (no object)

Discussion:

FBSDKGameRequestActionType)

Объявлен в: FBSDKGameRequestContent.h

NS_ENUM(NSUInteger,

Filter for who can be displayed in the multi-friend selector.

typedef NS_ENUM(NSUInteger, FBSDKGameRequestFilter) { 
    /*! No filter, all friends can be displayed. */
    FBSDKGameRequestFilterNone = 0, /*! Friends using the app can be displayed. 
        */
    FBSDKGameRequestFilterAppUsers, /*! Friends not using the app can be displayed. 
        */
    FBSDKGameRequestFilterAppNonUsers, 
};

Константа	Описание
`FBSDKGameRequestFilterNone`	No filter, all friends can be displayed.
`FBSDKGameRequestFilterAppUsers`	Friends using the app can be displayed.
`FBSDKGameRequestFilterAppNonUsers`	Friends not using the app can be displayed.

Discussion:

FBSDKGameRequestFilters)

Объявлен в: FBSDKGameRequestContent.h