Package com.restfb

Klasse DefaultFacebookClient

java.lang.Object

com.restfb.DefaultFacebookClient

Alle implementierten Schnittstellen:

FacebookClient

public class DefaultFacebookClient
extends Object
implements FacebookClient

Default implementation of a Facebook Graph API client.

Autor:

Mark Allen

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
protected static interface	DefaultFacebookClient.Requestor

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen com.restfb.FacebookClient

FacebookClient.AccessToken, FacebookClient.DebugTokenError, FacebookClient.DebugTokenInfo, FacebookClient.GranularScope

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected static final String	ACCESS_TOKEN_PARAM_NAME	Reserved access token parameter name.
protected String	accessToken	Graph API access token.
protected boolean	accessTokenInHeader
static final String	ALGORITHM
protected Version	apiVersion	Version of API endpoint.
static final String	APP_ID
static final String	APP_SECRET
protected static final String	APP_SECRET_PROOF_PARAM_NAME	Reserved application secret proof parameter name.
static final String	CANNOT_EXTRACT_ACCESS_TOKEN_MESSAGE
static final String	CLIENT_ID
static final String	CONNECTION
static final String	CONNECTION_TYPE
protected static final String	FORMAT_PARAM_NAME	Reserved "result format" parameter name.
protected boolean	httpDeleteFallback	By default this is false, so real http DELETE is used
protected static final String	IDS_PARAM_NAME	Reserved "multiple IDs" parameter name.
protected JsonMapper	jsonMapper	Handles mapping Facebook response JSON to Java objects.
protected static final String	METHOD_PARAM_NAME	Reserved method override parameter name.
static final String	PARAM_CLIENT_SECRET
static final String	SCOPE
protected WebRequestor	webRequestor	Handles GETs and POSTs to the Facebook API endpoint.

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	DefaultFacebookClient()
	DefaultFacebookClient(Version apiVersion)	Creates a Facebook Graph API client with the given apiVersion.
	DefaultFacebookClient(String accessToken, Version apiVersion)	Creates a Facebook Graph API client with the given accessToken.
	DefaultFacebookClient(String accessToken, WebRequestor webRequestor, JsonMapper jsonMapper, Version apiVersion)	Creates a Facebook Graph API client with the given accessToken.
	DefaultFacebookClient(String accessToken, String appSecret, Version apiVersion)	Creates a Facebook Graph API client with the given accessToken.
	DefaultFacebookClient(String accessToken, String appSecret, WebRequestor webRequestor, JsonMapper jsonMapper, Version apiVersion)	Creates a Facebook Graph API client with the given accessToken, webRequestor, and jsonMapper.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
