Added in API level 3
Deprecated in API level 14

Summary: Constants | Inherited Constants | Inherited Methods

LiveFolders

Kotlin |Java

public final class LiveFolders
extends Object implements BaseColumns

java.lang.Object
↳	android.provider.LiveFolders

This class was deprecated in API level 14.
Live folders are no longer supported by Android. These have been replaced by the new AppWidget Collection APIs introduced in Build.VERSION_CODES.HONEYCOMB. These provide all of the features of live folders plus many more. The use of live folders is greatly discouraged because of security issues they introduce -- publishing a live folder requires making all data show for the live folder available to all applications with no permissions protecting it.

A LiveFolder is a special folder whose content is provided by a ContentProvider. To create a live folder, two components are required:

An activity that can respond to the intent action ACTION_CREATE_LIVE_FOLDER. The activity is responsible for creating the live folder.
A ContentProvider to provide the live folder items.

Lifecycle

When a user wants to create a live folder, the system looks for all activities with the intent filter action ACTION_CREATE_LIVE_FOLDER and presents the list to the user. When the user chooses one of the activities, the activity is invoked with the ACTION_CREATE_LIVE_FOLDER action. The activity then creates the live folder and passes it back to the system by setting it as an activity result. The live folder is described by a content provider URI, a name, an icon and a display mode. Finally, when the user opens the live folder, the system queries the content provider to retrieve the folder's content.

Setting up the live folder activity

The following code sample shows how to write an activity that creates a live folder:

 public static class MyLiveFolder extends Activity {
     public static final Uri CONTENT_URI = Uri.parse("content://my.app/live");

     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);

         final Intent intent = getIntent();
         final String action = intent.getAction();

         if (LiveFolders.ACTION_CREATE_LIVE_FOLDER.equals(action)) {
             setResult(RESULT_OK, createLiveFolder(this, CONTENT_URI, "My LiveFolder",
                     R.drawable.ic_launcher_contacts_phones));
         } else {
             setResult(RESULT_CANCELED);
         }

         finish();
     }

     private static Intent createLiveFolder(Context context, Uri uri, String name,
             int icon) {

         final Intent intent = new Intent();

         intent.setData(uri);
         intent.putExtra(LiveFolders.EXTRA_LIVE_FOLDER_NAME, name);
         intent.putExtra(LiveFolders.EXTRA_LIVE_FOLDER_ICON,
                 Intent.ShortcutIconResource.fromContext(context, icon));
         intent.putExtra(LiveFolders.EXTRA_LIVE_FOLDER_DISPLAY_MODE, LiveFolders.DISPLAY_MODE_LIST);

         return intent;
     }
 }

The live folder is described by an Intent as follows:

Component	Type	Description	Required
URI	URI	The ContentProvider URI	Yes
`EXTRA_LIVE_FOLDER_NAME`	Extra String	The name of the live folder	Yes
`EXTRA_LIVE_FOLDER_ICON`	Extra `Intent.ShortcutIconResource`	The icon of the live folder	Yes
`EXTRA_LIVE_FOLDER_DISPLAY_MODE`	Extra int	The display mode of the live folder. The value must be either `DISPLAY_MODE_GRID` or `DISPLAY_MODE_LIST`.	Yes
`EXTRA_LIVE_FOLDER_BASE_INTENT`	Extra Intent	When the user clicks an item inside a live folder, the system will either fire the intent associated with that item or, if present, the live folder's base intent with the id of the item appended to the base intent's URI.	No

Setting up the content provider

The live folder's content provider must, upon query, return a Cursor whose columns match the following names:

Column	Type	Description	Required
`NAME`	String	The name of the item	Yes
`DESCRIPTION`	String	The description of the item. The description is ignored when the live folder's display mode is `DISPLAY_MODE_GRID`.	No
`INTENT`	`Intent`	The intent to fire when the item is clicked. Ignored when the live folder defines a base intent.	No
`ICON_BITMAP`	Bitmap	The icon for the item. When this column value is not null, the values for the columns `ICON_PACKAGE` and `ICON_RESOURCE` must be null.	No
`ICON_PACKAGE`	String	The package of the item's icon. When this value is not null, the value for the column `ICON_RESOURCE` must be specified and the value for the column `ICON_BITMAP` must be null.	No
`ICON_RESOURCE`	String	The resource name of the item's icon. When this value is not null, the value for the column `ICON_PACKAGE` must be specified and the value for the column `ICON_BITMAP` must be null.	No

Summary

