com.facebook.widget

Class FacebookDialog

java.lang.Object

com.facebook.widget.FacebookDialog

public class FacebookDialog
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FacebookDialog.Callback Defines a callback interface that will be called when the user completes interacting with a Facebook dialog, or if an error occurs.
static class	FacebookDialog.MessageDialogBuilder Provides a builder which can construct a FacebookDialog instance suitable for presenting the native Message dialog.
static class	FacebookDialog.MessageDialogFeature Defines a set of features that may be supported by the native Message dialog exposed by the Facebook Messenger application.
static class	FacebookDialog.OpenGraphActionDialogBuilder Provides a builder which can construct a FacebookDialog instance suitable for presenting the native Open Graph action publish dialog.
static class	FacebookDialog.OpenGraphActionDialogFeature Defines a set of features that may be supported by the native Open Graph dialogs exposed by the Facebook application.
static class	FacebookDialog.OpenGraphMessageDialogBuilder Provides a builder which can construct a FacebookDialog instance suitable for presenting the native Open Graph action message dialog.
static class	FacebookDialog.OpenGraphMessageDialogFeature Defines a set of features that may be supported by the native Open Graph Message dialogs exposed by the Facebook application.
static class	FacebookDialog.PendingCall Encapsulates information about a call being made to the Facebook application for Android.
static class	FacebookDialog.PhotoMessageDialogBuilder Provides a builder which can construct a FacebookDialog instance suitable for presenting the native Message dialog for sharing photos.
static class	FacebookDialog.PhotoShareDialogBuilder Provides a builder which can construct a FacebookDialog instance suitable for presenting the native Share dialog for sharing photos.
static class	FacebookDialog.ShareDialogBuilder Provides a builder which can construct a FacebookDialog instance suitable for presenting the native Share dialog.
static class	FacebookDialog.ShareDialogFeature Defines a set of features that may be supported by the native Share dialog exposed by the Facebook application.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLETION_GESTURE_CANCEL

Method Summary

Modifier and Type	Method and Description
static boolean	canPresentMessageDialog(android.content.Context context, FacebookDialog.MessageDialogFeature... features) Determines whether the version of the Facebook application installed on the user's device is recent enough to support specific features of the native Message dialog, which in turn may be used to determine which UI, etc., to present to the user.
static boolean	canPresentOpenGraphActionDialog(android.content.Context context, FacebookDialog.OpenGraphActionDialogFeature... features) Determines whether the version of the Facebook application installed on the user's device is recent enough to support specific features of the native Open Graph action dialog, which in turn may be used to determine which UI, etc., to present to the user.
static boolean	canPresentOpenGraphMessageDialog(android.content.Context context, FacebookDialog.OpenGraphMessageDialogFeature... features) Determines whether the version of the Facebook application installed on the user's device is recent enough to support specific features of the native Open Graph Message dialog, which in turn may be used to determine which UI, etc., to present to the user.
static boolean	canPresentShareDialog(android.content.Context context, FacebookDialog.ShareDialogFeature... features) Determines whether the version of the Facebook application installed on the user's device is recent enough to support specific features of the native Share dialog, which in turn may be used to determine which UI, etc., to present to the user.
static String	getNativeDialogCompletionGesture(android.os.Bundle result) Returns the gesture with which the user completed the native dialog.
static boolean	getNativeDialogDidComplete(android.os.Bundle result) Determines whether the native dialog completed normally (without error or exception).
static String	getNativeDialogPostId(android.os.Bundle result) Returns the id of the published post.
static boolean	handleActivityResult(android.content.Context context, FacebookDialog.PendingCall appCall, int requestCode, android.content.Intent data, FacebookDialog.Callback callback) Parses the results of a dialog activity and calls the appropriate method on the provided Callback.
FacebookDialog.PendingCall	present() Launches an activity in the Facebook application to present the desired dialog.

Methods inherited from class java.lang.Object

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

Field Detail

COMPLETION_GESTURE_CANCEL

public static final String COMPLETION_GESTURE_CANCEL

See Also:

Constant Field Values

Method Detail

getNativeDialogDidComplete

public static boolean getNativeDialogDidComplete(android.os.Bundle result)

Determines whether the native dialog completed normally (without error or exception).

