Ranking Orders
- Order by Number of Favorites for artist (highest to lowest) (default)
- Order by Number of Favorites for Artist (lowest to highest)
- Order by Number of User Favorites (highest to lowest)
- Order by Number of User Favorites (lowest to highest)
Additional Supported Parameters
In addition to the Common Function Parameters defined in the Jamroom Ranking System Guide, the "favorite" mode also supports the following additional parameters:
| PARAMETER |
TYPE |
DEFAULT |
DESCRIPTION |
| type |
string |
n/a |
The "type" parameter tells Jamroom the type of favorite to retrieve - either "audio" or "video". This parameter is required for the list to function properly. |
| user_id |
number |
n/a |
The "user_id" parameter tells Jamroom that you want to view the Audio or Video Favorites for a specific Jamroom User ID. |
Available search_area values
There are no supported search_area values for the Favorite mode.
Template Variables for use in the row_template
In addition to the following Template Variables, you also have access to:
| VARIABLE |
DESCRIPTION |
| {$FAVORITE_RANK} |
The numerical position on the output result set (starting at 1). |
| {$COUNT} |
The number of times the Media item (song or video) has been played by the User. |
| {$USER_ID} |
Jamroom User ID for the User Account the favorite belongs to. |
| {$USER_BAND_ID} |
The Profile ID for the User Account the favorite belongs to. |
| {$USER_CREATED} |
The 11 digit epoch time for the User Account the favorite belongs to. |
| {$USER_UPDATED} |
The 11 digit epoch time for the User Account the favorite belongs to. |
| {$USER_LASTLOGIN} |
The 11 digit epoch time for the User Account the favorite belongs to. |
| {$USER_NICKNAME} |
The Login name for the User Account the favorite belongs to. |
| {$USER_FULLNAME} |
The Full Name for the User Account the favorite belongs to. |
| {$USER_EMAILADR} |
The Email Address for the User Account the favorite belongs to. |
| {$USER_HOMEPAGE} |
The URL entered by the User Account the favorite belongs to into their User Profile for their "homepage". |
| {$USER_IMNUMBER} |
The value entered by the User as the "Instant Messenger" number in their Profile. |
| {$USER_IP} |
The IP Address the User last logged in from. |
| {$USER_GENDER} |
The Gender of the user as selected in their Profile. 0 = "unknown", 1 = "male", 2 = "female" |
| {$USER_BIRTHDATE} |
The 11 digit epoch time for the Birth date the User has selected in their Profile. |
| {$USER_ADDRESS} |
The Address the User has entered into their Profile |
| {$USER_OCCUPATION} |
The value the User has entered into the "Occupation" field in their Profile. |
| {$USER_INTERESTS} |
The value the User has entered into the "Interests" field in their Profile. |
| {$USER_SHOW_EMAIL} |
Will be set to "0" if the User has chosen to NOT display their E-Mail Address, otherwise it will be set to "0". |
| {$USER_EDITOR} |
Will be set to "1" if the User is a Content Editor, otherwise set to "0". |
| {$USER_GLOBAL_EDITOR} |
Will be set to "1" if the User is a Global Content Editor, otherwise set to "0". |
|
