A more recent version of this class is available. Check out the latest version.
Provides a builder which can construct a FacebookDialog instance suitable for presenting the native Open Graph action publish dialog. This builder allows the caller to specify binary images for both the action and any Open Graph objects to be created prior to publishing the action. This builder will throw an exception if the Facebook application is not installed, so it should only be used if FacebookDialog.canPresentOpenGraphActionDialog(android.content.Context, com.facebook.widget.FacebookDialog.OpenGraphActionDialogFeature...) indicates the capability is available.
| Extends: | Object |
| Package: | widget |
FacebookDialog.OpenGraphDialogBuilderBase(Activity, OpenGraphAction, String, String)Constructor.
public FacebookDialog.OpenGraphDialogBuilderBase(Activity activity, OpenGraphAction action, String actionType, String previewPropertyName) | Parameter | Description |
|---|---|
activity | The Activity which is presenting the native Open Graph action publish dialog; must not be null |
action | The Open Graph action to be published, which must contain a reference to at least one Open Graph object with the property name specified by setPreviewPropertyName; the action must have had its type specified via the OpenGraphAction.setType(String) method |
actionType | The type of the Open Graph action to be published, which should be the namespace-qualified name of the action type (e.g., "myappnamespace:myactiontype"); this will override the type of the action passed in. |
previewPropertyName | The name of a property on the Open Graph action that contains the Open Graph object which will be displayed as a preview to the user |
FacebookDialog.OpenGraphDialogBuilderBase(Activity, OpenGraphAction, String)Constructor.
public FacebookDialog.OpenGraphDialogBuilderBase(Activity activity, OpenGraphAction action, String previewPropertyName) | Parameter | Description |
|---|---|
activity | The Activity which is presenting the native Open Graph action publish dialog; must not be null |
action | The Open Graph action to be published, which must contain a reference to at least one Open Graph object with the property name specified by setPreviewPropertyName; the action must have had its type specified via the OpenGraphAction.setType(String) method |
previewPropertyName | The name of a property on the Open Graph action that contains the Open Graph object which will be displayed as a preview to the user |
FacebookDialog.OpenGraphActionDialogBuilder(Activity, OpenGraphAction, String, String)Constructor.
public FacebookDialog.OpenGraphActionDialogBuilder(Activity activity, OpenGraphAction action, String actionType, String previewPropertyName) | Parameter | Description |
|---|---|
activity | The Activity which is presenting the native Open Graph action publish dialog; must not be null |
action | The Open Graph action to be published, which must contain a reference to at least one Open Graph object with the property name specified by setPreviewPropertyName; the action must have had its type specified via the OpenGraphAction.setType(String) method |
actionType | The type of the Open Graph action to be published, which should be the namespace-qualified name of the action type (e.g., "myappnamespace:myactiontype"); this will override the type of the action passed in. |
previewPropertyName | The name of a property on the Open Graph action that contains the Open Graph object which will be displayed as a preview to the user |
FacebookDialog.OpenGraphActionDialogBuilder(Activity, OpenGraphAction, String)Constructor.
public FacebookDialog.OpenGraphActionDialogBuilder(Activity activity, OpenGraphAction action, String previewPropertyName) | Parameter | Description |
|---|---|
activity | The Activity which is presenting the native Open Graph action publish dialog; must not be null |
action | The Open Graph action to be published, which must contain a reference to at least one Open Graph object with the property name specified by setPreviewPropertyName; the action must have had its type specified via the OpenGraphAction.setType(String) method |
previewPropertyName | The name of a property on the Open Graph action that contains the Open Graph object which will be displayed as a preview to the user |
setRequestCode(int)Sets the request code that will be passed to handleActivityResult when this activity completes; the default is NativeProtocol.DIALOG_REQUEST_CODE.
public Builder setRequestCode(int requestCode) | Parameter | Description |
|---|---|
requestCode | The request code |
setApplicationName(String)Sets the name of the application to be displayed in the dialog. If provided, this optimizes the user experience as a preview of a shared item, etc., can be displayed sooner.
public Builder setApplicationName(String applicationName) | Parameter | Description |
|---|---|
applicationName | The name of the Facebook application |
setFragment(Fragment)Sets the fragment that should launch the dialog. This allows the dialog to be launched from a Fragment, and will allow the fragment to receive the onActivityResult.onActivityResult(int, int, android.content.Intent) call rather than the Activity.
public Builder setFragment(Fragment fragment) | Parameter | Description |
|---|---|
fragment | The fragment that contains this control |
build()Constructs a FacebookDialog with an Intent that is correctly populated to present the dialog within the Facebook application.
public FacebookDialog build() canPresent()Determines whether the native dialog can be presented (i.e., whether the required version of the Facebook application is installed on the device, and whether the installed version supports all of the parameters specified for the dialog).
public boolean canPresent() addImageAttachments(Collection)protected List addImageAttachments(Collection bitmaps) | Parameter | Description |
|---|---|
bitmaps |
addImageAttachmentFiles(Collection)protected List addImageAttachmentFiles(Collection bitmapFiles) | Parameter | Description |
|---|---|
bitmapFiles |
addImageAttachment(String, Bitmap)protected Builder addImageAttachment(String imageName, Bitmap bitmap) | Parameter | Description |
|---|---|
imageName | |
bitmap |
addImageAttachment(String, File)protected Builder addImageAttachment(String imageName, File attachment) | Parameter | Description |
|---|---|
imageName | |
attachment |
setDataErrorsFatal(boolean)Sets whether errors encountered during previewing the shared item should be considered fatal and cause the dialog to return an error
public OpenGraphDialogBuilderBase setDataErrorsFatal(boolean dataErrorsFatal) | Parameter | Description |
|---|---|
dataErrorsFatal | True if data errors should be fatal; false if not |
setImageAttachmentsForAction(List)Specifies a list of images for the Open Graph action that should be uploaded prior to publishing the action. The action must already have been set prior to calling this method. This method will generate unique names for the image attachments and update the action to refer to these attachments. Note that calling setAction again after calling this method will not clear the image attachments already set, but the new action will have no reference to the existing attachments. The images will not be marked as being user-generated.
In order for the images to be provided to the Facebook application as part of the app call, the NativeAppCallContentProvider must be specified correctly in the application's AndroidManifest.xml.
public OpenGraphDialogBuilderBase setImageAttachmentsForAction(List bitmaps) | Parameter | Description |
|---|---|
bitmaps | A list of Bitmaps to be uploaded and attached to the Open Graph action |
setImageAttachmentsForAction(List, boolean)Specifies a list of images for the Open Graph action that should be uploaded prior to publishing the action. The action must already have been set prior to calling this method. This method will generate unique names for the image attachments and update the action to refer to these attachments. Note that calling setAction again after calling this method will not clear the image attachments already set, but the new action will have no reference to the existing attachments. The images may be marked as being user-generated -- refer to this article for more information.
In order for the images to be provided to the Facebook application as part of the app call, the NativeAppCallContentProvider must be specified correctly in the application's AndroidManifest.xml.
public OpenGraphDialogBuilderBase setImageAttachmentsForAction(List bitmaps, boolean isUserGenerated) | Parameter | Description |
|---|---|
bitmaps | A list of Bitmaps to be uploaded and attached to the Open Graph action |
isUserGenerated | If true, specifies that the user_generated flag should be set for these images |
setImageAttachmentFilesForAction(List)Specifies a list of images for the Open Graph action that should be uploaded prior to publishing the action. The action must already have been set prior to calling this method. The images will not be marked as being user-generated. This method will generate unique names for the image attachments and update the action to refer to these attachments. Note that calling setAction again after calling this method will not clear the image attachments already set, but the new action will have no reference to the existing attachments.
In order for the images to be provided to the Facebook application as part of the app call, the NativeAppCallContentProvider must be specified correctly in the application's AndroidManifest.xml.
public OpenGraphDialogBuilderBase setImageAttachmentFilesForAction(List bitmapFiles) | Parameter | Description |
|---|---|
bitmapFiles | A list of Files containing bitmaps to be uploaded and attached to the Open Graph action |
setImageAttachmentFilesForAction(List, boolean)Specifies a list of images for the Open Graph action that should be uploaded prior to publishing the action. The action must already have been set prior to calling this method. The images may be marked as being user-generated -- refer to this article for more information. This method will generate unique names for the image attachments and update the action to refer to these attachments. Note that calling setAction again after calling this method will not clear the image attachments already set, but the new action will have no reference to the existing attachments.
In order for the images to be provided to the Facebook application as part of the app call, the NativeAppCallContentProvider must be specified correctly in the application's AndroidManifest.xml.
public OpenGraphDialogBuilderBase setImageAttachmentFilesForAction(List bitmapFiles, boolean isUserGenerated) | Parameter | Description |
|---|---|
bitmapFiles | A list of Files containing bitmaps to be uploaded and attached to the Open Graph action |
isUserGenerated | If true, specifies that the user_generated flag should be set for these images |
setImageAttachmentsForObject(String, List)Specifies a list of images for an Open Graph object referenced by the action that should be uploaded prior to publishing the action. The images will not be marked as user-generated. The action must already have been set prior to calling this method, and the action must have a GraphObject-valued property with the specified property name. This method will generate unique names for the image attachments and update the graph object to refer to these attachments. Note that calling setObject again after calling this method, or modifying the value of the specified property, will not clear the image attachments already set, but the new action (or objects) will have no reference to the existing attachments.
In order for the images to be provided to the Facebook application as part of the app call, the NativeAppCallContentProvider must be specified correctly in the application's AndroidManifest.xml.
public OpenGraphDialogBuilderBase setImageAttachmentsForObject(String objectProperty, List bitmaps) | Parameter | Description |
|---|---|
objectProperty | The name of a property on the action that corresponds to an Open Graph object; the object must be marked as a new object to be created (i.e., OpenGraphObject.getCreateObject() must return true) or an exception will be thrown |
bitmaps | A list of Files containing bitmaps to be uploaded and attached to the Open Graph object |
setImageAttachmentsForObject(String, List, boolean)Specifies a list of images for an Open Graph object referenced by the action that should be uploaded prior to publishing the action. The images may be marked as being user-generated -- refer to this article for more information. The action must already have been set prior to calling this method, and the action must have a GraphObject-valued property with the specified property name. This method will generate unique names for the image attachments and update the graph object to refer to these attachments. Note that calling setObject again after calling this method, or modifying the value of the specified property, will not clear the image attachments already set, but the new action (or objects) will have no reference to the existing attachments.
In order for the images to be provided to the Facebook application as part of the app call, the NativeAppCallContentProvider must be specified correctly in the application's AndroidManifest.xml.
public OpenGraphDialogBuilderBase setImageAttachmentsForObject(String objectProperty, List bitmaps, boolean isUserGenerated) | Parameter | Description |
|---|---|
objectProperty | The name of a property on the action that corresponds to an Open Graph object |
bitmaps | A list of Files containing bitmaps to be uploaded and attached to the Open Graph object |
isUserGenerated | If true, specifies that the user_generated flag should be set for these images |
setImageAttachmentFilesForObject(String, List)Specifies a list of images for an Open Graph object referenced by the action that should be uploaded prior to publishing the action. The images will not be marked as user-generated. The action must already have been set prior to calling this method, and the action must have a GraphObject-valued property with the specified property name. This method will generate unique names for the image attachments and update the graph object to refer to these attachments. Note that calling setObject again after calling this method, or modifying the value of the specified property, will not clear the image attachments already set, but the new action (or objects) will have no reference to the existing attachments.
In order for the images to be provided to the Facebook application as part of the app call, the NativeAppCallContentProvider must be specified correctly in the application's AndroidManifest.xml.
public OpenGraphDialogBuilderBase setImageAttachmentFilesForObject(String objectProperty, List bitmapFiles) | Parameter | Description |
|---|---|
objectProperty | The name of a property on the action that corresponds to an Open Graph object; the object must be marked as a new object to be created (i.e., OpenGraphObject.getCreateObject() must return true) or an exception will be thrown |
bitmapFiles | A list of Bitmaps to be uploaded and attached to the Open Graph object |
setImageAttachmentFilesForObject(String, List, boolean)Specifies a list of images for an Open Graph object referenced by the action that should be uploaded prior to publishing the action. The images may be marked as being user-generated -- refer to this article for more information. The action must already have been set prior to calling this method, and the action must have a GraphObject-valued property with the specified property name. This method will generate unique names for the image attachments and update the graph object to refer to these attachments. Note that calling setObject again after calling this method, or modifying the value of the specified property, will not clear the image attachments already set, but the new action (or objects) will have no reference to the existing attachments.
In order for the images to be provided to the Facebook application as part of the app call, the NativeAppCallContentProvider must be specified correctly in the application's AndroidManifest.xml.
public OpenGraphDialogBuilderBase setImageAttachmentFilesForObject(String objectProperty, List bitmapFiles, boolean isUserGenerated) | Parameter | Description |
|---|---|
objectProperty | The name of a property on the action that corresponds to an Open Graph object; the object must be marked as a new object to be created (i.e., OpenGraphObject.getCreateObject() must return true) or an exception will be thrown |
bitmapFiles | A list of Bitmaps to be uploaded and attached to the Open Graph object |
isUserGenerated | If true, specifies that the user_generated flag should be set for these images |
activityprotected final Activity activityapplicationIdprotected final String applicationIdappCallprotected final PendingCall appCall