AWSChimeSDKMessagingSearchField

Objective-C

@interface AWSChimeSDKMessagingSearchField

Swift

class AWSChimeSDKMessagingSearchField

A Field of the channel that you want to search.

Required parameters: [Key, Values, Operator]

  • key

    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.

    Declaration

    Objective-C

    @property (nonatomic) AWSChimeSDKMessagingSearchFieldKey key;

    Swift

    var key: AWSChimeSDKMessagingSearchFieldKey { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSChimeSDKMessagingSearchFieldOperator operator;

    Swift

    var `operator`: AWSChimeSDKMessagingSearchFieldOperator { get set }

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

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable values;

    Swift

    var values: [String]? { get set }