HandlesDynamicSearchRules
Table of Contents
Properties
Methods
- deleteAllDynamicSearchRules() : Task
- Delete all dynamic search rules.
- deleteDynamicSearchRule() : Task
- Delete a dynamic search rule.
- getDynamicSearchRule() : DynamicSearchRule
- Get a dynamic search rule.
- getDynamicSearchRules() : DynamicSearchRulesResults
- List dynamic search rules.
- updateDynamicSearchRule() : Task
- Create or update a dynamic search rule.
Properties
$dynamicSearchRules
protected
DynamicSearchRules
$dynamicSearchRules
Methods
deleteAllDynamicSearchRules()
Delete all dynamic search rules.
public
deleteAllDynamicSearchRules() : Task
This is an EXPERIMENTAL feature, which may break without a major version.
Tags
Return values
TaskdeleteDynamicSearchRule()
Delete a dynamic search rule.
public
deleteDynamicSearchRule(non-empty-string $uid) : Task
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $uid : non-empty-string
-
Dynamic search rule UID
Tags
Return values
TaskgetDynamicSearchRule()
Get a dynamic search rule.
public
getDynamicSearchRule(non-empty-string $uid) : DynamicSearchRule
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $uid : non-empty-string
-
Dynamic search rule UID
Tags
Return values
DynamicSearchRulegetDynamicSearchRules()
List dynamic search rules.
public
getDynamicSearchRules([DynamicSearchRulesQuery|null $options = null ]) : DynamicSearchRulesResults
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $options : DynamicSearchRulesQuery|null = null
Tags
Return values
DynamicSearchRulesResultsupdateDynamicSearchRule()
Create or update a dynamic search rule.
public
updateDynamicSearchRule(UpdateDynamicSearchRuleQuery $request) : Task
This is an EXPERIMENTAL feature, which may break without a major version.
Parameters
- $request : UpdateDynamicSearchRuleQuery