universum.studios.android.intent

Class SmsIntent

java.lang.Object

universum.studios.android.intent.BaseIntent

universum.studios.android.intent.SmsIntent

public final class SmsIntent
extends BaseIntent

A BaseIntent builder implementation providing API for building and starting of intents targeting an SMS sending related applications.

This intent builder requires only a phone number to be specified via phoneNumber(String).

Since:

1.0

Author:

Martin Albedinsky

See Also:

DialerIntent

Field Summary

Fields

Modifier and Type	Field and Description
static String	URI_SCHEME Uri scheme for SMS message targeting intents.

Constructor Summary

Constructors

Constructor and Description
SmsIntent()

Method Summary

Modifier and Type	Method and Description
CharSequence	body() Returns the body for SMS to send.
SmsIntent	body(CharSequence body) Sets a body for SMS to send.
protected void	ensureCanBuildOrThrow() Called to ensure that this builder can build its Intent from its current data.
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.
String	phoneNumber() Returns the phone number that will be passed to the SMS application.
SmsIntent	phoneNumber(String number) Sets a phone number that should be passed to the SMS application.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

URI_SCHEME

public static final String URI_SCHEME

Uri scheme for SMS message targeting intents.

Constant value: sms

See Also:

Constant Field Values

Constructor Detail

SmsIntent

public SmsIntent()

Method Detail

phoneNumber

public SmsIntent phoneNumber(@Nullable
                             String number)

Sets a phone number that should be passed to the SMS application.

Parameters:

number - The desired phone number. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

phoneNumber()

phoneNumber

@NonNull
public String phoneNumber()

Returns the phone number that will be passed to the SMS application.

Returns:

Phone number or empty string if not specified yet.

See Also:

phoneNumber(String)

body

public SmsIntent body(@Nullable
                      CharSequence body)

Sets a body for SMS to send.

Parameters:

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

Returns:

This intent builder to allow methods chaining.

See Also:

body()

body

@NonNull
public CharSequence body()

Returns the body for SMS to send.

Returns:

Message of SMS or empty text if not specified yet.

See Also:

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

onBuild

@NonNull
protected android.content.Intent onBuild(@NonNull
                                                  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

Parameters:

context - Context obtained from the IntentStarter.

Returns:

Intent instance with current data.