steam_ugc_query_set_allow_cached_response

Sets whether to check the local cache for the query.

Syntax:

steam_ugc_query_set_allow_cached_response(ugc_query_handle , cache);


Argument Description
ugc_query_handle The query handle to use.
cache Whether to have the query check the local cache or not.


Returns: Boolean


Description

This function can be used to further filter any given UGC query, specifically to request that the query check the local cache rather than online. 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 either true or false. 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_add_required_tag(query_handle, "RPG");
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_send_query
© Copyright YoYo Games Ltd. 2018 All Rights Reserved