Package | com.distriqt.extension.facebookapi.games.builders |
Class | public class GameRequestContentBuilder |
Inheritance | GameRequestContentBuilder ![]() |
GameRequest
Method | Defined By | ||
---|---|---|---|
Constructor
| GameRequestContentBuilder | ||
build():Object | GameRequestContentBuilder | ||
setActionType(actionType:String):GameRequestContentBuilder
Sets the action type for this request
Must be one of:
GameRequestActionType.SEND
GameRequestActionType.ASK_FOR
GameRequestActionType.TURN
| GameRequestContentBuilder | ||
setData(data:String):GameRequestContentBuilder
Sets optional data which can be used for tracking; maximum length is 255 characters
| GameRequestContentBuilder | ||
setFilters(filters:String):GameRequestContentBuilder
Sets the filters for everybody/app users/non app users
| GameRequestContentBuilder | ||
setMessage(message:String):GameRequestContentBuilder
ts the message users receiving the request will see. | GameRequestContentBuilder | ||
setObjectId(objectId:String):GameRequestContentBuilder
Sets the open graph id of the object that action type will be performed on
Only valid (and required) for ActionTypes SEND, ASKFOR
| GameRequestContentBuilder | ||
setRecipients(recipients:Array):GameRequestContentBuilder
An array of user IDs, usernames or invite tokens of people to send request. | GameRequestContentBuilder | ||
setSuggestions(suggestions:Array):GameRequestContentBuilder
Sets a list of user ids suggested as request receivers
| GameRequestContentBuilder | ||
setTitle(title:String):GameRequestContentBuilder
Sets an optional title for the dialog; maximum length is 50 characters. | GameRequestContentBuilder |
GameRequestContentBuilder | () | Constructor |
public function GameRequestContentBuilder()
Constructor
build | () | method |
public function build():Object
ReturnsObject |
setActionType | () | method |
public function setActionType(actionType:String):GameRequestContentBuilder
Sets the action type for this request
Must be one of:
GameRequestActionType.SEND
GameRequestActionType.ASK_FOR
GameRequestActionType.TURN
Parameters
actionType:String — The action type from the GameRequestActionType definitions
|
GameRequestContentBuilder — GameRequestContentBuilder instance for chaining
|
See also
setData | () | method |
public function setData(data:String):GameRequestContentBuilder
Sets optional data which can be used for tracking; maximum length is 255 characters
Parameters
data:String — The data
|
GameRequestContentBuilder — GameRequestContentBuilder instance for chaining
|
setFilters | () | method |
public function setFilters(filters:String):GameRequestContentBuilder
Sets the filters for everybody/app users/non app users
Parameters
filters:String |
GameRequestContentBuilder — GameRequestContentBuilder instance for chaining
|
setMessage | () | method |
public function setMessage(message:String):GameRequestContentBuilder
ts the message users receiving the request will see. The maximum length is 60 characters.
Parameters
message:String — The message
|
GameRequestContentBuilder — GameRequestContentBuilder instance for chaining
|
setObjectId | () | method |
public function setObjectId(objectId:String):GameRequestContentBuilder
Sets the open graph id of the object that action type will be performed on
Only valid (and required) for ActionTypes SEND, ASKFOR
Parameters
objectId:String — The object id
|
GameRequestContentBuilder — GameRequestContentBuilder instance for chaining
|
setRecipients | () | method |
public function setRecipients(recipients:Array):GameRequestContentBuilder
An array of user IDs, usernames or invite tokens of people to send request. If this is not specified, a friend selector will be displayed and the user can select up to 50 friends.
This is equivalent to the "to" parameter when using the web game request dialog.
Parameters
recipients:Array — The array of user ids to send the request to
|
GameRequestContentBuilder — GameRequestContentBuilder instance for chaining
|
setSuggestions | () | method |
public function setSuggestions(suggestions:Array):GameRequestContentBuilder
Sets a list of user ids suggested as request receivers
Parameters
suggestions:Array — An array of strings representing user ids
|
GameRequestContentBuilder — GameRequestContentBuilder instance for chaining
|
setTitle | () | method |
public function setTitle(title:String):GameRequestContentBuilder
Sets an optional title for the dialog; maximum length is 50 characters.
Parameters
title:String — The title
|
GameRequestContentBuilder — GameRequestContentBuilder instance for chaining
|