chimesdkmessaging/aws.sdk.kotlin.services.chimesdkmessaging.model/SearchField

SearchField

class SearchField

A Field of the channel that you want to search.

This operation isn't supported for AppInstanceUsers with a large number of memberships.

Types

Builder

class Builder

Companion

object Companion

Properties

key

val key: SearchFieldKey

An enum value that indicates the key to search the channel on. MEMBERS allows you to search channels based on memberships. You can use it with the EQUALS operator to get channels whose memberships are equal to the specified values, and with the INCLUDES operator to get channels whose memberships include the specified values.

operator

val operator: SearchFieldOperator

The operator used to compare field values, currently EQUALS or INCLUDES. Use the EQUALS operator to find channels whose memberships equal the specified values. Use the INCLUDES operator to find channels whose memberships include the specified values.

values

val values: List<String>

The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.

Functions

copy

inline fun copy(block: SearchField.Builder.() -> Unit = {}): SearchField

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String