import Recommendation from '@npr/npr-one-sdk/model/recommendation.js'

public class | source

Recommendation

Extends:

CollectionDoc → Recommendation

Container class for all metadata pertaining to a recommendation.

Provides metadata and the recordAction method, which sends feedback on user actions to NPR's APIs and advances the flow of audio recommendations to the user

Test:

Recommendation

Constructor Summary

Public Constructor
public	constructor(json: CollectionDocJSON)

Member Summary

Public Members
public	attributes: RecommendationAttributes The metadata used to describe this recommendation, such as type and title
public	audio: Array<Link> The actual audio files associated with this recommendation; should never be empty
public	callsToAction: Array<Link> This is the `action` array from the API within `links`, and NOT this SDK's notion of Action
public	images: Array<ImageLink> A list of images associated with this recommendation; could be empty
public	impressions: Array<FormFactorLink> A list of API calls to make if this recommendation is of type `sponsorship` and the consuming client has played the accompanying audio
public	onramps: Array<Link> A list of links that are used as the canonical link(s) when sharing this story on social media
public	ratings: Array<Rating> An internal store of ratings collected for this application; should never be accessed directly by consumers
public	recommendations: Array<Link> A list of API calls the app can make to retrieve subsequent recommendations; should never be accessed directly by consumers
public	relatedImpressions: Array<FormFactorLink> A list of API calls to make if this recommendation is of type `sponsorship` and the consuming client has chosen to interact with the sponsorship item using the contents of relateds
public	relateds: Array<FormFactorLink> A list of links to places where the app can take the user if they interact with this `sponsorship` item
public	web: Array<Link> A list of links to other places where this story can be found on the web (for example, on NPR.org); could be empty

Method Summary

Public Methods
public	getActionRecommendationUrl(): string This method looks through the recommendation's action and related array to search for any URL starting with `'nprone://listen'`. If found, everything from the query params is appended to the original recommendation URL. This value is then used anytime a user indicates they want more similar stories by clicking or tapping on this recommendation. For many recommendations, this will not exist and getRecommendationUrl is used instead.
public	getAudio(): Array<Link> Returns the actual audio files associated with this recommendation
public	getCallsToAction(): Array<Link> This is the `action` array from the API within `links`, and NOT this SDK's notion of Action An example of what might be contained within this is array is a link to full-length content for a promo recommendation.
public	getImages(): Array<ImageLink> Returns a list of images associated with this recommendation
public	getImpressions(): Array<FormFactorLink> Returns a list of API calls to make if this recommendation is of type `sponsorship` and the consuming client has played the accompanying audio.
public	getOnRamps(): Array<Link> Returns a list of links that are used as the canonical link(s) when sharing this story on social media.
public	getRatings(): Array<Rating> Returns an internal store of ratings collected for this application.
public	getRecommendationUrl(): string Returns the URL that should be used to obtain the next set of recommendations.
public	getRelatedImpressions(): Array<FormFactorLink> Returns a list of API calls to make if this recommendation is of type `sponsorship` and the consuming client has chosen to interact with the sponsorship item using the contents returned by getRelateds.
public	getRelateds(): Array<FormFactorLink> Returns a list of links to places where the app can take the user if they interact with this `sponsorship` item (such as by clicking/tapping on the image or using a voice command to learn more)
public	getWeb(): Array<Link> Returns a list of links to other places where this story can be found on the web (for example, on NPR.org)
public	hasAction(action: string): boolean Returns whether this recommendation has a given action
public	hasEndAction(): boolean Returns whether this recommendation has received a rating indicating it is no longer being presented to the user
public	isShareable(): boolean Returns whether this recommendation is shareable on social media
public	isSponsorship(): boolean Returns whether this recommendation is of type `sponsorship`
public	recordAction(action: string, elapsedTimeInSeconds: number) Record a user action taken and the time it was taken against this recommendation
public	setRatingReceivedCallback(callback: Function) A callback which provides for communication of a received rating
public	toString(): string A convenience function to cast this object back to a string, generally only used by the Logger class.

Protected Methods
protected	_validate() Determines whether the collection doc has the required fields for a valid recommendation

Inherited Summary

From class CollectionDoc
public get	collectionDoc: CollectionDocJSON Exposed for legacy reasons.
protected	_raw: Object
protected	_validate() Ensure that the given Collection Doc is valid

Public Constructors

public constructor(json: CollectionDocJSON) source

Override:

CollectionDoc#constructor

Params:

Name	Type	Attribute	Description
json	CollectionDocJSON		The decoded JSON object that should be used as the basis for this model

Test:

Recommendation constructor

Public Members

public attributes: RecommendationAttributes source

The metadata used to describe this recommendation, such as type and title

public audio: Array<Link> source

The actual audio files associated with this recommendation; should never be empty

public callsToAction: Array<Link> source

This is the action array from the API within links, and NOT this SDK's notion of Action

public images: Array<ImageLink> source

A list of images associated with this recommendation; could be empty

public impressions: Array<FormFactorLink> source

A list of API calls to make if this recommendation is of type sponsorship and the consuming client has played the accompanying audio

public onramps: Array<Link> source

