Interface ProgramGuideResponse

This command is a response to the GetProgramGuide command.

See

MatterSpecification.v13.Cluster § 6.6.7.6

interface ProgramGuideResponse {
    paging: TypeFromFields<{
        nextToken: OptionalFieldType<null | TypeFromFields<{
            after: OptionalFieldType<string>;
            before: OptionalFieldType<string>;
            limit: OptionalFieldType<number>;
        }>>;
        previousToken: OptionalFieldType<null | TypeFromFields<{
            after: OptionalFieldType<string>;
            before: OptionalFieldType<string>;
            limit: OptionalFieldType<number>;
        }>>;
    }>;
    programList: TypeFromFields<{
        audioLanguages: OptionalFieldType<string[]>;
        castList: OptionalFieldType<TypeFromFields<{
            name: FieldType<string>;
            role: FieldType<string>;
        }>[]>;
        categoryList: OptionalFieldType<TypeFromFields<{
            category: FieldType<string>;
            subCategory: OptionalFieldType<string>;
        }>[]>;
        channel: FieldType<TypeFromFields<{
            affiliateCallSign: OptionalFieldType<string>;
            callSign: OptionalFieldType<string>;
            identifier: OptionalFieldType<string>;
            majorNumber: FieldType<number>;
            minorNumber: FieldType<number>;
            name: OptionalFieldType<string>;
            type: OptionalFieldType<Channel.ChannelType>;
        }>>;
        description: OptionalFieldType<string>;
        dvbiUrl: OptionalFieldType<string>;
        endTime: FieldType<number>;
        externalIdList: OptionalFieldType<TypeFromFields<{
            name: FieldType<string>;
            value: FieldType<string>;
        }>[]>;
        identifier: FieldType<string>;
        parentalGuidanceText: OptionalFieldType<string>;
        posterArtUrl: OptionalFieldType<string>;
        ratings: OptionalFieldType<string[]>;
        recordingFlag: OptionalFieldType<TypeFromPartialBitSchema<{
            recorded: BitFlag;
            recordSeries: BitFlag;
            scheduled: BitFlag;
        }>>;
        releaseDate: OptionalFieldType<string>;
        seriesInfo: OptionalFieldType<null | TypeFromFields<{
            episode: FieldType<string>;
            season: FieldType<string>;
        }>>;
        startTime: FieldType<number>;
        subtitle: OptionalFieldType<string>;
        thumbnailUrl: OptionalFieldType<string>;
        title: FieldType<string>;
    }>[];
}

Hierarchy (view full)

TypeFromSchema<typeof Channel.TlvProgramGuideResponse>
- ProgramGuideResponse

Index

Properties

paging programList

Properties

paging

paging: TypeFromFields<{
    nextToken: OptionalFieldType<null | TypeFromFields<{
        after: OptionalFieldType<string>;
        before: OptionalFieldType<string>;
        limit: OptionalFieldType<number>;
    }>>;
    previousToken: OptionalFieldType<null | TypeFromFields<{
        after: OptionalFieldType<string>;
        before: OptionalFieldType<string>;
        limit: OptionalFieldType<number>;
    }>>;
}>

This field shall indicate the necessary pagination attributes that define information for both the succeeding and preceding data pages.

Type declaration

nextToken: OptionalFieldType<null | TypeFromFields<{
    after: OptionalFieldType<string>;
    before: OptionalFieldType<string>;
    limit: OptionalFieldType<number>;
}>>
This field shall indicate the token to retrieve the next page. Absence of this field denotes the response as the last page.

See
MatterSpecification.v13.Cluster § 6.6.5.12.2
previousToken: OptionalFieldType<null | TypeFromFields<{
    after: OptionalFieldType<string>;
    before: OptionalFieldType<string>;
    limit: OptionalFieldType<number>;
}>>
This field shall indicate the token to retrieve the preceding page. Absence of this field denotes the response as the initial page.

See
MatterSpecification.v13.Cluster § 6.6.5.12.1

See

MatterSpecification.v13.Cluster § 6.6.7.6.1

programList

programList: TypeFromFields<{
    audioLanguages: OptionalFieldType<string[]>;
    castList: OptionalFieldType<TypeFromFields<{
        name: FieldType<string>;
        role: FieldType<string>;
    }>[]>;
    categoryList: OptionalFieldType<TypeFromFields<{
        category: FieldType<string>;
        subCategory: OptionalFieldType<string>;
    }>[]>;
    channel: FieldType<TypeFromFields<{
        affiliateCallSign: OptionalFieldType<string>;
        callSign: OptionalFieldType<string>;
        identifier: OptionalFieldType<string>;
        majorNumber: FieldType<number>;
        minorNumber: FieldType<number>;
        name: OptionalFieldType<string>;
        type: OptionalFieldType<Channel.ChannelType>;
    }>>;
    description: OptionalFieldType<string>;
    dvbiUrl: OptionalFieldType<string>;
    endTime: FieldType<number>;
    externalIdList: OptionalFieldType<TypeFromFields<{
        name: FieldType<string>;
        value: FieldType<string>;
    }>[]>;
    identifier: FieldType<string>;
    parentalGuidanceText: OptionalFieldType<string>;
    posterArtUrl: OptionalFieldType<string>;
    ratings: OptionalFieldType<string[]>;
    recordingFlag: OptionalFieldType<TypeFromPartialBitSchema<{
        recorded: BitFlag;
        recordSeries: BitFlag;
        scheduled: BitFlag;
    }>>;
    releaseDate: OptionalFieldType<string>;
    seriesInfo: OptionalFieldType<null | TypeFromFields<{
        episode: FieldType<string>;
        season: FieldType<string>;
    }>>;
    startTime: FieldType<number>;
    subtitle: OptionalFieldType<string>;
    thumbnailUrl: OptionalFieldType<string>;
    title: FieldType<string>;
}>[]

This field shall indicate the list of programs.

See

MatterSpecification.v13.Cluster § 6.6.7.6.2

Interface ProgramGuideResponse

See

Hierarchy (view full)

Index

Properties

Properties

paging

Type declaration

nextToken: OptionalFieldType<null | TypeFromFields<{
    after: OptionalFieldType<string>;
    before: OptionalFieldType<string>;
    limit: OptionalFieldType<number>;
}>>

See

previousToken: OptionalFieldType<null | TypeFromFields<{
    after: OptionalFieldType<string>;
    before: OptionalFieldType<string>;
    limit: OptionalFieldType<number>;
}>>

See

See

programList

See

Settings

On This Page

Interface ProgramGuideResponse

See

Hierarchy (view full)

Index

Properties

Properties

paging

Type declaration

nextToken: OptionalFieldType<null | TypeFromFields<{ after: OptionalFieldType<string>; before: OptionalFieldType<string>; limit: OptionalFieldType<number>; }>>

See

previousToken: OptionalFieldType<null | TypeFromFields<{ after: OptionalFieldType<string>; before: OptionalFieldType<string>; limit: OptionalFieldType<number>; }>>

See

See

programList

See

Settings

On This Page

nextToken: OptionalFieldType<null | TypeFromFields<{
after: OptionalFieldType<string>;
before: OptionalFieldType<string>;
limit: OptionalFieldType<number>;
}>>

previousToken: OptionalFieldType<null | TypeFromFields<{
after: OptionalFieldType<string>;
before: OptionalFieldType<string>;
limit: OptionalFieldType<number>;
}>>