×

Nokia MixRadio types

This document covers objects returned by calls to the API.

The Response class

The Response class contains properties for getting details about the API response.

Table 1. Response Properties
Name Description
Error Gets the exception if the call was not successful.
Result Gets the result if the call was successful.

The ListResponse class

The ListResponse class extends the Response class with details for API responses that contain lists.

With V3 and above, the ListResponse class implements IList so you can bind the response directly to List controls and use the result as if it was a normal list.

Table 2. ListResponse Properties
Name Description
Error Gets the exception if the call was not successful.
Result Gets the result if the call was successful.
StartIndex Gets the start index the API call was asked for (when appropriate).
ItemsPerPage Gets the items per page the API call was asked for (when appropriate).
TotalResults Gets the total results available (when appropriate).

The MusicItem class

The MusicItem class is the base class for items from the MixRadio API such as Artists, Mixes and Products. It has the minimal properties that are guaranteed for these items.

Table 3. MusicItem Properties
Name Description
Id The ID of the item
Name The display name of the item.
Thumb50Uri Gets a URI to a 50px x 50px thumbnail (when available).
Thumb100Uri Gets a URI to a 100px x 100px thumbnail (when available).
Thumb200Uri Gets a URI to a 200px x 200px thumbnail (when available).
Thumb320Uri Gets a URI to a 320px x 320px thumbnail (when available).

The Artist class

The Artist class represents a musical artist.

Table 4. Artist Properties
Name Description
Id The ID of the artist.
Name The display name of the artist.
Country The artist's country of origin (when available).
Genres The artist's genres.
Location Gets the artist's approximate origin geocoordinates (when available).
Thumb50Uri Gets a URI to a 50px x 50px thumbnail (when available).
Thumb100Uri Gets a URI to a 100px x 100px thumbnail (when available).
Thumb200Uri Gets a URI to a 200px x 200px thumbnail (when available).
Thumb320Uri Gets a URI to a 320px x 320px thumbnail (when available).
Table 5. Artist Methods
Name Description
PlayMix Launches Nokia MixRadio to start a mix for the artist.
Show Launches Nokia MixRadio to show details for the artist.

The Genre class

The Genre class represents a musical genre such as "Rock".

Table 6. Genre Properties
Name Description
Id The ID of the genre.
Name The display name of the genre.

The MixGroup class

The MixGroup class represents a collection of Mixes.

An example MixGroup would be "New Releases" that has Mixes such as "Pop New Releases", "Rock New Releases", etc.

Table 7. MixGroup Properties
Name Description
Id The ID of the mix group.
Name The display name of the mix group.

The Mix class

The Mix class represents a collection of tracks that can be played through the Nokia MixRadio app.

Table 8. Mix Properties
Name Description
Id The ID of the mix.
Name The display name of the mix.
ParentalAdvisory Gets a boolean indicating whether the mix has a parental advisory warning.
Thumb50Uri Gets a URI to a 50px x 50px thumbnail (when available).
Thumb100Uri Gets a URI to a 100px x 100px thumbnail (when available).
Thumb200Uri Gets a URI to a 200px x 200px thumbnail (when available).
Thumb320Uri Gets a URI to a 320px x 320px thumbnail (when available).

The Product class

The Product class represents a purchasable music content such as albums, singles or individual tracks.

Table 9. Product Properties
Name Description
Id The ID of the product.
Name The display name of the product.
Category The product's category - i.e., whether it is an album, single, or track.
Genres The product's genres.
Performers The product's performers.
Price The product's price.
TakenFrom The owning Album or Single if appropriate.
TrackCount The track count for Album or Single products.
Thumb50Uri Gets a URI to a 50px x 50px thumbnail (when available).
Thumb100Uri Gets a URI to a 100px x 100px thumbnail (when available).
Thumb200Uri Gets a URI to a 200px x 200px thumbnail (when available).
Thumb320Uri Gets a URI to a 320px x 320px thumbnail (when available).
Table 10. Product Methods
Name Description
Show Launches Nokia MixRadio to show details for the product.

The Price class

The Price class contains a currency code and numeric value.

Table 11. Price Properties
Name Description
Currency Gets the currency of the price.
Value Gets the numeric value of the price.

The UserEvent class

The UserEvent class represents an item that a user has listened to.

Table 12. UserEvent Properties
Name Description
DateTime Gets the date time of the event.
Action Gets the UserEventAction type (see below).
Product Gets the product this action relates to.

The Category enumeration

The Category enumeration denotes the category of an item from the API and is used for filtering.

Table 13. Category Enumeration
Name Description
Artist Denotes an Artist.
Album Denotes an album product.
Single Denotes a single product - typically 2 or 3 tracks bundled together.
Track Denotes a single track product.

The UserEventAction enumeration

The UserEventAction enumeration denotes the type of action that was performed in a UserEvent.

Table 14. UserEventAction Enumeration
Name Description
Complete The track completed playing
SkipNext The track was skpped

The AuthScope enumeration

The AuthScope enumeration represents OAuth2 scopes for user data that can be used to ask the user for access.

Table 15. AuthScope Enumeration
Name Description
ReadUserPlayHistory Read user play history

The AuthResultCode enumeration

The AuthResultCode enumeration represents the result of requesting a user to log in and grant access to user data with the AuthenticateUserAsync method.

Table 16. AuthResultCode Enumeration.
Name Description
Success Completed Successfully.
Cancelled Cancelled by user.
AccessDenied Access denied by user.
UnauthorizedClient The client id was not valid.
InvalidScope An invalid scope was specified.
ServerError A server error occurred.
FailedToRefresh An error occurred trying to refresh an existing token.
NoCachedToken A silent refresh from an existing token was not possible as there is no cached token.

The SortOrder enumeration

The SortOrder enumeration is used to change sorting of results in the Search and GetArtistProducts methods.

Table 17. SortOrder Enumeration
Name Description
Ascend Items are ordered ascending (default).
Descend Items are ordered descending.

The OrderBy enumeration

The OrderBy enumeration is used to change sorting of results in the Search and GetArtistProducts methods.

Table 18. OrderBy Enumeration
Name Description
Relevance Items are ordered by relevance (default).
Name Items are ordered by name.
ReleaseDate Items are ordered by release date.


Last updated 20 November 2013

Back to top

Was this page helpful?

Your feedback about this content is important. Let us know what you think.

 

Thank you!

We appreciate your feedback.

×