IRecommendationManager2 - Amazon Vega Docs

Interface `IRecommendationManager2`

interface IRecommendationManager2

Extends IRecommendationManager API for adding and removing Recommendation2 objects on device. RecommendationManager2 is a local recommendation service that handles the display and management of Recommendation2 objects submitted by client apps. Example of adding Recommendation2 objects:

 // Recommendation2 object with contentImage byte array
 std::vector<Ptr<Recommendation2>> recommendationsVector;
 auto recBuilder = MakeBuilderFor<Recommendation2>().QueryInterface<BuilderFor<Recommendation2>>();
 recBuilder->title("title");
 recBuilder->text("content text");
 recBuilder->contentImage({1,2,3,4});
 recBuilder->category(Category.HOME);
 recBuilder->displayName("Display name");
 recBuilder->displayActionOption(DisplayAction.WATCH);
 recBuilder->maturityRating("TV14");
 recBuilder->customerAggregateRating(7);
 recBuilder->customerRatingCount(200);
 recBuilder->runningTime(5400);
 recBuilder->releaseYear(1999);
 recBuilder->captionAvailability(false);
 recommendationsVector.push_back(recBuilder->build().QueryInterface<Recommendation2>());

 // Recommendation2 object with contentImageUri
 auto recBuilder = MakeBuilderFor<Recommendation2>().QueryInterface<BuilderFor<Recommendation2>>();
 recBuilder->title("title");
 recBuilder->text("content text");
 recBuilder->contentImageUri("https://m.media-amazon.com/images/I/51BgdbKS+FL.jpg");
 recBuilder->category(Category.HOME);
 recBuilder->displayName("Display name");
 recBuilder->displayActionOption(DisplayAction.WATCH);
 recBuilder->maturityRating("TV14");
 recBuilder->customerAggregateRating(7);
 recBuilder->customerRatingCount(200);
 recBuilder->runningTime(5400);
 recBuilder->releaseYear(1999);
 recBuilder->captionAvailability(false);
 recommendationsVector.push_back(recBuilder->build().QueryInterface<Recommendation2>());

 // add additional recommendations as needed and send to RecommendationManager2 to add it on device
 Ptr<IRecommendationManager2> recommendationManager = component.QueryInterface<IRecommendationManager2>();
 Array<Uuid> uuids = recommendationManager->addRecommendations2(recommendationsVector);

Example for removing a recommendation using uuid (ex: uuidAdded) returned previously from addRecommendations2 call:

 std::vector<Uuid> uuidVector;
 uuidVector.push_back(uuidAdded);
 Ptr<IRecommendationManager2> recommendationManager = component.QueryInterface<IRecommendationManager2>();
 recommendationManager->removeRecommendations(uuidVector);

Example for removing all recommendations sent from this package:

 Ptr<IRecommendationManager2> recommendationManager = component.QueryInterface<IRecommendationManager2>();
 recommendationManager->removeAllRecommendations();

Methods

addRecommendations2()

com.amazon.apmf.Uuid[] addRecommendations2(Recommendation2*[] recommendations)

The Recommendation Manager API adds recommendations to the recommendation manager database. The launcher queries the database and displays the recommendation home screen. The application has a predefined maximum limit of 20 concurrent recommendations, set by RecommendationManager. If this limit is exceeded, the system will delete older items based on their received timestamps. For recommendations using contentImageUri, the image will be downloaded asynchronously. If the image download fails, an error message is logged on the device and the recommendation is removed. Privilege: “com.amazon.privilege.security.file-sharing”

Parameters

recommendations

Recommendation2*[] — Required Array of Recommendation2 objects

Returns

com.amazon.apmf.Uuid[] Array of Uuids corresponding to added recommendations. Each Uuid corresponds to a recommendation and can be used for removing the recommendation in the future.

Throws

SecurityError — If calling the application does not have the required privilege.
InvalidArgumentError — If any of these conditions occur:
Recommendation size exceeds 512KB
Mandatory fields are empty or invalid
Both contentImage and contentImageUri are missing
The provided contentImage byte array doesn’t meet size or dimension requirements

​Interface IRecommendationManager2

​Methods

​addRecommendations2()

​Parameters