mythtv-services-api/dist/GuideService.d.ts

Mythtv Service Api Bindings

import ApiTypes from "./ApiTypes";
import { AbstractService } from "./Communication";
export declare namespace GuideService {
    namespace Request {
        interface AddToChannelGroup {
            ChannelGroupId: number;
            ChanId: number;
        }
        interface GetChannelGroupList {
            IncludeEmpty?: boolean;
        }
        interface GetChannelIcon {
            ChanId: number;
            Width?: number;
            Height?: number;
        }
        interface GetProgramDetails {
            ChanId: number;
            StartTime: Date;
        }
        interface GetProgramGuide extends Partial<ApiTypes.ListRequest> {
            StartTime: Date;
            EndTime: Date;
            Details?: boolean;
            ChannelGroupId?: number;
            WithInvisible?: boolean;
        }
        interface GetProgramList extends Partial<ApiTypes.SortedListRequest<'starttime' | 'title' | 'channel' | 'duration'>> {
            StartTime?: Date;
            EndTime?: Date;
            ChanId?: number;
            TitleFilter?: string;
            CategoryFilter?: string;
            PersonFilter?: string;
            KeywordFilter?: string;
            OnlyNew?: boolean;
            Details?: boolean;
            Descending?: boolean;
            WithInvisible?: boolean;
        }
        interface GetStoredSearches {
            Type: string;
        }
        interface RemoveFromChannelGroup {
            ChannelGroupId: number;
            ChanId: number;
        }
    }
    class Service extends AbstractService {
        constructor(baseUrl: URL);
        AddToChannelGroup(req: Request.AddToChannelGroup): Promise<void>;
        GetCategoryList(): Promise<string[]>;
        GetChannelGroupList(req: Request.GetChannelGroupList): Promise<ApiTypes.ChannelGroup[]>;
        GetChannelIcon(req: Request.GetChannelIcon): Promise<string>;
        GetProgramDetails(req: Request.GetProgramDetails): Promise<ApiTypes.Program>;
        GetProgramGuide(req: Request.GetProgramGuide): Promise<ApiTypes.ProgramGuide>;
        GetProgramList(req: Request.GetProgramList): Promise<ApiTypes.ProgramList>;
        GetStoredSearches(req: Request.GetStoredSearches): Promise<string[]>;
        RemoveFromChannelGroup(req: Request.RemoveFromChannelGroup): Promise<void>;
    }
}