Parameters:

result - the bundle passed back to onActivityResult

Returns:

true if the native dialog completed normally

getNativeDialogCompletionGesture

public static String getNativeDialogCompletionGesture(android.os.Bundle result)

Returns the gesture with which the user completed the native dialog. This is only returned if the user has previously authorized the calling app with basic permissions.

Parameters:

result - the bundle passed back to onActivityResult

Returns:

"post" or "cancel" as the completion gesture

getNativeDialogPostId

public static String getNativeDialogPostId(android.os.Bundle result)

Returns the id of the published post. This is only returned if the user has previously given the app publish permissions.

Parameters:

result - the bundle passed back to onActivityResult

Returns:

the id of the published post

present

public FacebookDialog.PendingCall present()

Launches an activity in the Facebook application to present the desired dialog. This method returns a PendingCall that contains a unique ID associated with this call to the Facebook application. In general, a calling Activity should use UiLifecycleHelper to handle incoming activity results, in order to ensure proper processing of the results from this dialog.

Returns:

a PendingCall containing the unique call ID corresponding to this call to the Facebook application

handleActivityResult

public static boolean handleActivityResult(android.content.Context context,
                                           FacebookDialog.PendingCall appCall,
                                           int requestCode,
                                           android.content.Intent data,
                                           FacebookDialog.Callback callback)

Parses the results of a dialog activity and calls the appropriate method on the provided Callback.

Parameters:

context - the Context that is handling the activity result

appCall - an PendingCall containing the call ID and original Intent used to launch the dialog

requestCode - the request code for the activity result

data - the result Intent

callback - a callback to call after parsing the results

Returns:

true if the activity result was handled, false if not

canPresentShareDialog

public static boolean canPresentShareDialog(android.content.Context context,
                                            FacebookDialog.ShareDialogFeature... features)

Determines whether the version of the Facebook application installed on the user's device is recent enough to support specific features of the native Share dialog, which in turn may be used to determine which UI, etc., to present to the user.

Parameters:

context - the calling Context

features - zero or more features to check for; FacebookDialog.ShareDialogFeature.SHARE_DIALOG is implicitly checked if not explicitly specified

Returns:

true if all of the specified features are supported by the currently installed version of the Facebook application; false if any of the features are not supported

canPresentMessageDialog

public static boolean canPresentMessageDialog(android.content.Context context,
                                              FacebookDialog.MessageDialogFeature... features)

Determines whether the version of the Facebook application installed on the user's device is recent enough to support specific features of the native Message dialog, which in turn may be used to determine which UI, etc., to present to the user.

Parameters:

context - the calling Context

features - zero or more features to check for; FacebookDialog.MessageDialogFeature.MESSAGE_DIALOG is implicitly checked if not explicitly specified

Returns:

true if all of the specified features are supported by the currently installed version of the Facebook application; false if any of the features are not supported

canPresentOpenGraphActionDialog

public static boolean canPresentOpenGraphActionDialog(android.content.Context context,
                                                      FacebookDialog.OpenGraphActionDialogFeature... features)

Determines whether the version of the Facebook application installed on the user's device is recent enough to support specific features of the native Open Graph action dialog, which in turn may be used to determine which UI, etc., to present to the user.

Parameters:

context - the calling Context

features - zero or more features to check for; FacebookDialog.OpenGraphActionDialogFeature.OG_ACTION_DIALOG is implicitly checked if not explicitly specified

Returns:

true if all of the specified features are supported by the currently installed version of the Facebook application; false if any of the features are not supported

canPresentOpenGraphMessageDialog

public static boolean canPresentOpenGraphMessageDialog(android.content.Context context,
                                                       FacebookDialog.OpenGraphMessageDialogFeature... features)

Determines whether the version of the Facebook application installed on the user's device is recent enough to support specific features of the native Open Graph Message dialog, which in turn may be used to determine which UI, etc., to present to the user.

Parameters:

context - the calling Context

features - zero or more features to check for; FacebookDialog.OpenGraphMessageDialogFeature.OG_MESSAGE_DIALOG is implicitly checked if not explicitly specified

Returns:

true if all of the specified features are supported by the currently installed version of the Facebook application; false if any of the features are not supported