documenting the different query cases

This commit is contained in:
Adam Brown 2021-10-27 14:32:51 +01:00
parent dbb4a87784
commit e7a0a4d4ae

View File

@ -35,8 +35,23 @@ sealed interface QueryStringValue {
data class Contains(override val string: String, override val case: Case = Case.SENSITIVE) : ContentQueryStringValue
enum class Case {
/**
* Match query sensitive to case
*/
SENSITIVE,
/**
* Match query insensitive to case, this only works for Latin-1 character sets
*/
INSENSITIVE,
/**
* Match query with input normalized (case insensitive)
* Works around Realms inability to sort or filter by case for non Latin-1 character sets
* Expects the target field to contain normalized data
*
* @see org.matrix.android.sdk.internal.util.Normalizer.normalize
*/
NORMALIZED
}
}