steam_ugc_query_set_ranked_by_trend_days

Sets the number of days over which to run the query.

Syntax:

steam_ugc_query_set_ranked_by_trend_days(ugc_query_handle , days);


Argument Description
ugc_query_handle The query handle to use.
days The number of days to query.


Returns: Boolean


Description

This function can be used to further filter any UGC query made using the ugc_query_RankedByTrend constant, specifically to search over a number of days. The query handle is the value returned when you created the query (using, for example, steam_ugc_create_query_user()) and the second argument is the number of days over which you want the query to run. The function will return true if the query filter was correctly set, or false otherwise.


Example:

var query_handle = steam_ugc_create_query_all(ugc_query_RankedByTrend, ugc_match_Items, 1);
steam_ugc_query_set_ranked_by_trend_days(query_handle, 5);
steam_ugc_query_set_return_long_description(query_handle, true);
steam_ugc_query_set_allow_cached_response(query_handle, true);
query_ID = steam_ugc_send_query(query_handle);

The above code creates a query request and stores it's handle in a local variable for future use in the rest of the functions which further define the query request before sending the query.

Back: Steam API - User Generated Content
Next: steam_ugc_query_add_required_tag
© Copyright YoYo Games Ltd. 2015 All Rights Reserved