List<FacebookClient.AccessToken>	convertSessionKeysToAccessTokens(String appId, String secretKey, String... sessionKeys)	Converts an arbitrary number of sessionKeys to OAuth access tokens.
FacebookClient	createClientWithAccessToken(String accessToken)	creates a new FacebookClient from a old one.
protected String	createEndpointForApiCall(String apiCall, boolean hasAttachment)	Given an api call (e.g.
FacebookClient.DebugTokenInfo	debugToken(String inputToken)	When working with access tokens, you may need to check what information is associated with them, such as its user or expiry.
boolean	deleteObject(String object, Parameter... parameters)	Performs a Graph API delete operation on the given object.
List<BatchResponse>	executeBatch(BatchRequest... batchRequests)	Executes operations as a batch using the Batch API.
List<BatchResponse>	executeBatch(List<BatchRequest> batchRequests)	Executes operations as a batch using the Batch API.
List<BatchResponse>	executeBatch(List<BatchRequest> batchRequests, List<BinaryAttachment> binaryAttachments)	Executes operations as a batch with binary attachments using the Batch API.
<T> Connection<T>	fetchConnection(String connection, Class<T> connectionType, Parameter... parameters)	Fetches a Graph API Connection type, mapping the result to an instance of connectionType.
<T> Connection<T>	fetchConnectionPage(String connectionPageUrl, Class<T> connectionType)	Fetches a previous/next page of a Graph API Connection type, mapping the result to an instance of connectionType.
DeviceCode	fetchDeviceCode(ScopeBuilder scope)	Method to initialize the device access token generation.
<T> T	fetchObject(String object, Class<T> objectType, Parameter... parameters)	Fetches a single Graph API object, mapping the result to an instance of objectType.
<T> T	fetchObjects(List<String> ids, Class<T> objectType, Parameter... parameters)	Fetches multiple Graph API objects in a single call, mapping the results to an instance of objectType.
FacebookEndpoints	getFacebookEndpointUrls()
FacebookExceptionGenerator	getFacebookExceptionGenerator()	fetch the current facebook exception generator implementing the FacebookExceptionGenerator interface
protected String	getFacebookGraphEndpointUrl()	Returns the base endpoint URL for the Graph API.
protected String	getFacebookGraphVideoEndpointUrl()	Returns the base endpoint URL for the Graph API's video upload functionality.
JsonMapper	getJsonMapper()	Gets the JsonMapper used to convert Facebook JSON to Java objects.
String	getLoginDialogUrl(String appId, String redirectUri, ScopeBuilder scope, Parameter... parameters)	generates the login dialog url
String	getLogoutUrl(String next)	generates an logout url
WebRequestor	getWebRequestor()	Gets the WebRequestor used to talk to the Facebook API endpoints.
boolean	isHttpDeleteFallback()	returns if the fallback post method (true) is used or the http delete (false)
protected String	makeRequest(String endpoint, boolean executeAsPost, boolean executeAsDelete, List<BinaryAttachment> binaryAttachments, Body body, Parameter... parameters)	Coordinates the process of executing the API request GET/POST and processing the response we receive from the endpoint.
protected String	makeRequest(String endpoint, boolean executeAsPost, boolean executeAsDelete, List<BinaryAttachment> binaryAttachments, Parameter... parameters)
protected String	makeRequest(String endpoint, Parameter... parameters)	Coordinates the process of executing the API request GET/POST and processing the response we receive from the endpoint.
protected String	makeRequestAndProcessResponse(DefaultFacebookClient.Requestor requestor)
FacebookClient.AccessToken	obtainAppAccessToken(String appId, String appSecret)	Obtains an access token which can be used to perform Graph API operations on behalf of an application instead of a user.
String	obtainAppSecretProof(String accessToken, String appSecret)	Generates an appsecret_proof value.
FacebookClient.AccessToken	obtainDeviceAccessToken(String code)	Method to poll Facebook and fetch the Device Access Token.
FacebookClient.AccessToken	obtainExtendedAccessToken(String appId, String appSecret)	Convenience method which invokes FacebookClient.obtainExtendedAccessToken(String, String, String) with the current access token.
FacebookClient.AccessToken	obtainExtendedAccessToken(String appId, String appSecret, String accessToken)	Obtains an extended access token for the given existing, non-expired, short-lived access_token.
FacebookClient.AccessToken	obtainUserAccessToken(String appId, String appSecret, String redirectUri, String verificationCode)	Obtains an access token which can be used to perform Graph API operations on behalf of a user.
protected Parameter[]	parametersWithAdditionalParameter(Parameter parameter, Parameter... parameters)	Appends the given parameter to the given parameters array.
<T> T	parseSignedRequest(String signedRequest, String appSecret, Class<T> objectType)	Parses a signed request and verifies it against your App Secret.
<T> T	publish(String connection, Class<T> objectType, BinaryAttachment binaryAttachment, Parameter... parameters)	Performs a Graph API publish operation on the given connection and includes a file - a photo, for example - in the publish request, and mapping the result to an instance of objectType.
<T> T	publish(String connection, Class<T> objectType, Body body, Parameter... parameters)	Performs a Graph API publish operation on the given connection and includes special body in the publish request, and mapping the result to an instance of objectType.
<T> T	publish(String connection, Class<T> objectType, Parameter... parameters)	Performs a Graph API publish operation on the given connection, mapping the result to an instance of objectType.
<T> T	publish(String connection, Class<T> objectType, List<BinaryAttachment> binaryAttachments, Parameter... parameters)	Performs a Graph API publish operation on the given connection and includes some files - photos, for example - in the publish request, and mapping the result to an instance of objectType.
void	setFacebookEndpointUrls(FacebookEndpoints facebookEndpointUrls)
void	setFacebookExceptionGenerator(FacebookExceptionGenerator exceptionGenerator)	override the default facebook exception generator to provide a custom handling for the facebook error objects
void	setHeaderAuthorization(boolean accessTokenInHttpHeader)	Switch between access token in header and access token in query parameters (default)
void	setHttpDeleteFallback(boolean httpDeleteFallback)	Set to true if the facebook http delete fallback should be used.
protected String	toParameterString(boolean withJsonParameter, Parameter... parameters)	Generate the parameter string to be included in the Facebook API request.
protected String	toParameterString(Parameter... parameters)	Generate the parameter string to be included in the Facebook API request.
protected String	urlDecodeSignedRequestToken(String signedRequestToken)	Decodes a component of a signed request received from Facebook using FB's special URL-encoding strategy.
protected String	urlEncodedValueForParameterName(String name, String value)	Gets the URL-encoded version of the given value for the parameter named name.
protected void	verifyParameterLegality(Parameter... parameters)	Verifies that the provided parameter names don't collide with the ones we internally pass along to Facebook.
protected boolean	verifySignedRequest(String appSecret, String algorithm, String encodedPayload, byte[] signature)	Verifies that the signed request is really from Facebook.

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

CLIENT_ID

public static final String CLIENT_ID

Siehe auch:

• Konstantenfeldwerte

APP_ID

public static final String APP_ID

Siehe auch:

• Konstantenfeldwerte

APP_SECRET

public static final String APP_SECRET

Siehe auch:

• Konstantenfeldwerte

SCOPE

public static final String SCOPE

Siehe auch:

• Konstantenfeldwerte

CANNOT_EXTRACT_ACCESS_TOKEN_MESSAGE

public static final String CANNOT_EXTRACT_ACCESS_TOKEN_MESSAGE

Siehe auch:

• Konstantenfeldwerte

PARAM_CLIENT_SECRET

public static final String PARAM_CLIENT_SECRET

Siehe auch:

• Konstantenfeldwerte

CONNECTION

public static final String CONNECTION

Siehe auch:

• Konstantenfeldwerte

CONNECTION_TYPE

public static final String CONNECTION_TYPE

Siehe auch:

• Konstantenfeldwerte

ALGORITHM

public static final String ALGORITHM

Siehe auch:

• Konstantenfeldwerte

accessToken

protected String accessToken

Graph API access token.

IDS_PARAM_NAME

protected static final String IDS_PARAM_NAME

Reserved "multiple IDs" parameter name.

Siehe auch:

• Konstantenfeldwerte

apiVersion

protected Version apiVersion

Version of API endpoint.

httpDeleteFallback

protected boolean httpDeleteFallback

By default this is false, so real http DELETE is used

accessTokenInHeader

protected boolean accessTokenInHeader

webRequestor

protected WebRequestor webRequestor

Handles GETs and POSTs to the Facebook API endpoint.

jsonMapper

protected JsonMapper jsonMapper

Handles mapping Facebook response JSON to Java objects.

METHOD_PARAM_NAME

protected static final String METHOD_PARAM_NAME

Reserved method override parameter name.

Siehe auch:

• Konstantenfeldwerte

FORMAT_PARAM_NAME

protected static final String FORMAT_PARAM_NAME

Reserved "result format" parameter name.

Siehe auch:

• Konstantenfeldwerte

ACCESS_TOKEN_PARAM_NAME

protected static final String ACCESS_TOKEN_PARAM_NAME

Reserved access token parameter name.

Siehe auch:

• Konstantenfeldwerte

APP_SECRET_PROOF_PARAM_NAME

protected static final String APP_SECRET_PROOF_PARAM_NAME

Reserved application secret proof parameter name.

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

DefaultFacebookClient

protected DefaultFacebookClient()

DefaultFacebookClient

public DefaultFacebookClient(Version apiVersion)

Creates a Facebook Graph API client with the given apiVersion.

Parameter:

apiVersion - Version of the api endpoint

DefaultFacebookClient

public DefaultFacebookClient(String accessToken,
 Version apiVersion)

Creates a Facebook Graph API client with the given accessToken.

Parameter:

accessToken - A Facebook OAuth access token.

apiVersion - Version of the api endpoint

Seit:

1.6.14

DefaultFacebookClient

public DefaultFacebookClient(String accessToken,
 String appSecret,
 Version apiVersion)

Creates a Facebook Graph API client with the given accessToken.

Parameter:

accessToken - A Facebook OAuth access token.

appSecret - A Facebook application secret.

apiVersion - Version of the api endpoint

Seit:

1.6.14

DefaultFacebookClient

public DefaultFacebookClient(String accessToken,
 WebRequestor webRequestor,
 JsonMapper jsonMapper,
 Version apiVersion)

Creates a Facebook Graph API client with the given accessToken.

Parameter:

accessToken - A Facebook OAuth access token.

webRequestor - The WebRequestor implementation to use for sending requests to the API endpoint.

jsonMapper - The JsonMapper implementation to use for mapping API response JSON to Java objects.

apiVersion - Version of the api endpoint

Löst aus:

NullPointerException - If jsonMapper or webRequestor is null.

Seit:

1.6.14

DefaultFacebookClient

public DefaultFacebookClient(String accessToken,
 String appSecret,
 WebRequestor webRequestor,
 JsonMapper jsonMapper,
 Version apiVersion)

Creates a Facebook Graph API client with the given accessToken, webRequestor, and jsonMapper.

Parameter:

accessToken - A Facebook OAuth access token.

appSecret - A Facebook application secret.

webRequestor - The WebRequestor implementation to use for sending requests to the API endpoint.

jsonMapper - The JsonMapper implementation to use for mapping API response JSON to Java objects.

apiVersion - Version of the api endpoint

Löst aus:

NullPointerException - If jsonMapper or webRequestor is null.

Methodendetails

setHeaderAuthorization

public void setHeaderAuthorization(boolean accessTokenInHttpHeader)

Switch between access token in header and access token in query parameters (default)

Parameter:

accessTokenInHttpHeader - true use access token as header field, false use access token as query parameter (default)

setFacebookExceptionGenerator

public void setFacebookExceptionGenerator(FacebookExceptionGenerator exceptionGenerator)

override the default facebook exception generator to provide a custom handling for the facebook error objects

Parameter:

exceptionGenerator - the custom exception generator implementing the FacebookExceptionGenerator interface

getFacebookExceptionGenerator

public FacebookExceptionGenerator getFacebookExceptionGenerator()

fetch the current facebook exception generator implementing the FacebookExceptionGenerator interface

Gibt zurück:

the current facebook exception generator

deleteObject

public boolean deleteObject(String object,
 Parameter... parameters)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Performs a Graph API delete operation on the given object.

Angegeben von:

deleteObject in Schnittstelle FacebookClient

Parameter:

object - The ID of the object to delete.

parameters - URL parameters to include in the API call.

Gibt zurück:

true if Facebook indicated that the object was successfully deleted, false otherwise.

fetchConnection

public <T> Connection<T> fetchConnection(String connection,
 Class<T> connectionType,
 Parameter... parameters)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Fetches a Graph API Connection type, mapping the result to an instance of connectionType.

Angegeben von:

fetchConnection in Schnittstelle FacebookClient

Typparameter:

T - Java type to map to.

Parameter:

connection - The name of the connection, e.g. "me/feed".

connectionType - Connection type token.

parameters - URL parameters to include in the API call (optional).

Gibt zurück:

An instance of type connectionType which contains the requested Connection's data.

Siehe auch:

• FacebookClient.fetchConnection(java.lang.String, java.lang.Class, com.restfb.Parameter[])

fetchConnectionPage

public <T> Connection<T> fetchConnectionPage(String connectionPageUrl,
 Class<T> connectionType)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Fetches a previous/next page of a Graph API Connection type, mapping the result to an instance of connectionType.

Angegeben von:

fetchConnectionPage in Schnittstelle FacebookClient

Typparameter:

T - Java type to map to.

Parameter:

connectionPageUrl - The URL of the connection page to fetch, usually retrieved via Connection.getPreviousPageUrl() or Connection.getNextPageUrl().

connectionType - Connection type token.

Gibt zurück:

An instance of type connectionType which contains the requested Connection's data.

Siehe auch:

• FacebookClient.fetchConnectionPage(java.lang.String, java.lang.Class)

fetchObject

public <T> T fetchObject(String object,
 Class<T> objectType,
 Parameter... parameters)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Fetches a single Graph API object, mapping the result to an instance of objectType.

Angegeben von:

fetchObject in Schnittstelle FacebookClient

Typparameter:

T - Java type to map to.

Parameter:

object - ID of the object to fetch, e.g. "me".

objectType - Object type token.

parameters - URL parameters to include in the API call (optional).

Gibt zurück:

An instance of type objectType which contains the requested object's data.

Siehe auch:

• FacebookClient.fetchObject(java.lang.String, java.lang.Class, com.restfb.Parameter[])

createClientWithAccessToken

public FacebookClient createClientWithAccessToken(String accessToken)

Beschreibung aus Schnittstelle kopiert: FacebookClient

creates a new FacebookClient from a old one. App secret and and api version are taken from the original client.

Angegeben von:

createClientWithAccessToken in Schnittstelle FacebookClient

Parameter:

accessToken - this accesstoken is used for the new client

Gibt zurück:

a new Facebookclient

fetchObjects

public <T> T fetchObjects(List<String> ids,
 Class<T> objectType,
 Parameter... parameters)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Fetches multiple Graph API objects in a single call, mapping the results to an instance of objectType.

You'll need to write your own container type (objectType) to hold the results. See http://restfb.com for an example of how to do this.

Angegeben von:

fetchObjects in Schnittstelle FacebookClient

Typparameter:

T - Java type to map to.

Parameter:

ids - IDs of the objects to fetch, e.g. "me", "arjun".

objectType - Object type token.

parameters - URL parameters to include in the API call (optional).

Gibt zurück:

An instance of type objectType which contains the requested objects' data.

Siehe auch:

• FacebookClient.fetchObjects(java.util.List, java.lang.Class, com.restfb.Parameter[])

publish

public <T> T publish(String connection,
 Class<T> objectType,
 List<BinaryAttachment> binaryAttachments,
 Parameter... parameters)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Performs a Graph API publish operation on the given connection and includes some files - photos, for example - in the publish request, and mapping the result to an instance of objectType.

Angegeben von:

publish in Schnittstelle FacebookClient

Typparameter:

T - Java type to map to.

Parameter:

connection - The Connection to publish to.

objectType - Object type token.

binaryAttachments - The files to include in the publish request.

parameters - URL parameters to include in the API call.

Gibt zurück:

An instance of type objectType which contains the Facebook response to your publish request.

Siehe auch:

• FacebookClient.publish(java.lang.String, java.lang.Class, com.restfb.BinaryAttachment, com.restfb.Parameter[])

publish

public <T> T publish(String connection,
 Class<T> objectType,
 BinaryAttachment binaryAttachment,
 Parameter... parameters)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Performs a Graph API publish operation on the given connection and includes a file - a photo, for example - in the publish request, and mapping the result to an instance of objectType.

Angegeben von:

publish in Schnittstelle FacebookClient

Typparameter:

T - Java type to map to.

Parameter:

connection - The Connection to publish to.

objectType - Object type token.

binaryAttachment - The file to include in the publish request.

parameters - URL parameters to include in the API call.

Gibt zurück:

An instance of type objectType which contains the Facebook response to your publish request.

Siehe auch:

• FacebookClient.publish(java.lang.String, java.lang.Class, com.restfb.BinaryAttachment, com.restfb.Parameter[])

publish

public <T> T publish(String connection,
 Class<T> objectType,
 Parameter... parameters)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Performs a Graph API publish operation on the given connection, mapping the result to an instance of objectType.

Angegeben von:

publish in Schnittstelle FacebookClient

Typparameter:

T - Java type to map to.

Parameter:

connection - The Connection to publish to.

objectType - Object type token.

parameters - URL parameters to include in the API call.

Gibt zurück:

An instance of type objectType which contains the Facebook response to your publish request.

Siehe auch:

• FacebookClient.publish(java.lang.String, java.lang.Class, com.restfb.Parameter[])

publish

public <T> T publish(String connection,
 Class<T> objectType,
 Body body,
 Parameter... parameters)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Performs a Graph API publish operation on the given connection and includes special body in the publish request, and mapping the result to an instance of objectType.

Angegeben von:

publish in Schnittstelle FacebookClient

Typparameter:

T - Java type to map to.

Parameter:

connection - The Connection to publish to.

objectType - Object type token.

body - The body used in the POST request.

parameters - URL parameters to include in the API call.

Gibt zurück:

An instance of type objectType which contains the Facebook response to your publish request.

getLogoutUrl

public String getLogoutUrl(String next)

Beschreibung aus Schnittstelle kopiert: FacebookClient

generates an logout url

Angegeben von:

getLogoutUrl in Schnittstelle FacebookClient

Parameter:

next - may be null, url the webpage should redirect after logout

Gibt zurück:

the logout url

executeBatch

public List<BatchResponse> executeBatch(BatchRequest... batchRequests)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Executes operations as a batch using the Batch API.

Angegeben von:

executeBatch in Schnittstelle FacebookClient

Parameter:

batchRequests - The operations to execute.

Gibt zurück:

The execution results in the order in which the requests were specified.

Siehe auch:

• FacebookClient.executeBatch(com.restfb.batch.BatchRequest[])

executeBatch

public List<BatchResponse> executeBatch(List<BatchRequest> batchRequests)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Executes operations as a batch using the Batch API.

Angegeben von:

executeBatch in Schnittstelle FacebookClient

Parameter:

batchRequests - The operations to execute.

Gibt zurück:

The execution results in the order in which the requests were specified.

Siehe auch:

• FacebookClient.executeBatch(java.util.List)

executeBatch

public List<BatchResponse> executeBatch(List<BatchRequest> batchRequests,
 List<BinaryAttachment> binaryAttachments)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Executes operations as a batch with binary attachments using the Batch API.

Angegeben von:

executeBatch in Schnittstelle FacebookClient

Parameter:

batchRequests - The operations to execute.

binaryAttachments - Binary attachments referenced by the batch requests.

Gibt zurück:

The execution results in the order in which the requests were specified.

Siehe auch:

• FacebookClient.executeBatch(java.util.List, java.util.List)

convertSessionKeysToAccessTokens

public List<FacebookClient.AccessToken> convertSessionKeysToAccessTokens(String appId,
 String secretKey,
 String... sessionKeys)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Converts an arbitrary number of sessionKeys to OAuth access tokens.

See the Facebook Platform Upgrade Guide for details on how this process works and why you should convert your application's session keys if you haven't already.

Angegeben von:

convertSessionKeysToAccessTokens in Schnittstelle FacebookClient

Parameter:

appId - A Facebook application ID.

secretKey - A Facebook application secret key.

sessionKeys - The Old REST API session keys to be converted to OAuth access tokens.

Gibt zurück:

A list of access tokens ordered to correspond to the sessionKeys argument list.

Siehe auch:

• FacebookClient.convertSessionKeysToAccessTokens(java.lang.String, java.lang.String, java.lang.String[])

obtainAppAccessToken

public FacebookClient.AccessToken obtainAppAccessToken(String appId,
 String appSecret)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Obtains an access token which can be used to perform Graph API operations on behalf of an application instead of a user.

See Facebook's authenticating as an app documentation.

Angegeben von:

obtainAppAccessToken in Schnittstelle FacebookClient

Parameter:

appId - The ID of the app for which you'd like to obtain an access token.

appSecret - The secret for the app for which you'd like to obtain an access token.

Gibt zurück:

The access token for the application identified by appId and appSecret.

Siehe auch:

• FacebookClient.obtainAppAccessToken(java.lang.String, java.lang.String)

fetchDeviceCode

public DeviceCode fetchDeviceCode(ScopeBuilder scope)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Method to initialize the device access token generation. You receive a DeviceCode instance and have to show the user the DeviceCode.getVerificationUri() and the DeviceCode.getUserCode(). The user have to enter the user code at the verification url. Save the DeviceCode.getCode() to use it later, when polling Facebook with the FacebookClient.obtainDeviceAccessToken(java.lang.String) method.

Angegeben von:

fetchDeviceCode in Schnittstelle FacebookClient

Parameter:

scope - List of Permissions to request from the person using your app.

Gibt zurück:

Instance of DeviceCode including the information to obtain the Device access token

obtainDeviceAccessToken

public FacebookClient.AccessToken obtainDeviceAccessToken(String code)
                                                   throws FacebookDeviceTokenCodeExpiredException,
FacebookDeviceTokenPendingException,
FacebookDeviceTokenDeclinedException,
FacebookDeviceTokenSlowdownException

Beschreibung aus Schnittstelle kopiert: FacebookClient

Method to poll Facebook and fetch the Device Access Token. You have to use this method to check if the user confirms the authorization. FacebookOAuthException can be thrown if the authorization is declined or still pending.

Angegeben von:

obtainDeviceAccessToken in Schnittstelle FacebookClient

Parameter:

code - The device

Gibt zurück:

An extended access token for the given FacebookClient.AccessToken.

Löst aus:

FacebookDeviceTokenCodeExpiredException - the DeviceCode.getCode() is expired, please fetch a new DeviceCode.

FacebookDeviceTokenPendingException - the user has not finished the authorisation process, yet. Please poll again later.

FacebookDeviceTokenDeclinedException - the user declined the authorisation. You have to handle this problem.

FacebookDeviceTokenSlowdownException - you tried too often to fetch the device access token. You have to use a larger interval

obtainUserAccessToken

public FacebookClient.AccessToken obtainUserAccessToken(String appId,
 String appSecret,
 String redirectUri,
 String verificationCode)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Obtains an access token which can be used to perform Graph API operations on behalf of a user.

See Access Tokens.

Angegeben von:

obtainUserAccessToken in Schnittstelle FacebookClient

Parameter:

appId - The ID of the app for which you'd like to obtain an access token.

appSecret - The secret for the app for which you'd like to obtain an access token.

redirectUri - The redirect URI which was used to obtain the verificationCode.

verificationCode - The verification code in the Graph API callback to the redirect URI.

Gibt zurück:

The access token for the user identified by appId, appSecret, redirectUri and verificationCode.

Siehe auch:

• FacebookClient.obtainUserAccessToken(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

obtainExtendedAccessToken

public FacebookClient.AccessToken obtainExtendedAccessToken(String appId,
 String appSecret)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Convenience method which invokes FacebookClient.obtainExtendedAccessToken(String, String, String) with the current access token.

Angegeben von:

obtainExtendedAccessToken in Schnittstelle FacebookClient

Parameter:

appId - The ID of the app for which you'd like to obtain an extended access token.

appSecret - The secret for the app for which you'd like to obtain an extended access token.

Gibt zurück:

An extended access token for the given accessToken.

Siehe auch:

• FacebookClient.obtainExtendedAccessToken(java.lang.String, java.lang.String)

obtainExtendedAccessToken

public FacebookClient.AccessToken obtainExtendedAccessToken(String appId,
 String appSecret,
 String accessToken)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Obtains an extended access token for the given existing, non-expired, short-lived access_token.

See Facebook's extend access token documentation.

Angegeben von:

obtainExtendedAccessToken in Schnittstelle FacebookClient

Parameter:

appId - The ID of the app for which you'd like to obtain an extended access token.

appSecret - The secret for the app for which you'd like to obtain an extended access token.

accessToken - The non-expired, short-lived access token to extend.

Gibt zurück:

An extended access token for the given accessToken.

Siehe auch:

• FacebookClient.obtainExtendedAccessToken(java.lang.String, java.lang.String, java.lang.String)

parseSignedRequest

public <T> T parseSignedRequest(String signedRequest,
 String appSecret,
 Class<T> objectType)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Parses a signed request and verifies it against your App Secret.

See Facebook's signed request documentation.

Angegeben von:

parseSignedRequest in Schnittstelle FacebookClient

Typparameter:

T - class of objectType

Parameter:

signedRequest - The signed request to parse.

appSecret - The secret for the app that can read this signed request.

objectType - Object type token.

Gibt zurück:

An instance of type objectType which contains the decoded object embedded within signedRequest.

urlDecodeSignedRequestToken

protected String urlDecodeSignedRequestToken(String signedRequestToken)

Decodes a component of a signed request received from Facebook using FB's special URL-encoding strategy.

Parameter:

signedRequestToken - Token to decode.

Gibt zurück:

The decoded token.

getLoginDialogUrl

public String getLoginDialogUrl(String appId,
 String redirectUri,
 ScopeBuilder scope,
 Parameter... parameters)

Beschreibung aus Schnittstelle kopiert: FacebookClient

generates the login dialog url

Angegeben von:

getLoginDialogUrl in Schnittstelle FacebookClient

Parameter:

appId - The ID of your app, found in your app's dashboard.

redirectUri - The URL that you want to redirect the person logging in back to. This URL will capture the response from the Login Dialog. If you are using this in a webview within a desktop app, this must be set to https://www.facebook.com/connect/login_success.html.

scope - List of Permissions to request from the person using your app.

parameters - List of additional parameters

Gibt zurück:

the login dialog url

verifySignedRequest

protected boolean verifySignedRequest(String appSecret,
 String algorithm,
 String encodedPayload,
 byte[] signature)

Verifies that the signed request is really from Facebook.

Parameter:

appSecret - The secret for the app that can verify this signed request.

algorithm - Signature algorithm specified by FB in the decoded payload.

encodedPayload - The encoded payload used to generate a signature for comparison against the provided signature.

signature - The decoded signature extracted from the signed request. Compared against a signature generated from encodedPayload.

Gibt zurück:

true if the signed request is verified, false if not.

debugToken

public FacebookClient.DebugTokenInfo debugToken(String inputToken)

Beschreibung aus Schnittstelle kopiert: FacebookClient

When working with access tokens, you may need to check what information is associated with them, such as its user or expiry. To get this information you can use the debug tool in the developer site, or you can use this function.

You must instantiate your FacebookClient using your App Access Token, or a valid User Access Token from a developer of the app.

Note that if your app is set to Native/Desktop in the Advanced settings of your App Dashboard, the underlying GraphAPI endpoint will not work with your app token unless you change the "App Secret in Client" setting to NO. If you do not see this setting, make sure your "App Type" is set to Native/Desktop and then press the save button at the bottom of the page. This will not affect apps set to Web.

The response of the API call is a JSON array containing data and a map of fields. For example:

 
 {
     "data": {
         "app_id": 138483919580948, 
         "application": "Social Cafe", 
         "expires_at": 1352419328, 
         "is_valid": true, 
         "issued_at": 1347235328, 
         "metadata": {
             "sso": "iphone-safari"
         }, 
         "scopes": [
             "email", 
             "publish_actions"
         ], 
         "user_id": 1207059
     }
 }
 
 

Note that the issued_at field is not returned for short-lived access tokens.

See Debugging an Access Token

Angegeben von:

debugToken in Schnittstelle FacebookClient

Parameter:

inputToken - The Access Token to debug.

Gibt zurück:

A JsonObject containing the debug information for the accessToken.

Siehe auch:

• FacebookClient.debugToken(java.lang.String)

getJsonMapper

public JsonMapper getJsonMapper()

Beschreibung aus Schnittstelle kopiert: FacebookClient

Gets the JsonMapper used to convert Facebook JSON to Java objects.

Angegeben von:

getJsonMapper in Schnittstelle FacebookClient

Gibt zurück:

The JsonMapper used to convert Facebook JSON to Java objects.

Siehe auch:

• FacebookClient.getJsonMapper()

getWebRequestor

public WebRequestor getWebRequestor()

Beschreibung aus Schnittstelle kopiert: FacebookClient

Gets the WebRequestor used to talk to the Facebook API endpoints.

Angegeben von:

getWebRequestor in Schnittstelle FacebookClient

Gibt zurück:

The WebRequestor used to talk to the Facebook API endpoints.

Siehe auch:

• FacebookClient.getWebRequestor()

makeRequest

protected String makeRequest(String endpoint,
 Parameter... parameters)

Coordinates the process of executing the API request GET/POST and processing the response we receive from the endpoint.

Parameter:

endpoint - Facebook Graph API endpoint.

parameters - Arbitrary number of parameters to send along to Facebook as part of the API call.

Gibt zurück:

The JSON returned by Facebook for the API call.

Löst aus:

FacebookException - If an error occurs while making the Facebook API POST or processing the response.

makeRequest

protected String makeRequest(String endpoint,
 boolean executeAsPost,
 boolean executeAsDelete,
 List<BinaryAttachment> binaryAttachments,
 Parameter... parameters)

makeRequest

protected String makeRequest(String endpoint,
 boolean executeAsPost,
 boolean executeAsDelete,
 List<BinaryAttachment> binaryAttachments,
 Body body,
 Parameter... parameters)

Coordinates the process of executing the API request GET/POST and processing the response we receive from the endpoint.

Parameter:

endpoint - Facebook Graph API endpoint.

executeAsPost - true to execute the web request as a POST, false to execute as a GET.

executeAsDelete - true to add a special 'treat this request as a DELETE' parameter.

binaryAttachments - A list of binary files to include in a POST request. Pass null if no attachment should be sent.

parameters - Arbitrary number of parameters to send along to Facebook as part of the API call.

Gibt zurück:

The JSON returned by Facebook for the API call.

Löst aus:

FacebookException - If an error occurs while making the Facebook API POST or processing the response.

obtainAppSecretProof

public String obtainAppSecretProof(String accessToken,
 String appSecret)

Beschreibung aus Schnittstelle kopiert: FacebookClient

Generates an appsecret_proof value.

See Facebook's 'securing requests' documentation for more info.

Angegeben von:

obtainAppSecretProof in Schnittstelle FacebookClient

Parameter:

accessToken - The access token required to generate the appsecret_proof value.

appSecret - The secret for the app for which you'd like to generate the appsecret_proof value.

Gibt zurück:

A hex-encoded SHA256 hash as a String.

Siehe auch:

• FacebookClient.obtainAppSecretProof(java.lang.String, java.lang.String)

isHttpDeleteFallback

public boolean isHttpDeleteFallback()

returns if the fallback post method (true) is used or the http delete (false)

Gibt zurück:

true if POST is used instead of HTTP DELETE (default)

setHttpDeleteFallback

public void setHttpDeleteFallback(boolean httpDeleteFallback)

Set to true if the facebook http delete fallback should be used. Facebook allows to use the http POST with the parameter "method=delete" to override the post and use delete instead. This feature allow http client that do not support the whole http method set, to delete objects from facebook

Parameter:

httpDeleteFallback - true if the the http Delete Fallback is used

makeRequestAndProcessResponse

protected String makeRequestAndProcessResponse(DefaultFacebookClient.Requestor requestor)

toParameterString

protected String toParameterString(Parameter... parameters)

Generate the parameter string to be included in the Facebook API request.

Parameter:

parameters - Arbitrary number of extra parameters to include in the request.

Gibt zurück:

The parameter string to include in the Facebook API request.

Löst aus:

FacebookJsonMappingException - If an error occurs when building the parameter string.

toParameterString

protected String toParameterString(boolean withJsonParameter,
 Parameter... parameters)

Generate the parameter string to be included in the Facebook API request.

Parameter:

withJsonParameter - add additional parameter format with type json

parameters - Arbitrary number of extra parameters to include in the request.

Gibt zurück:

The parameter string to include in the Facebook API request.

Löst aus:

FacebookJsonMappingException - If an error occurs when building the parameter string.

createEndpointForApiCall

protected String createEndpointForApiCall(String apiCall,
 boolean hasAttachment)

Given an api call (e.g. "me" or "fql.query"), returns the correct FB API endpoint to use.

Useful for returning the read-only API endpoint where possible.

Parameter:

apiCall - The FB API call (Graph or Old REST API) for which we'd like an endpoint.

hasAttachment - Are we including a multipart file when making this API call?

Gibt zurück:

An absolute endpoint URL to communicate with.

Siehe auch:

• BaseFacebookClient.createEndpointForApiCall(java.lang.String,boolean)

getFacebookGraphEndpointUrl

protected String getFacebookGraphEndpointUrl()

Returns the base endpoint URL for the Graph API.

Gibt zurück:

The base endpoint URL for the Graph API.

getFacebookGraphVideoEndpointUrl

protected String getFacebookGraphVideoEndpointUrl()

Returns the base endpoint URL for the Graph API's video upload functionality.

Gibt zurück:

The base endpoint URL for the Graph API's video upload functionality.

Seit:

1.6.5

getFacebookEndpointUrls

public FacebookEndpoints getFacebookEndpointUrls()

setFacebookEndpointUrls

public void setFacebookEndpointUrls(FacebookEndpoints facebookEndpointUrls)

parametersWithAdditionalParameter

protected Parameter[] parametersWithAdditionalParameter(Parameter parameter,
 Parameter... parameters)

Appends the given parameter to the given parameters array.

Parameter:

parameter - The parameter value to append.

parameters - The parameters to which the given parameter is appended.

Gibt zurück:

A new array which contains both parameter and parameters.

urlEncodedValueForParameterName

protected String urlEncodedValueForParameterName(String name,
 String value)

Gets the URL-encoded version of the given value for the parameter named name.

Includes special-case handling for access token parameters where we check if the token is already URL-encoded - if so, we don't encode again. All other parameter types are always URL-encoded.

Parameter:

name - The name of the parameter whose value should be URL-encoded and returned.

value - The value of the parameter which should be URL-encoded and returned.

Gibt zurück:

The URL-encoded version of the given value.

verifyParameterLegality

protected void verifyParameterLegality(Parameter... parameters)

Verifies that the provided parameter names don't collide with the ones we internally pass along to Facebook.

Parameter:

parameters - The parameters to check.

Löst aus:

IllegalArgumentException - If there's a parameter name collision.