ISearchQuery

Interface representing a search query with various configuration options.

Methods

getUser

getUser(): string

Returns the user for whom the query is executed.

Returns

string

the user title for whom the query is executed.

---

isDisablePatternExtension

isDisablePatternExtension(): boolean

Returns whether pattern extension is disabled for the query.

Returns

boolean

true if pattern extension is disabled, false otherwise.

---

isDisablePermissions

isDisablePermissions(): boolean

Returns whether permissions are disabled for the query.

Returns

boolean

true if permissions are disabled, false otherwise.

---

setDisablePatternExtension

setDisablePatternExtension(pDisablePatternExtension): ISearchQuery

Sets whether pattern extension is disabled for the query.

Parameters

pDisablePatternExtension

boolean

true to disable pattern extension, false to enable it.

Returns

ISearchQuery

the updated search query instance.

---

setDisablePermissions

setDisablePermissions(pDisablePermissions): ISearchQuery

Sets whether permissions are disabled for the query.

Parameters

pDisablePermissions

boolean

true to disable permissions, false to enable them.

Returns

ISearchQuery

the updated search query instance.

---

setUser

setUser(pUser): ISearchQuery

Sets the user for whom the query is executed.

Parameters

pUser

string | number | boolean

the user title for whom the query is executed.

Returns

ISearchQuery

the updated search query instance.