Interface GetProgramsDto

Get programs dto.

Export

GetProgramsDto

interface GetProgramsDto {
    ChannelIds?: null | string[];
    EnableImages?: null | boolean;
    EnableImageTypes?: null | ImageType[];
    EnableTotalRecordCount?: boolean;
    EnableUserData?: null | boolean;
    Fields?: null | ItemFields[];
    GenreIds?: null | string[];
    Genres?: null | string[];
    HasAired?: null | boolean;
    ImageTypeLimit?: null | number;
    IsAiring?: null | boolean;
    IsKids?: null | boolean;
    IsMovie?: null | boolean;
    IsNews?: null | boolean;
    IsSeries?: null | boolean;
    IsSports?: null | boolean;
    LibrarySeriesId?: null | string;
    Limit?: null | number;
    MaxEndDate?: null | string;
    MaxStartDate?: null | string;
    MinEndDate?: null | string;
    MinStartDate?: null | string;
    SeriesTimerId?: null | string;
    SortBy?: null | ItemSortBy[];
    SortOrder?: null | SortOrder[];
    StartIndex?: null | number;
    UserId?: null | string;
}

Properties

ChannelIds? EnableImages? EnableImageTypes? EnableTotalRecordCount? EnableUserData? Fields? GenreIds? Genres? HasAired? ImageTypeLimit? IsAiring? IsKids? IsMovie? IsNews? IsSeries? IsSports? LibrarySeriesId? Limit? MaxEndDate? MaxStartDate? MinEndDate? MinStartDate? SeriesTimerId? SortBy? SortOrder? StartIndex? UserId?

Properties

OptionalChannelIds

ChannelIds?: null | string[]

Gets or sets the channels to return guide information for.

Memberof

GetProgramsDto

OptionalEnableImages

EnableImages?: null | boolean

Gets or sets include image information in output.

Memberof

GetProgramsDto

OptionalEnableImageTypes

EnableImageTypes?: null | ImageType[]

Gets or sets the image types to include in the output.

Memberof

GetProgramsDto

OptionalEnableTotalRecordCount

EnableTotalRecordCount?: boolean

Gets or sets a value indicating whether retrieve total record count.

Memberof

GetProgramsDto

OptionalEnableUserData

EnableUserData?: null | boolean

Gets or sets include user data.

Memberof

GetProgramsDto

OptionalFields

Fields?: null | ItemFields[]

Gets or sets specify additional fields of information to return in the output.

Memberof

GetProgramsDto

OptionalGenreIds

GenreIds?: null | string[]

Gets or sets the genre ids to return guide information for.

Memberof

GetProgramsDto

OptionalGenres

Genres?: null | string[]

Gets or sets the genres to return guide information for.

Memberof

GetProgramsDto

OptionalHasAired

HasAired?: null | boolean

Gets or sets filter by programs that have completed airing, or not.

Memberof

GetProgramsDto

OptionalImageTypeLimit

ImageTypeLimit?: null | number

Gets or sets the max number of images to return, per image type.

Memberof

GetProgramsDto

OptionalIsAiring

IsAiring?: null | boolean

Gets or sets filter by programs that are currently airing, or not.

Memberof

GetProgramsDto

OptionalIsKids

IsKids?: null | boolean

Gets or sets filter for kids.

Memberof

GetProgramsDto

OptionalIsMovie

IsMovie?: null | boolean

Gets or sets filter for movies.

Memberof

GetProgramsDto

OptionalIsNews

IsNews?: null | boolean

Gets or sets filter for news.

Memberof

GetProgramsDto

OptionalIsSeries

IsSeries?: null | boolean

Gets or sets filter for series.

Memberof

GetProgramsDto

OptionalIsSports

IsSports?: null | boolean

Gets or sets filter for sports.

Memberof

GetProgramsDto

OptionalLibrarySeriesId

LibrarySeriesId?: null | string

Gets or sets filter by library series id.

Memberof

GetProgramsDto

OptionalLimit

Limit?: null | number

Gets or sets the maximum number of records to return.

Memberof

GetProgramsDto

OptionalMaxEndDate

MaxEndDate?: null | string

Gets or sets the maximum premiere end date.

Memberof

GetProgramsDto

OptionalMaxStartDate

MaxStartDate?: null | string

Gets or sets the maximum premiere start date.

Memberof

GetProgramsDto

OptionalMinEndDate

MinEndDate?: null | string

Gets or sets the minimum premiere end date.

Memberof

GetProgramsDto

OptionalMinStartDate

MinStartDate?: null | string

Gets or sets the minimum premiere start date.

Memberof

GetProgramsDto

OptionalSeriesTimerId

SeriesTimerId?: null | string

Gets or sets filter by series timer id.

Memberof

GetProgramsDto

OptionalSortBy

SortBy?: null | ItemSortBy[]

Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate.

Memberof

GetProgramsDto

OptionalSortOrder

SortOrder?: null | SortOrder[]

Gets or sets sort order.

Memberof

GetProgramsDto

OptionalStartIndex

StartIndex?: null | number

Gets or sets the record index to start at. All items with a lower index will be dropped from the results.

Memberof

GetProgramsDto

OptionalUserId

UserId?: null | string

Gets or sets optional. Filter by user id.

Memberof

GetProgramsDto

Settings

Member Visibility

On This Page

Properties