Class: Query
Constructors
constructor
• new Query()
Methods
and
▸ Static and(queryExpressions): SearchPortalQuery
Parameters
| Name | Type |
|---|---|
queryExpressions | SearchPortalQuery[] |
Returns
checkbox
▸ Static checkbox(matches): SearchPortalCheckboxQueryExpression
Parameters
| Name | Type |
|---|---|
matches | CheckboxMatcher |
Returns
SearchPortalCheckboxQueryExpression
date
▸ Static date<Matcher>(matches): SearchPortalDateQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends IsEmpty | IsNotEmpty |
Parameters
| Name | Type |
|---|---|
matches | Matcher |
Returns
SearchPortalDateQueryExpression
▸ Static date<Matcher>(matches, date): SearchPortalDateQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends Is | IsBefore | IsAfter | IsOnOrBefore | IsOnOrAfter |
Parameters
| Name | Type | Description |
|---|---|---|
matches | Matcher | - |
date | Date | RelativeDateMatcher |
Returns
SearchPortalDateQueryExpression
▸ Static date<Matcher>(matches, date1, date2): SearchPortalDateQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends IsBetween |
Parameters
| Name | Type | Description |
|---|---|---|
matches | Matcher | - |
date1 | Date | RelativeDateMatcher | |
date2 | Date | RelativeDateMatcher |
Returns
SearchPortalDateQueryExpression
dateRelativeToToday
▸ Static dateRelativeToToday<Modifier>(relativeDateModifier, relativeDatePeriod): SearchPortalDateQueryExpression
Type parameters
| Name | Type |
|---|---|
Modifier | extends This |
Parameters
| Name | Type | Description |
|---|---|---|
relativeDateModifier | Modifier | |
relativeDatePeriod | RelativeDatePeriod |
Returns
SearchPortalDateQueryExpression
▸ Static dateRelativeToToday<Modifier>(relativeDateModifier, relativeDatePeriod, daysOffset): SearchPortalDateQueryExpression
Type parameters
| Name | Type |
|---|---|
Modifier | extends Past | Next |
Parameters
| Name | Type |
|---|---|
relativeDateModifier | Modifier |
relativeDatePeriod | RelativeDatePeriod |
daysOffset | number |
Returns
SearchPortalDateQueryExpression
documentsThatContain
▸ Static documentsThatContain(remId): SearchPortalRefQueryExpression
Parameters
| Name | Type |
|---|---|
remId | string |
Returns
SearchPortalRefQueryExpression
hasAnyConnectionTo
▸ Static hasAnyConnectionTo(remId): SearchPortalRefQueryExpression
Parameters
| Name | Type |
|---|---|
remId | undefined | string |
Returns
SearchPortalRefQueryExpression
hasReferenceTo
▸ Static hasReferenceTo(remId): SearchPortalRefQueryExpression
Parameters
| Name | Type | Description |
|---|---|---|
remId | string |
Returns
SearchPortalRefQueryExpression
hasRemType
▸ Static hasRemType(remType): SearchPortalRemTypeQueryExpression
Parameters
| Name | Type | Description |
|---|---|---|
remType | QueryRemType |
Returns
SearchPortalRemTypeQueryExpression
isDescendantOf
▸ Static isDescendantOf(remId): SearchPortalRefQueryExpression
Parameters
| Name | Type | Description |
|---|---|---|
remId | string |
Returns
SearchPortalRefQueryExpression
isDirectlyTaggedWith
▸ Static isDirectlyTaggedWith(remId): SearchPortalRefQueryExpression
Parameters
| Name | Type |
|---|---|
remId | string |
Returns
SearchPortalRefQueryExpression
isInDocument
▸ Static isInDocument(remId): SearchPortalRefQueryExpression
Parameters
| Name | Type | Description |
|---|---|---|
remId | undefined | string |
Returns
SearchPortalRefQueryExpression
isTaggedWith
▸ Static isTaggedWith(remId): SearchPortalRefQueryExpression
Parameters
| Name | Type | Description |
|---|---|---|
remId | string |
Returns
SearchPortalRefQueryExpression
multiSelect
▸ Static multiSelect<Matcher>(matches): SearchPortalMultiSelectQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends IsEmpty | IsNotEmpty |
Parameters
| Name | Type |
|---|---|
matches | Matcher |
Returns
SearchPortalMultiSelectQueryExpression
▸ Static multiSelect<Matcher>(matches, remIds): SearchPortalMultiSelectQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends MultiSelectMatcher |
Parameters
| Name | Type |
|---|---|
matches | Matcher |
remIds | string[] |
Returns
SearchPortalMultiSelectQueryExpression
not
▸ Static not(queryExpressions): SearchPortalQuery
Parameters
| Name | Type |
|---|---|
queryExpressions | SearchPortalQuery |
Returns
number
▸ Static number<Matcher>(matches): SearchPortalNumberQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends IsEmpty | IsNotEmpty |
Parameters
| Name | Type |
|---|---|
matches | Matcher |
Returns
SearchPortalNumberQueryExpression
▸ Static number<Matcher>(matches, n): SearchPortalNumberQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends NumberMatcher |
Parameters
| Name | Type |
|---|---|
matches | Matcher |
n | number |
Returns
SearchPortalNumberQueryExpression
or
▸ Static or(queryExpressions): SearchPortalQuery
Parameters
| Name | Type |
|---|---|
queryExpressions | SearchPortalQuery[] |
Returns
singleSelect
▸ Static singleSelect<Matcher>(matches): SearchPortalSingleSelectQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends IsEmpty | IsNotEmpty |
Parameters
| Name | Type |
|---|---|
matches | Matcher |
Returns
SearchPortalSingleSelectQueryExpression
▸ Static singleSelect<Matcher>(matches, remIds): SearchPortalSingleSelectQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends SingleSelectMatcher |
Parameters
| Name | Type |
|---|---|
matches | Matcher |
remIds | string[] |
Returns
SearchPortalSingleSelectQueryExpression
tableColumn
▸ Static tableColumn(columnId, query): SearchPortalSlotQueryNode
Parameters
| Name | Type | Description |
|---|---|---|
columnId | string | |
query | SearchPortalQuery |
Returns
tagWithoutInheritance
▸ Static tagWithoutInheritance(remId): SearchPortalRefQueryExpression
Parameters
| Name | Type |
|---|---|
remId | string |
Returns
SearchPortalRefQueryExpression
text
▸ Static text<Matcher>(matches): SearchPortalTextQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends IsEmpty | IsNotEmpty |
Parameters
| Name | Type |
|---|---|
matches | Matcher |
Returns
SearchPortalTextQueryExpression
▸ Static text<Matcher>(matches, text): SearchPortalTextQueryExpression
Type parameters
| Name | Type |
|---|---|
Matcher | extends TextMatcher |
Parameters
| Name | Type |
|---|---|
matches | Matcher |
text | string |