|
|
|
Ranking Orders
- Order by Action time (newest to oldest) (default)
- Order by Action time (oldest to newest
- Order Randomly
Additional Supported Parameters
In addition to the Common Function Parameters defined in the Jamroom Ranking System Guide, the "action" mode also supports the following additional parameters:
| PARAMETER |
TYPE |
DEFAULT |
DESCRIPTION |
| user_id |
number |
n/a |
If a user_id parameter is given, then only Action entries from the specified user_id(s) will be shown. Multiple user_id's may be entered either as an array, or as a comma separated list of numbers. |
| fan_band_id |
number |
n/a |
If the fan_band_id parameter is given, then only Actions from Fans or Friends of the given band_id will be returned. |
| media_type |
string |
n/a |
If the media_type parameter is given, then only Action entries pertaining to the given media_type will be show. Valid media_types are: custom, song, video, message, event, photo, radio, channel and vault. |
Available search_area values
| SEARCH_AREA |
DESCRIPTION |
| action_media_name |
The "action_media_name" search_area will search the action_media_name column of the jamroom_actions table - this would be the name of the media item create/updated/deleted, or "custom" if the Action is a custom entry. |
| action_code |
The "action_code" search area will search for a specific entry in the "action_code" column of the jamroom_actions_table. Valid action_code values are:
- band_create (profile created)
- band_modify (profile modified)
- profile_theme_change
- event_create
- event_modify
- event_delete
- blog_create
- blog_update
- blog_delete
- radio_stream *
- channel_stream *
- hifi_download *
- lofi_download *
- video_download *
- song_hifi (stream) *
- song_lofi (stream) *
- video (stream) *
- radio_create
- radio_update
- radio_delete
- channel_create
- channel_update
- channel_delete
- song_create
- song_update
- song_delete
- item_create
- item_update
- item_delete
- photo_create
- photo_update
- photo_delete
- fan_order (changed fan/friend order)
- fan_delete (remove a fan/friend from profile)
- fan_remove (is no longer a fan/friend of)
- fan_invite_accept (become fan of)
- vault_create
- vault_update
- vault_delete
- video_create
- video_update
- video_delete
- custom (custom user entry)
* requires Jamroom Advanced Config Key option to be enabled.
|
Template Variables available in the row_template
In addition to the following Template Variables, you also have access to:
| VARIABLE |
DESCRIPTION |
| {$ACTION_RANK} |
The numerical value of its placement in the result set from the Jamroom Ranking System. |
| {$USER_IMAGE_URL} |
The URL to the image for the User that created the action entry - to be used in the src parameter if an <img> HTML tag. |
| {$ACTION_BAND_ID} |
The Profile ID (band_id) of the User that created the action. |
| {$ACTION_USER_ID} |
The User ID (user_id) of the User that created the action. |
| {$ACTION_TIME} |
The epoch time stamp the action entry was saved. |
| {$ACTION_QUOTA_ID} |
The Jamroom Quota ID of the profile for the User that created the action. |
| {$ACTION_MEDIA_ID} |
The numerical ID of the Media Item pertaining to the action - this would be the song_id, video_id, photo_id, event_id, vault_id, message_id, etc. |
| {$ACTION_MEDIA_TYPE} |
This is a string that categorizes the "type" of action - will be one of: custom, song, video, item, message, event, photo, radio, channel, vault, download or stream. |
| {$ACTION_MEDIA_NAME} |
If the Media Item that is related to the action has a title, then the title will be here - this corresponds to the Song Name, Video Name, etc. |
| {$ACTION_CODE} |
The Action Code is a more specific version of the {$ACTION_MEDIA_TYPE}, in that it also defines the actual "action" that was recorded - i.e. "custom", "photo_update", "song_delete", etc. |
| {$ACTION_TEXT} |
The Action Text contains the actual text of what the recorded Action was - if it was a custom Action entry, it will be the "status update" the user entered. |
|
|
|
