Viv JavaScript Runtime - v0.10.2
    Preparing search index...

    Interface RunSearchQueryArgs

    Arguments parameterizing a request to run a specified search query.

    These are the effective arguments to runSearchQuery.

    interface RunSearchQueryArgs {
        queryName: string;
        limit?: number;
        precastBindings?: RoleBindings;
        searchDomain?: string;
    }
    Index

    Properties

    queryName limit? precastBindings? searchDomain?

    Properties

    queryName: string

    The name of the query to run.

    limit?: number

    The maximum number of query matches to return.

    If omitted, all matches are returned.

    Integers are most sensible, and any value here must be greater than or equal to one.

    precastBindings?: RoleBindings

    Partial or complete role bindings to use when running the search query.

    searchDomain?: string

    The entity ID for a character whose memories will serve as the search domain, if any.

    When this field is present, the search query is run against the given character's memories, and otherwise the pattern is run against the entire chronicle -- meaning all actions that have ever occurred in the simulation instance at hand. If the specified search query uses memory criteria (the salience and/or associations fields), an error will be thrown if a search domain is not provided.

    Settings

    Member Visibility

    On This Page

    Properties