public final class

LiveFolders

extends Object
implements BaseColumns
java.lang.Object
   ↳ android.provider.LiveFolders

Class Overview

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

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 fodler:

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

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.

[Expand]
Inherited Constants
From interface android.provider.BaseColumns
[Expand]
Inherited Methods
From class java.lang.Object

Constants

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

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

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 DISPLAY_MODE_GRID.

Optional.

Type: String.

Constant Value: "description"

public static final int DISPLAY_MODE_GRID

Displays a live folder's content in a grid.

Constant Value: 1 (0x00000001)

public static final int DISPLAY_MODE_LIST

Displays a live folder's content in a list.

Constant Value: 2 (0x00000002)

public static final String EXTRA_LIVE_FOLDER_BASE_INTENT

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

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

public static final String EXTRA_LIVE_FOLDER_DISPLAY_MODE

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

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

public static final String EXTRA_LIVE_FOLDER_ICON

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

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

public static final String EXTRA_LIVE_FOLDER_NAME

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

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

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"

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 fromContext(android.content.Context, int).

Optional.

Type: String.

Constant Value: "icon_package"

public static final String ICON_RESOURCE

Content provider column.

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

Optional.

Type: String.

Constant Value: "icon_resource"

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.

Constant Value: "intent"

public static final String NAME

Content provider column.

Name of the live folder item.

Required.

Type: String.

Constant Value: "name"