com.twofortyfouram.locale
Class Intent

java.lang.Object
  com.twofortyfouram.locale.Intent

public final class Intent
extends java.lang.Object

Contains Intent constants necessary for interacting with the Locale developer platform.

RESULT_CONDITION_SATISFIED

public static final int RESULT_CONDITION_SATISFIED

Ordered broadcast result code indicating that a plug-in condition's state is satisfied (true).

See Also:

ACTION_QUERY_CONDITION, Constant Field Values

RESULT_CONDITION_UNSATISFIED

public static final int RESULT_CONDITION_UNSATISFIED

Ordered broadcast result code indicating that a plug-in condition's state is not satisfied (false).

See Also:

ACTION_QUERY_CONDITION, Constant Field Values

RESULT_CONDITION_UNKNOWN

public static final int RESULT_CONDITION_UNKNOWN

Ordered broadcast result code indicating that a plug-in condition's state is unknown (neither true nor false).

If a condition returns UNKNOWN, then Locale will use the last known return value on a best-effort basis. Best-effort means that Locale may not persist known values forever (e.g. last known values could hypothetically be cleared after a device reboot, a restart of the Locale process, or other events). If there is no last known return value, then unknown is treated as not satisfied (false).

See Also:

ACTION_QUERY_CONDITION, Constant Field Values

ACTION_EDIT_SETTING

public static final java.lang.String ACTION_EDIT_SETTING

Intent action String broadcast by Locale to create or edit a plug-in setting. When Locale broadcasts this Intent, it will be sent directly to the package and class of the plug-in's Activity. The Intent may contain a store-and-forward EXTRA_BUNDLE that was previously set by the Activity result of ACTION_EDIT_SETTING.

There SHOULD be only one Activity per APK that implements this Intent.

See Also:

EXTRA_BUNDLE, EXTRA_STRING_BREADCRUMB, Constant Field Values

ACTION_FIRE_SETTING

public static final java.lang.String ACTION_FIRE_SETTING

Intent action String broadcast by Locale to fire a plug-in setting. When Locale broadcasts this Intent, it will be sent directly to the package and class of the plug-in's BroadcastReceiver. The Intent will contain store-and-forward extras that were previously set by the Activity result of ACTION_EDIT_SETTING.

There MUST be only one BroadcastReceiver per APK that implements this Intent.

See Also:

EXTRA_BUNDLE, Constant Field Values

ACTION_EDIT_CONDITION

public static final java.lang.String ACTION_EDIT_CONDITION

Intent action String broadcast by Locale to create or edit a plug-in condition. When Locale broadcasts this Intent, it will be sent directly to the package and class of the plug-in's Activity. The Intent may contain a store-and-forward EXTRA_BUNDLE that was previously set by the Activity result of ACTION_EDIT_CONDITION.

There SHOULD be only one Activity per APK that implements this Intent.

See Also:

EXTRA_BUNDLE, EXTRA_STRING_BREADCRUMB, Constant Field Values

ACTION_QUERY_CONDITION

public static final java.lang.String ACTION_QUERY_CONDITION

Ordered Intent action String broadcast by Locale to query a plug-in condition. When Locale broadcasts this Intent, it will be sent directly to the package and class of the plug-in's BroadcastReceiver. The Intent will contain store-and-forward extras that were previously set by the Activity result of ACTION_EDIT_CONDITION.

Since this is an ordered broadcast, the receiver is expected to set an appropriate result code from RESULT_CONDITION_SATISFIED, RESULT_CONDITION_UNSATISFIED, and RESULT_CONDITION_UNKNOWN.

There MUST be only one BroadcastReceiver per APK that implements this Intent.

See Also:

EXTRA_BUNDLE, RESULT_CONDITION_SATISFIED, RESULT_CONDITION_UNSATISFIED, RESULT_CONDITION_UNKNOWN, Constant Field Values

ACTION_REQUEST_QUERY

public static final java.lang.String ACTION_REQUEST_QUERY

Intent action String to notify Locale that a plug-in condition is requesting that Locale query it via ACTION_QUERY_CONDITION. This merely serves as a hint to Locale that a condition wants to be queried. There is no guarantee as to when or if the plug-in will be queried after this Intent is broadcast.

The extra EXTRA_ACTIVITY MUST be included, otherwise Locale will ignore this Intent.

Plug-ins conditions SHOULD NOT use this unless there is some sort of asynchronous event that has occurred, such as a broadcast Intent being received by the plug-in. Plug-ins SHOULD NOT periodically request a requery.

See Also:

EXTRA_ACTIVITY, Constant Field Values

EXTRA_STRING_BREADCRUMB

public static final java.lang.String EXTRA_STRING_BREADCRUMB

Type: String

Maps to a String that represents the Activity breadcrumb path.

See Also:

BreadCrumber, Constant Field Values

EXTRA_STRING_BLURB

public static final java.lang.String EXTRA_STRING_BLURB

Type: String

Maps to a String that represents a blurb. This is returned as an Activity result extra from ACTION_EDIT_CONDITION or ACTION_EDIT_SETTING.

The blurb is a concise description displayed to the user of what the plug-in is configured to do.

See Also:

Constant Field Values

EXTRA_BUNDLE

public static final java.lang.String EXTRA_BUNDLE

Type: Bundle

Maps to a Bundle that contains all of a plug-in's store-and-forward extras.

Plug-ins MUST NOT store Parcelable objects in this Bundle, because Parcelable is not a long-term storage format. Also, plug-ins MUST NOT store any serializable object that is not exposed by the Android SDK.

The maximum size of a Bundle that can be sent across process boundaries is on the order of 500 kilobytes (base-10), while Locale further limits store-and-forward Bundles to about 100 kilobytes (base-10). Although the maximum size is about 100 kilobytes, plug-ins SHOULD keep store-and-forward Bundles much smaller for performance and memory usage reasons.

See Also:

Constant Field Values

EXTRA_ACTIVITY

public static final java.lang.String EXTRA_ACTIVITY

Type: String

Maps to a String that represents the name of a plug-in's Activity.

See Also:

ACTION_EDIT_CONDITION, ACTION_REQUEST_QUERY, Constant Field Values