Interface RecommendationsApi

API for managing recommendations displayed by the RecommendationOverlay.

interface RecommendationsApi {
    add(recommendation: RecommendationConfig): void;
    list(): RecommendationConfig[];
    remove(recommendation: RecommendationConfig): boolean;
}

Index

Methods

add list remove

Methods

add

add(recommendation: RecommendationConfig): void
Adds a recommendation which will be displayed in the RecommendationOverlay.

Note:
- Does not check for duplicated recommendations.
- Dynamically added recommendations will be cleared when a new source is loaded into the Player.
Parameters
- recommendation: RecommendationConfig
Returns void
- Defined in src/ts/UIManager.ts:79

list

list(): RecommendationConfig[]
Returns the list of all added recommendations in insertion order.

Returns RecommendationConfig[]
- Defined in src/ts/UIManager.ts:91

remove

remove(recommendation: RecommendationConfig): boolean
Removes a recommendation by reference and returns true if the recommendation has been part of the recommendations and successfully removed, or false if the recommendation could not be found and thus not removed.
Parameters
- recommendation: RecommendationConfig
Returns boolean
- Defined in src/ts/UIManager.ts:86