s&box docs

public class Sandbox.Storage.Query

Query the Steam Workshop for items

Broader workflow and conceptual references connected to this API.

Constructors

Showing 1 constructors

Methods

Showing 1 methods

public System.Threading.Tasks.Task`1<Sandbox.Storage.QueryResult> Run(System.Threading.CancellationToken token = null)

Run the query

Parameters

  • token: Default: null

Properties

Showing 9 properties

public Sandbox.SteamId Sandbox.Storage.Query.Author { get; set; }

Filter results to items published by this Steam ID. When set, uses a user-specific query instead of a global one.

public System.Collections.Generic.List`1<ulong> Sandbox.Storage.Query.FileIds { get; set; }

Specific workshop file IDs to query. When set, other filters are ignored and the query returns details for these specific items.

public System.Collections.Generic.Dictionary`2<string,string> Sandbox.Storage.Query.KeyValues { get; set; }

KeyValues that the item must match to be included in results.

public int Sandbox.Storage.Query.MaxCacheAge { get; set; }

Max Cache Age in seconds

public int Sandbox.Storage.Query.RankTrendDays { get; set; }

Number of days to consider for rank trend calculations

public string Sandbox.Storage.Query.SearchText { get; set; }

Search Text

public System.Collections.Generic.HashSet`1<string> Sandbox.Storage.Query.TagsExcluded { get; set; }

Tags that the item must not have any of to be included in results.

public System.Collections.Generic.HashSet`1<string> Sandbox.Storage.Query.TagsRequired { get; set; }

Tags that the item must have all of to be included in results.

Metadata

FieldValue
Namespaceglobal
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.Storage.Query

On this page