A list of links that are used as the canonical link(s) when sharing this story on social media

public ratings: Array<Rating> source

An internal store of ratings collected for this application; should never be accessed directly by consumers

public recommendations: Array<Link> source

A list of API calls the app can make to retrieve subsequent recommendations; should never be accessed directly by consumers

public relatedImpressions: Array<FormFactorLink> source

A list of API calls to make if this recommendation is of type sponsorship and the consuming client has chosen to interact with the sponsorship item using the contents of relateds

public relateds: Array<FormFactorLink> source

A list of links to places where the app can take the user if they interact with this sponsorship item

public web: Array<Link> source

A list of links to other places where this story can be found on the web (for example, on NPR.org); could be empty

Public Methods

public getActionRecommendationUrl(): string source

This method looks through the recommendation's action and related array to search for any URL starting with 'nprone://listen'. If found, everything from the query params is appended to the original recommendation URL. This value is then used anytime a user indicates they want more similar stories by clicking or tapping on this recommendation.

For many recommendations, this will not exist and getRecommendationUrl is used instead.

Return:

string

Test:

Recommendation getActionRecommendationUrl

public getAudio(): Array<Link> source

Returns the actual audio files associated with this recommendation

Return:

Array<Link>

Test:

Recommendation getAudio

public getCallsToAction(): Array<Link> source

This is the action array from the API within links, and NOT this SDK's notion of Action

An example of what might be contained within this is array is a link to full-length content for a promo recommendation.

Return:

Array<Link>

Test:

Recommendation getCallsToAction

public getImages(): Array<ImageLink> source

Returns a list of images associated with this recommendation

Return:

Array<ImageLink>

Test:

Recommendation getImages

public getImpressions(): Array<FormFactorLink> source

Returns a list of API calls to make if this recommendation is of type sponsorship and the consuming client has played the accompanying audio. Note that the SDK will take care of this automatically as long as the client uses recordAction to send the rating.

Return:

Array<FormFactorLink>

Test:

Recommendation getImpressions

public getOnRamps(): Array<Link> source

Returns a list of links that are used as the canonical link(s) when sharing this story on social media.

Return:

Array<Link>

Test:

Recommendation getOnRamps

public getRatings(): Array<Rating> source

Returns an internal store of ratings collected for this application. This should never be accessed directly by consumers; use recordAction to send ratings, and the SDK will figure out the appropriate time to make the API call that submits them to the server.

Return:

Array<Rating>

Test:

Recommendation getRatings

public getRecommendationUrl(): string source

Returns the URL that should be used to obtain the next set of recommendations. This should typically not be used by clients directly; use recordAction followed by NprOneSDK#getRecommendation instead.

Return:

string

Test:

Recommendation getRecommendationUrl

public getRelatedImpressions(): Array<FormFactorLink> source

Returns a list of API calls to make if this recommendation is of type sponsorship and the consuming client has chosen to interact with the sponsorship item using the contents returned by getRelateds. Note that the SDK will take care of this automatically as long as the client uses recordAction to send the rating.

Return:

Array<FormFactorLink>

Test:

Recommendation getRelatedImpressions

public getRelateds(): Array<FormFactorLink> source

Returns a list of links to places where the app can take the user if they interact with this sponsorship item (such as by clicking/tapping on the image or using a voice command to learn more)

Return:

Array<FormFactorLink>

Test:

Recommendation getRelateds

public getWeb(): Array<Link> source

Returns a list of links to other places where this story can be found on the web (for example, on NPR.org)

Return:

Array<Link>

Test:

Recommendation getWeb

public hasAction(action: string): boolean source

Returns whether this recommendation has a given action

Params:

Name	Type	Attribute	Description
action	string		Which action to look up; should be one of the static string constants returned by Action

Return:

boolean

Test:

Recommendation hasAction

public hasEndAction(): boolean source

Returns whether this recommendation has received a rating indicating it is no longer being presented to the user

Return:

boolean

Test:

Recommendation hasEndAction

public isShareable(): boolean source

Returns whether this recommendation is shareable on social media

Return:

boolean

Test:

Recommendation isShareable

public isSponsorship(): boolean source

Returns whether this recommendation is of type sponsorship

Return:

boolean

Test:

Recommendation isSponsorship

public recordAction(action: string, elapsedTimeInSeconds: number) source

Record a user action taken and the time it was taken against this recommendation

Params:

Name	Type	Attribute	Description
action	string		Which action to record; should be one of the static string constants returned by Action
elapsedTimeInSeconds	number		The number of seconds this piece of audio has been playing for

Test:

Recommendation recordAction

public setRatingReceivedCallback(callback: Function) source

A callback which provides for communication of a received rating

Params:

Name	Type	Attribute	Description
callback	Function	nullable: true	A function to call whenever this recommendation has received a rating (action)

public toString(): string source

A convenience function to cast this object back to a string, generally only used by the Logger class.

Return:

string

Test:

Recommendation toString

Protected Methods

protected _validate() source

Determines whether the collection doc has the required fields for a valid recommendation

Override:

CollectionDoc#_validate

Throw:

TypeError

if the collection doc is invalid