Variable ElectronicGuideComponentConst

Type declaration

• Readonlycommands: {
      getProgramGuide: Command<TypeFromFields<{
          channelList: OptionalFieldType<TypeFromFields<{
              affiliateCallSign: OptionalFieldType<string>;
              callSign: OptionalFieldType<string>;
              identifier: OptionalFieldType<string>;
              majorNumber: FieldType<number>;
              minorNumber: FieldType<number>;
              name: OptionalFieldType<string>;
              type: OptionalFieldType<Channel.ChannelType>;
          }>[]>;
          data: OptionalFieldType<Uint8Array>;
          endTime: FieldType<number>;
          externalIdList: OptionalFieldType<TypeFromFields<{
              name: FieldType<string>;
              value: FieldType<string>;
          }>[]>;
          pageToken: OptionalFieldType<null | TypeFromFields<{
              after: OptionalFieldType<string>;
              before: OptionalFieldType<string>;
              limit: OptionalFieldType<number>;
          }>>;
          recordingFlag: OptionalFieldType<null | TypeFromPartialBitSchema<{
              recorded: BitFlag;
              recordSeries: BitFlag;
              scheduled: BitFlag;
          }>>;
          startTime: FieldType<number>;
      }>, TypeFromFields<{
          paging: FieldType<TypeFromFields<{
              nextToken: OptionalFieldType<null | TypeFromFields<(...)>>;
              previousToken: OptionalFieldType<null | TypeFromFields<(...)>>;
          }>>;
          programList: FieldType<TypeFromFields<{
              audioLanguages: OptionalFieldType<(...)[]>;
              castList: OptionalFieldType<(...)[]>;
              categoryList: OptionalFieldType<(...)[]>;
              channel: FieldType<TypeFromFields<(...)>>;
              description: OptionalFieldType<string>;
              dvbiUrl: OptionalFieldType<string>;
              endTime: FieldType<number>;
              externalIdList: OptionalFieldType<(...)[]>;
              identifier: FieldType<string>;
              parentalGuidanceText: OptionalFieldType<string>;
              posterArtUrl: OptionalFieldType<string>;
              ratings: OptionalFieldType<(...)[]>;
              recordingFlag: OptionalFieldType<TypeFromPartialBitSchema<(...)>>;
              releaseDate: OptionalFieldType<string>;
              seriesInfo: OptionalFieldType<(...) | (...)>;
              startTime: FieldType<number>;
              subtitle: OptionalFieldType<string>;
              thumbnailUrl: OptionalFieldType<string>;
              title: FieldType<string>;
          }>[]>;
      }>, any>;
  }

  • ReadonlygetProgramGuide: Command<TypeFromFields<{
        channelList: OptionalFieldType<TypeFromFields<{
            affiliateCallSign: OptionalFieldType<string>;
            callSign: OptionalFieldType<string>;
            identifier: OptionalFieldType<string>;
            majorNumber: FieldType<number>;
            minorNumber: FieldType<number>;
            name: OptionalFieldType<string>;
            type: OptionalFieldType<Channel.ChannelType>;
        }>[]>;
        data: OptionalFieldType<Uint8Array>;
        endTime: FieldType<number>;
        externalIdList: OptionalFieldType<TypeFromFields<{
            name: FieldType<string>;
            value: FieldType<string>;
        }>[]>;
        pageToken: OptionalFieldType<null | TypeFromFields<{
            after: OptionalFieldType<string>;
            before: OptionalFieldType<string>;
            limit: OptionalFieldType<number>;
        }>>;
        recordingFlag: OptionalFieldType<null | TypeFromPartialBitSchema<{
            recorded: BitFlag;
            recordSeries: BitFlag;
            scheduled: BitFlag;
        }>>;
        startTime: FieldType<number>;
    }>, TypeFromFields<{
        paging: FieldType<TypeFromFields<{
            nextToken: OptionalFieldType<null | TypeFromFields<(...)>>;
            previousToken: OptionalFieldType<null | TypeFromFields<(...)>>;
        }>>;
        programList: FieldType<TypeFromFields<{
            audioLanguages: OptionalFieldType<(...)[]>;
            castList: OptionalFieldType<(...)[]>;
            categoryList: OptionalFieldType<(...)[]>;
            channel: FieldType<TypeFromFields<(...)>>;
            description: OptionalFieldType<string>;
            dvbiUrl: OptionalFieldType<string>;
            endTime: FieldType<number>;
            externalIdList: OptionalFieldType<(...)[]>;
            identifier: FieldType<string>;
            parentalGuidanceText: OptionalFieldType<string>;
            posterArtUrl: OptionalFieldType<string>;
            ratings: OptionalFieldType<(...)[]>;
            recordingFlag: OptionalFieldType<TypeFromPartialBitSchema<(...)>>;
            releaseDate: OptionalFieldType<string>;
            seriesInfo: OptionalFieldType<(...) | (...)>;
            startTime: FieldType<number>;
            subtitle: OptionalFieldType<string>;
            thumbnailUrl: OptionalFieldType<string>;
            title: FieldType<string>;
        }>[]>;
    }>, any>

    This command retrieves the program guide. It accepts several filter parameters to return specific schedule and program information from a content app. The command shall receive in response a ProgramGuideResponse. Standard error codes shall be used when arguments provided are not

    valid. For example, if StartTime is greater than EndTime, the status code INVALID_ACTION shall be returned.

    See

    MatterSpecification.v13.Cluster § 6.6.7.5