PreviewProgram

Artifact: androidx.tvprovider:tvprovider

View Source

Added in 1.1.0-alpha02

---

Kotlin |Java

class PreviewProgram

---

A convenience class to access PreviewPrograms entries in the system content provider.

This class makes it easy to insert or retrieve a preview program from the system content provider, which is defined in TvContractCompat.

Usage example when inserting a preview program:

PreviewProgram previewProgram = new PreviewProgram.Builder()
        .setChannelId(channel.getId())
        .setType(PreviewPrograms.TYPE_MOVIE)
        .setTitle("Program Title")
        .setDescription("Program Description")
        .setPosterArtUri(Uri.parse("http://example.com/poster_art.png"))
        // Set more attributes...
        .build();
Uri previewProgramUri = getContentResolver().insert(PreviewPrograms.CONTENT_URI,
        previewProgram.toContentValues());

Usage example when retrieving a preview program:

PreviewProgram previewProgram;
try (Cursor cursor = resolver.query(previewProgramUri, null, null, null, null)) {
    if (cursor != null && cursor.getCount() != 0) {
        cursor.moveToNext();
        previewProgram = PreviewProgram.fromCursor(cursor);
    }
}

Usage example when updating an existing preview program:

PreviewProgram updatedProgram = new PreviewProgram.Builder(previewProgram)
        .setWeight(20)
        .build();
getContentResolver().update(TvContractCompat.buildPreviewProgramUri(updatedProgram.getId()),
        updatedProgram.toContentValues(), null, null);

Usage example when deleting a preview program:

getContentResolver().delete(TvContractCompat.buildPreviewProgramUri(existingProgram.getId()),
        null, null);

Summary

Nested types
class PreviewProgram.Builder This Builder class simplifies the creation of a PreviewProgram object.

Public functions
Boolean	equals(other: Any!)
java-static PreviewProgram!	fromCursor(cursor: Cursor!) Creates a Program object from a cursor including the fields defined in PreviewPrograms.
Long	getChannelId()
Int	getWeight()
Boolean	hasAnyUpdatedValues(update: PreviewProgram!) Indicates whether some other PreviewProgram has any set attribute that is different from this PreviewProgram's respective attributes.
ContentValues!	toContentValues()
String!	toString()

Public functions

equals

fun equals(other: Any!): Boolean

fromCursor

Added in 1.1.0-alpha02

java-static fun fromCursor(cursor: Cursor!): PreviewProgram!

Creates a Program object from a cursor including the fields defined in PreviewPrograms.

Parameters
cursor: Cursor!	A row from the TV Input Framework database.

Returns
PreviewProgram!	A Program with the values taken from the cursor.

getChannelId

Added in 1.1.0-alpha02

fun getChannelId(): Long

Returns
Long	The value of COLUMN_CHANNEL_ID for the program.

getWeight

Added in 1.1.0-alpha02

fun getWeight(): Int

Returns
Int	The value of COLUMN_WEIGHT for the program.

hasAnyUpdatedValues

Added in 1.1.0-alpha02

fun hasAnyUpdatedValues(update: PreviewProgram!): Boolean

Indicates whether some other PreviewProgram has any set attribute that is different from this PreviewProgram's respective attributes. An attribute is considered "set" if its key is present in the ContentValues vector.

toContentValues

Added in 1.1.0-alpha02

fun toContentValues(): ContentValues!

Returns
ContentValues!	The fields of the Program in the ContentValues format to be easily inserted into the TV Input Framework database.

toString

fun toString(): String!