universum.studios.android.intent

Class ShareIntent

java.lang.Object

universum.studios.android.intent.BaseIntent<ShareIntent>

universum.studios.android.intent.ShareIntent

public class ShareIntent
extends BaseIntent<ShareIntent>

A BaseIntent builder implementation providing API for building and starting of intents targeting a content sharing related applications.

This intent builder requires a mime type of the sharing content to be specified via mimeType(String). You may use one of predefined mime types from MimeType class. The content to be shared may be specified as string based content via content(CharSequence) or if there is to be shared a content that is represented by an Uri, such Uri may be specified via uri(Uri) or uris(List).

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
ShareIntent()

Method Summary

Modifier and Type	Method and Description
CharSequence	content() Returns the text that will be used as content for the sharing intent.
ShareIntent	content(CharSequence text) Sets a content for the sharing intent.
protected void	ensureCanBuildOrThrow() Called to ensure that this builder can build its Intent from its current data.
String	mimeType() Returns the MIME type of the content to be shared.
ShareIntent	mimeType(String type) Sets a MIME type of the content passed via content(CharSequence) or uri(Uri) or uris(List).
protected android.content.Intent	onBuild(android.content.Context context) Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.
protected boolean	onStartWith(IntentStarter starter, android.content.Intent intent) Invoked whenever BaseIntent.startWith(IntentStarter) is called and there is an activity available that can handle the given intent that has been created via BaseIntent.build(Context).
CharSequence	title() Returns the title text that will be used as title for sharing intent.
ShareIntent	title(CharSequence title) Sets a title for sharing intent.
android.net.Uri	uri() Returns the Uri to content to be shared.
ShareIntent	uri(android.net.Uri uri) Sets an Uri to content that should be shared.
List<android.net.Uri>	uris() Returns the list of Uris to content to be shared.
ShareIntent	uris(List<android.net.Uri> uris) Sets a list of Uris to content that should be shared.
ShareIntent	uris(android.net.Uri... uris) Same as uris(List) for variable array of Uris.

Methods inherited from class universum.studios.android.intent.BaseIntent

activityNotFoundMessage, activityNotFoundMessage, build, cannotBuildIntentException, dialogTitle, dialogTitle, enterTransition, enterTransition, exitTransition, exitTransition, isActivityForIntentAvailable, notifyActivityNotFound, startWith, transitions

Methods inherited from class java.lang.Object

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

Constructor Detail

ShareIntent

public ShareIntent()

Method Detail

content

public ShareIntent content(CharSequence text)

Sets a content for the sharing intent.

Parameters:

text - The desired content text. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

content()

content

public CharSequence content()

Returns the text that will be used as content for the sharing intent.

Returns:

Content for sharing intent or empty string if not specified yet.

See Also:

content(CharSequence)

uri

public ShareIntent uri(android.net.Uri uri)

Sets an Uri to content that should be shared.

Parameters:

uri - The desired content Uri. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

uri()

uri

public android.net.Uri uri()

Returns the Uri to content to be shared.

Returns:

Content Uri to share or null if not specified yet.

See Also:

uri(Uri)

uris

public ShareIntent uris(android.net.Uri... uris)

Same as uris(List) for variable array of Uris.

Parameters:

uris - The desired array of content uris.

See Also:

uris()

uris

public ShareIntent uris(List<android.net.Uri> uris)

Sets a list of Uris to content that should be shared.

Parameters:

uris - The desired list of content uris. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

uris(Uri...), uris()

uris

public List<android.net.Uri> uris()

Returns the list of Uris to content to be shared.

Returns:

Content Uris to share or Collections.EMPTY_LIST if there were no Uris specified yet.

See Also:

uris(Uri...), uris(List)

mimeType

public ShareIntent mimeType(String type)

Sets a MIME type of the content passed via content(CharSequence) or uri(Uri) or uris(List).

Default value: MimeType.TEXT

Parameters:

type - The desired content MIME type.

Returns:

This intent builder to allow methods chaining.

See Also:

mimeType()

mimeType

public String mimeType()

Returns the MIME type of the content to be shared.

Returns:

One of mime types specified in MimeType class.

See Also:

mimeType(String)

title

public ShareIntent title(CharSequence title)

Sets a title for sharing intent.

Parameters:

title - The desired title text. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

title()

title

public CharSequence title()

Returns the title text that will be used as title for sharing intent.

Returns:

Title for sharing intent or empty string if not specified yet.

See Also:

title(CharSequence)

ensureCanBuildOrThrow

protected void ensureCanBuildOrThrow()

Description copied from class: BaseIntent

Called to ensure that this builder can build its Intent from its current data.

If there are some required data missing/not specified, an exception indicating such state should be thrown. The default exception may be created via BaseIntent.cannotBuildIntentException(String).

Overrides:

ensureCanBuildOrThrow in class BaseIntent<ShareIntent>

onBuild

protected android.content.Intent onBuild(android.content.Context context)

Description copied from class: BaseIntent

Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.

Specified by:

onBuild in class BaseIntent<ShareIntent>

Parameters:

context - Context obtained from the IntentStarter.

Returns:

Intent instance with current data.

onStartWith

protected boolean onStartWith(IntentStarter starter,
                              android.content.Intent intent)

Description copied from class: BaseIntent

Invoked whenever BaseIntent.startWith(IntentStarter) is called and there is an activity available that can handle the given intent that has been created via BaseIntent.build(Context).

This implementation always returns true.

Overrides:

onStartWith in class BaseIntent<ShareIntent>

Parameters:

starter - The starter with which to start the intent.

intent - The intent instance created by this intent builder.

Returns:

True to indicate that the intent has been started, false otherwise.