Type Alias: FilterableProperty

FilterableProperty = PropertyIdentifier<string>

Defined in: schema.ts:1110

A property that will be used to filter the results of a search.

For example, if you want to allow users to query for all emails last modified in the last 30 days, you would add the property that represents the last modified date to filterableProperties.

Filterable properties may be one of the following types: ValueType.Boolean, ValueType.Number, ValueType.String, ValueHintType.Person or an object with userEmailProperty or userIdProperty specified

Filterable properties that are arrays may have one of the following item types: ValueType.Number, ValueType.String, ValueHintType.Person or an object with userEmailProperty or userIdProperty specified.

For filtering purposes, number values will be rounded down to the nearest integer.