Interface SearchOptions

Represents search options for querying files.

interface SearchOptions {
    binModifiedAt?: SearchCriteria;
    createdAt?: SearchCriteria;
    db?: DatabaseSearchCriteria;
    dbLang?: string;
    description?: SearchCriteria;
    folderId?: string;
    limit?: number;
    modifiedAt?: SearchCriteria;
    name?: SearchCriteria;
    offset?: number;
    recursive?: boolean;
    tagId?: string;
    tagName?: string;
}

Properties

binModifiedAt? createdAt? db? dbLang? description? folderId? limit? modifiedAt? name? offset? recursive? tagId? tagName?

Properties

OptionalbinModifiedAt

binModifiedAt?: SearchCriteria

Search criteria for the last time the file was modified.

OptionalcreatedAt

createdAt?: SearchCriteria

Search criteria for file creation time.

Optionaldb

db?: DatabaseSearchCriteria

Search criteria for database fields.

OptionaldbLang

dbLang?: string

The database language (required if using db field for search).

Optionaldescription

description?: SearchCriteria

Search criteria for the file description.

OptionalfolderId

folderId?: string

The Studio folder ID to search within.

Optionallimit

limit?: number

The maximum number of results to return.

OptionalmodifiedAt

modifiedAt?: SearchCriteria

Search criteria for file information modification time.

Optionalname

name?: SearchCriteria

Search criteria for the file name.

Optionaloffset

offset?: number

The number of results to skip before returning results.

Optionalrecursive

recursive?: boolean

Whether to include subfolders in the search.

OptionaltagId

tagId?: string

Find by tag ID. Exact match.

OptionaltagName

tagName?: string

Find by tag name. Exact match.

Settings

Member Visibility

On This Page

Properties