SearchQuery

Defined in: libs/ccs-files-client/src/types.ts:687

Extends

• PageQuery

Properties

after?

optional after?: string

Defined in: libs/ccs-files-client/src/types.ts:22

Inherited from

PageQuery.after

---

limit?

optional limit?: number

Defined in: libs/ccs-files-client/src/types.ts:23

Inherited from

PageQuery.limit

---

q?

optional q?: string

Defined in: libs/ccs-files-client/src/types.ts:688

---

in?

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

Defined in: libs/ccs-files-client/src/types.ts:696

Default ['name', 'keywords']. name matches names that start with the query, case-insensitively (a prefix, not a substring: IMG finds IMG_5913.jpg, 5913 does not). keywords matches whole words in the name, title, description, tags, category, department and custom values; with the default, a query no whole word matches falls back to the name prefix. content matches the text extracted from documents (PDF, Word, PowerPoint, Excel, OpenDocument, text, HTML, JSON): whole words, a quoted phrase as a phrase; a hit carries highlights.

---

folder_id?

optional folder_id?: string

Defined in: libs/ccs-files-client/src/types.ts:697

---

recursive?

optional recursive?: boolean

Defined in: libs/ccs-files-client/src/types.ts:698

---

kind?

optional kind?: FileKind[]

Defined in: libs/ccs-files-client/src/types.ts:699

---

mime_type?

optional mime_type?: string[]

Defined in: libs/ccs-files-client/src/types.ts:700

---

extension?

optional extension?: string[]

Defined in: libs/ccs-files-client/src/types.ts:701

---

created_from?

optional created_from?: string

Defined in: libs/ccs-files-client/src/types.ts:702

---

created_to?

optional created_to?: string

Defined in: libs/ccs-files-client/src/types.ts:703

---

updated_from?

optional updated_from?: string

Defined in: libs/ccs-files-client/src/types.ts:704

---

updated_to?

optional updated_to?: string

Defined in: libs/ccs-files-client/src/types.ts:705

---

status?

optional status?: FileStatus[]

Defined in: libs/ccs-files-client/src/types.ts:706

---

visibility?

optional visibility?: Visibility[]

Defined in: libs/ccs-files-client/src/types.ts:707

---

state?

optional state?: FileState[]

Defined in: libs/ccs-files-client/src/types.ts:708

---

owner_id?

optional owner_id?: string

Defined in: libs/ccs-files-client/src/types.ts:709

---

created_by_user_id?

optional created_by_user_id?: string

Defined in: libs/ccs-files-client/src/types.ts:710

---

created_by_client_id?

optional created_by_client_id?: string

Defined in: libs/ccs-files-client/src/types.ts:711

---

department?

optional department?: string

Defined in: libs/ccs-files-client/src/types.ts:712

---

category?

optional category?: string

Defined in: libs/ccs-files-client/src/types.ts:713

---

tags?

optional tags?: string[]

Defined in: libs/ccs-files-client/src/types.ts:714

---

tags_match?

optional tags_match?: "all" | "any"

Defined in: libs/ccs-files-client/src/types.ts:715

---

external_ref?

optional external_ref?: string

Defined in: libs/ccs-files-client/src/types.ts:716

---

min_size?

optional min_size?: number

Defined in: libs/ccs-files-client/src/types.ts:717

---

max_size?

optional max_size?: number

Defined in: libs/ccs-files-client/src/types.ts:718

---

custom?

optional custom?: Record<string, string>

Defined in: libs/ccs-files-client/src/types.ts:720

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-client/src/types.ts:721

---

order?

optional order?: "asc" | "desc"

Defined in: libs/ccs-files-client/src/types.ts:722