SearchQuery

Defined in: libs/ccs-files-user-client/src/core/types.ts:571

Extends

• PageQuery

Properties

after?

optional after?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:12

Inherited from

PageQuery.after

---

limit?

optional limit?: number

Defined in: libs/ccs-files-user-client/src/core/types.ts:13

Inherited from

PageQuery.limit

---

q?

optional q?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:572

---

in?

optional in?: ("name" | "keywords" | "content")[]

Defined in: libs/ccs-files-user-client/src/core/types.ts:579

Where q matches; default ['name', 'keywords']. name: names that start with the query, case-insensitively (a prefix, not a substring: IMG finds IMG_5913.jpg, 5913 does not). keywords: whole words of the title, description, tags, category, department and custom values (and of the name). With the default, a query no whole word matches falls back to the name prefix. content: whole words of the extracted text (with highlights).

---

folder_id?

optional folder_id?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:580

---

recursive?

optional recursive?: boolean

Defined in: libs/ccs-files-user-client/src/core/types.ts:581

---

kind?

optional kind?: FileKind[]

Defined in: libs/ccs-files-user-client/src/core/types.ts:582

---

mime_type?

optional mime_type?: string[]

Defined in: libs/ccs-files-user-client/src/core/types.ts:583

---

extension?

optional extension?: string[]

Defined in: libs/ccs-files-user-client/src/core/types.ts:584

---

created_from?

optional created_from?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:585

---

created_to?

optional created_to?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:586

---

updated_from?

optional updated_from?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:587

---

updated_to?

optional updated_to?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:588

---

status?

optional status?: FileStatus[]

Defined in: libs/ccs-files-user-client/src/core/types.ts:589

---

visibility?

optional visibility?: Visibility[]

Defined in: libs/ccs-files-user-client/src/core/types.ts:590

---

state?

optional state?: FileState[]

Defined in: libs/ccs-files-user-client/src/core/types.ts:591

---

owner_id?

optional owner_id?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:592

---

created_by_user_id?

optional created_by_user_id?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:593

---

created_by_client_id?

optional created_by_client_id?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:594

---

department?

optional department?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:595

---

category?

optional category?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:596

---

tags?

optional tags?: string[]

Defined in: libs/ccs-files-user-client/src/core/types.ts:597

---

tags_match?

optional tags_match?: "all" | "any"

Defined in: libs/ccs-files-user-client/src/core/types.ts:598

---

external_ref?

optional external_ref?: string

Defined in: libs/ccs-files-user-client/src/core/types.ts:599

---

min_size?

optional min_size?: number

Defined in: libs/ccs-files-user-client/src/core/types.ts:600

---

max_size?

optional max_size?: number

Defined in: libs/ccs-files-user-client/src/core/types.ts:601

---

custom?

optional custom?: Record<string, string>

Defined in: libs/ccs-files-user-client/src/core/types.ts:603

Exact matches on custom metadata (at most 5 keys), sent as custom.<key>=<value>.

---

sort?

optional sort?: "name" | "created_at" | "updated_at" | "size" | "relevance"

Defined in: libs/ccs-files-user-client/src/core/types.ts:604

---

order?

optional order?: "asc" | "desc"

Defined in: libs/ccs-files-user-client/src/core/types.ts:605