Interface SearchHint

Class SearchHintResult.

Export

SearchHint

interface SearchHint {
    Album?: null | string;
    AlbumArtist?: null | string;
    AlbumId?: null | string;
    Artists?: string[];
    BackdropImageItemId?: null | string;
    BackdropImageTag?: null | string;
    ChannelId?: null | string;
    ChannelName?: null | string;
    EndDate?: null | string;
    EpisodeCount?: null | number;
    Id?: string;
    IndexNumber?: null | number;
    IsFolder?: null | boolean;
    ItemId?: string;
    MatchedTerm?: null | string;
    MediaType?: MediaType;
    Name?: string;
    ParentIndexNumber?: null | number;
    PrimaryImageAspectRatio?: null | number;
    PrimaryImageTag?: null | string;
    ProductionYear?: null | number;
    RunTimeTicks?: null | number;
    Series?: null | string;
    SongCount?: null | number;
    StartDate?: null | string;
    Status?: null | string;
    ThumbImageItemId?: null | string;
    ThumbImageTag?: null | string;
    Type?: BaseItemKind;
}

Properties

Album? AlbumArtist? AlbumId? Artists? BackdropImageItemId? BackdropImageTag? ChannelId? ChannelName? EndDate? EpisodeCount? Id? IndexNumber? IsFolder? ItemId? MatchedTerm? MediaType? Name? ParentIndexNumber? PrimaryImageAspectRatio? PrimaryImageTag? ProductionYear? RunTimeTicks? Series? SongCount? StartDate? Status? ThumbImageItemId? ThumbImageTag? Type?

Properties

OptionalAlbum

Album?: null | string

Gets or sets the album.

Memberof

SearchHint

OptionalAlbumArtist

AlbumArtist?: null | string

Gets or sets the album artist.

Memberof

SearchHint

OptionalAlbumId

AlbumId?: null | string

Gets or sets the album id.

Memberof

SearchHint

OptionalArtists

Artists?: string[]

Gets or sets the artists.

Memberof

SearchHint

OptionalBackdropImageItemId

BackdropImageItemId?: null | string

Gets or sets the backdrop image item identifier.

Memberof

SearchHint

OptionalBackdropImageTag

BackdropImageTag?: null | string

Gets or sets the backdrop image tag.

Memberof

SearchHint

OptionalChannelId

ChannelId?: null | string

Gets or sets the channel identifier.

Memberof

SearchHint

OptionalChannelName

ChannelName?: null | string

Gets or sets the name of the channel.

Memberof

SearchHint

OptionalEndDate

EndDate?: null | string

Gets or sets the end date.

Memberof

SearchHint

OptionalEpisodeCount

EpisodeCount?: null | number

Gets or sets the episode count.

Memberof

SearchHint

OptionalId

Id?: string

Gets or sets the item id.

Memberof

SearchHint

OptionalIndexNumber

IndexNumber?: null | number

Gets or sets the index number.

Memberof

SearchHint

OptionalIsFolder

IsFolder?: null | boolean

Gets or sets a value indicating whether this instance is folder.

Memberof

SearchHint

OptionalItemId

ItemId?: string

Gets or sets the item id.

Memberof

SearchHint

Deprecated

OptionalMatchedTerm

MatchedTerm?: null | string

Gets or sets the matched term.

Memberof

SearchHint

OptionalMediaType

MediaType?: MediaType

Memberof

SearchHint

OptionalName

Name?: string

Gets or sets the name.

Memberof

SearchHint

OptionalParentIndexNumber

ParentIndexNumber?: null | number

Gets or sets the parent index number.

Memberof

SearchHint

OptionalPrimaryImageAspectRatio

PrimaryImageAspectRatio?: null | number

Gets or sets the primary image aspect ratio.

Memberof

SearchHint

OptionalPrimaryImageTag

PrimaryImageTag?: null | string

Gets or sets the image tag.

Memberof

SearchHint

OptionalProductionYear

ProductionYear?: null | number

Gets or sets the production year.

Memberof

SearchHint

OptionalRunTimeTicks

RunTimeTicks?: null | number

Gets or sets the run time ticks.

Memberof

SearchHint

OptionalSeries

Series?: null | string

Gets or sets the series.

Memberof

SearchHint

OptionalSongCount

SongCount?: null | number

Gets or sets the song count.

Memberof

SearchHint

OptionalStartDate

StartDate?: null | string

Gets or sets the start date.

Memberof

SearchHint

OptionalStatus

Status?: null | string

Gets or sets the status.

Memberof

SearchHint

OptionalThumbImageItemId

ThumbImageItemId?: null | string

Gets or sets the thumb image item identifier.

Memberof

SearchHint

OptionalThumbImageTag

ThumbImageTag?: null | string

Gets or sets the thumb image tag.

Memberof

SearchHint

OptionalType

Type?: BaseItemKind

Memberof

SearchHint

Settings

Member Visibility

On This Page

Properties