FacebookDialog.MessageDialogBuilder - Documentation

FacebookDialog.MessageDialogBuilder

This class is no longer available in the most recent version of the SDK.
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 Message dialog. This builder will throw an exception if the Facebook Messenger application is not installed, so it should only be used if FacebookDialog.canPresentMessageDialog(android.content.Context, com.facebook.widget.FacebookDialog.MessageDialogFeature...) indicates the capability is available. The "friends" and "place" properties will be ignored as the Facebook Messenger app does not support tagging.

Extends:	`Object`
Package:	`widget`

Constructors

FacebookDialog.ShareDialogBuilderBase(Activity)

Constructor.

public FacebookDialog.ShareDialogBuilderBase(Activity activity)

Parameter	Description
`activity`	The Activity which is presenting the native Share dialog; must not be null

FacebookDialog.MessageDialogBuilder(Activity)

Constructor.

public FacebookDialog.MessageDialogBuilder(Activity activity)

Parameter	Description
`activity`	The Activity which is presenting the native Message dialog; must not be null

Instance Methods

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

Returns

This instance of the builder

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

Returns

This instance of the builder

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()

Returns

A FacebookDialog instance

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()

Returns

True if the dialog can be presented; false if not

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`

setName(String)

Sets the title of the item to be shared.

public ShareDialogBuilderBase setName(String name)

Parameter	Description
`name`	The title

Returns

This instance of the builder

setCaption(String)

Sets the subtitle of the item to be shared.

public ShareDialogBuilderBase setCaption(String caption)

Parameter	Description
`caption`	The subtitle

Returns

This instance of the builder

setDescription(String)

Sets the description of the item to be shared.

public ShareDialogBuilderBase setDescription(String description)

Parameter	Description
`description`	The description

Returns

This instance of the builder

setLink(String)

Sets the URL of the item to be shared.

public ShareDialogBuilderBase setLink(String link)

Parameter	Description
`link`	The URL

Returns

This instance of the builder

setPicture(String)

Sets the URL of the image of the item to be shared.

public ShareDialogBuilderBase setPicture(String picture)

Parameter	Description
`picture`	The URL of the image

Returns

This instance of the builder

setPlace(String)

Sets the place for the item to be shared.

public ShareDialogBuilderBase setPlace(String place)

Parameter	Description
`place`	The Facebook ID of the place

Returns

This instance of the builder

setFriends(List)

Sets the tagged friends for the item to be shared.

public ShareDialogBuilderBase setFriends(List friends)

Parameter	Description
`friends`	A list of Facebook IDs of the friends to be tagged in the shared item

Returns

This instance of the builder

setRef(String)

Sets the 'ref' property of the item to be shared.

public ShareDialogBuilderBase setRef(String ref)

Parameter	Description
`ref`	The 'ref' property

Returns

This instance of the builder

setDataErrorsFatal(boolean)

Sets whether errors encountered during previewing the shared item should be considered fatal and cause the dialog to return an error

public ShareDialogBuilderBase setDataErrorsFatal(boolean dataErrorsFatal)

Parameter	Description
`dataErrorsFatal`	True if data errors should be fatal; false if not

Returns

This instance of the builder

Constants

activity

protected final Activity activity

applicationId

protected final String applicationId

appCall

protected final PendingCall appCall