SearchConditionArray

This struct contains an array of MF_SearchCondition structures.

Name	Description	Type
value	An array of the MF_SearchCondition structures.	SearchCondition[]

Helper Methods and Properties

⚠️ Note

These helper methods and properties are available when using the npm package @m-filescorporation/uix-vault-messages. Install it in your project to use these helpers. For more information, see Overview/VaultMessages/.

Factory Methods

Method	Description	Parameters	Returns
Create	Creates a new SearchConditionArray object.	conditions: Array<SearchCondition>	SearchConditionArray

Instance Methods

Method	Description	Parameters	Returns
Text	Creates a text search condition and adds it to the array.	options: FTSFLAGS condition: ConditionType value: string	SearchConditionArray
Status	Creates a status search condition and adds it to the array.	type: StatusType condition: ConditionType dataType: Datatype value: TypedValueValueMap[T]	SearchConditionArray
StatusWithTypedValue	Creates a status search condition and adds it to the array.	type: StatusType condition: ConditionType value: TypedValue	SearchConditionArray
Property	Creates a property search condition and adds it to the array.	propertyDef: number condition: ConditionType dataType: Datatype value: TypedValueValueMap[T]	SearchConditionArray
PropertyWithTypedValue	Creates a property search condition and adds it to the array.	propertyDef: number condition: ConditionType value: TypedValue	SearchConditionArray
AnyLookupProperty	Creates an any lookup property search condition and adds it to the array.	valueList: number condition: ConditionType value: Lookup | number | Array<Lookup | number>	SearchConditionArray

Creating Objects

// Creates a new SearchConditionArray object.
const result = SearchConditionArray.Create([]);

Working with Objects

// Extension helpers for SearchConditionArray instances
// Creates a text search condition and adds it to the array.
const result = searchconditionarrayInstance.Text({}, 0, "example string");

// Creates a status search condition and adds it to the array.
const result = searchconditionarrayInstance.Status(0, 0, 0);

// Creates a status search condition and adds it to the array.
const result = searchconditionarrayInstance.StatusWithTypedValue(
  0,
  0,
  TypedValue.Text("example text"),
);

// Creates a property search condition and adds it to the array.
const result = searchconditionarrayInstance.Property(0, 0, 0);

// Creates a property search condition and adds it to the array.
const result = searchconditionarrayInstance.PropertyWithTypedValue(
  0,
  0,
  TypedValue.Text("example text"),
);

// Creates an any lookup property search condition and adds it to the array.
const result = searchconditionarrayInstance.AnyLookupProperty(
  0,
  0,
  new Lookup(),
);

Example

{
  "value": [] /* Array of SearchCondition */
}