Class KodiFavouritesNamespace

Index

Constructors

Methods

AddFavourite GetFavourites

Constructors

constructor

new KodiFavouritesNamespace(sendMessage: ISendMessage): KodiFavouritesNamespace
Parameters
- sendMessage: ISendMessage
Returns KodiFavouritesNamespace
- Defined in namespaces/favourites.ts:21

Methods

AddFavourite

AddFavourite(
    title: string,
    type: FavouriteType,
    path?: string,
    window?: string,
    windowparameter?: string,
    thumbnail?: string,
): Promise<string>
Adds an item to the favourites.
Parameters
- title: string
  The title of the favourite.
- type: FavouriteType
  The type of the favourite (e.g., 'video', 'music').
- Optionalpath: string
  Optional path for media, script, and androidapp favourites types.
- Optionalwindow: string
  Optional window name for window favourite type.
- Optionalwindowparameter: string
  Optional window parameter.
- Optionalthumbnail: string
  Optional thumbnail URL for the favourite.
Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/favourites.ts:36

GetFavourites

GetFavourites(): Promise<FavouritesGetFavouritesResponse>
Retrieves all favourites.

Returns Promise<FavouritesGetFavouritesResponse>
A promise resolving to a list of favourites.
- Defined in namespaces/favourites.ts:60