Constants
`String`	`ACTION_CREATE_LIVE_FOLDER` Activity Action: Creates a live folder.
`String`	`DESCRIPTION` Content provider column.
`int`	`DISPLAY_MODE_GRID` Displays a live folder's content in a grid.
`int`	`DISPLAY_MODE_LIST` Displays a live folder's content in a list.
`String`	`EXTRA_LIVE_FOLDER_BASE_INTENT` The name of the extra used to define the base Intent of a live folder.
`String`	`EXTRA_LIVE_FOLDER_DISPLAY_MODE` The name of the extra used to define the display mode of a live folder.
`String`	`EXTRA_LIVE_FOLDER_ICON` The name of the extra used to define the icon of a live folder.
`String`	`EXTRA_LIVE_FOLDER_NAME` The name of the extra used to define the name of a live folder.
`String`	`ICON_BITMAP` Content provider column.
`String`	`ICON_PACKAGE` Content provider column.
`String`	`ICON_RESOURCE` Content provider column.
`String`	`INTENT` Content provider column.
`String`	`NAME` Content provider column.

Inherited constants

From interface android.provider.BaseColumns

`String`	`_COUNT` The count of rows in a directory.
`String`	`_ID` The unique ID for a row.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

ACTION_CREATE_LIVE_FOLDER

Added in API level 3

public static final String ACTION_CREATE_LIVE_FOLDER

Activity Action: Creates a live folder.

Input: Nothing.

Output: An Intent representing the live folder. The intent must contain four extras: EXTRA_LIVE_FOLDER_NAME (value: String), EXTRA_LIVE_FOLDER_ICON (value: ShortcutIconResource), EXTRA_LIVE_FOLDER_URI (value: String) and EXTRA_LIVE_FOLDER_DISPLAY_MODE (value: int). The Intent can optionnally contain EXTRA_LIVE_FOLDER_BASE_INTENT (value: Intent).

See also:

Constant Value: "android.intent.action.CREATE_LIVE_FOLDER"

DESCRIPTION

Added in API level 3

public static final String DESCRIPTION

Content provider column.

Description of the live folder item. This value is ignored if the live folder's display mode is LiveFolders.DISPLAY_MODE_GRID.

Optional.

Type: String.

See also:

EXTRA_LIVE_FOLDER_DISPLAY_MODE

Constant Value: "description"

DISPLAY_MODE_GRID

Added in API level 3

public static final int DISPLAY_MODE_GRID

Displays a live folder's content in a grid.

See also:

EXTRA_LIVE_FOLDER_DISPLAY_MODE

Constant Value: 1 (0x00000001)

DISPLAY_MODE_LIST

Added in API level 3

public static final int DISPLAY_MODE_LIST

Displays a live folder's content in a list.

See also:

EXTRA_LIVE_FOLDER_DISPLAY_MODE

Constant Value: 2 (0x00000002)

EXTRA_LIVE_FOLDER_BASE_INTENT

Added in API level 3

public static final String EXTRA_LIVE_FOLDER_BASE_INTENT

The name of the extra used to define the base Intent of a live folder.

See also:

ACTION_CREATE_LIVE_FOLDER

Constant Value: "android.intent.extra.livefolder.BASE_INTENT"

EXTRA_LIVE_FOLDER_DISPLAY_MODE

Added in API level 3

public static final String EXTRA_LIVE_FOLDER_DISPLAY_MODE

The name of the extra used to define the display mode of a live folder.

See also:

Constant Value: "android.intent.extra.livefolder.DISPLAY_MODE"

EXTRA_LIVE_FOLDER_ICON

Added in API level 3

public static final String EXTRA_LIVE_FOLDER_ICON

The name of the extra used to define the icon of a live folder.

See also:

ACTION_CREATE_LIVE_FOLDER

Constant Value: "android.intent.extra.livefolder.ICON"

EXTRA_LIVE_FOLDER_NAME

Added in API level 3

public static final String EXTRA_LIVE_FOLDER_NAME

The name of the extra used to define the name of a live folder.

See also:

ACTION_CREATE_LIVE_FOLDER

Constant Value: "android.intent.extra.livefolder.NAME"

ICON_BITMAP

Added in API level 3

public static final String ICON_BITMAP

Content provider column.

Icon of the live folder item, as a custom bitmap.

Optional.

Type: Bitmap.

Constant Value: "icon_bitmap"

ICON_PACKAGE

Added in API level 3

public static final String ICON_PACKAGE

Content provider column.

Package where to find the icon of the live folder item. This value can be obtained easily using Intent.ShortcutIconResource.fromContext(android.content.Context, int).

Optional.

Type: String.

See also:

Constant Value: "icon_package"

ICON_RESOURCE

Added in API level 3

public static final String ICON_RESOURCE

Content provider column.

Resource name of the live folder item. This value can be obtained easily using Intent.ShortcutIconResource.fromContext(android.content.Context, int).

Optional.

Type: String.

See also:

Constant Value: "icon_resource"

INTENT

Added in API level 3

public static final String INTENT

Content provider column.

Intent of the live folder item.

Optional if the live folder has a base intent.

Type: Intent.

See also:

EXTRA_LIVE_FOLDER_BASE_INTENT

Constant Value: "intent"

NAME

Added in API level 3

public static final String NAME

Content provider column.

Name of the live folder item.

Required.

Type: String.

Constant Value: "name"