Instance Method

initWithRecipients:senders:searchTerms:attributes:dateTimeRange:identifiers:notificationIdentifiers:speakableGroupNames:conversationIdentifiers:

Initializes a search messages intent object with the specified search criteria.

Declaration

- (instancetype)initWithRecipients:(NSArray<INPerson *> *)recipients senders:(NSArray<INPerson *> *)senders searchTerms:(NSArray<NSString *> *)searchTerms attributes:(INMessageAttributeOptions)attributes dateTimeRange:(INDateComponentsRange *)dateTimeRange identifiers:(NSArray<NSString *> *)identifiers notificationIdentifiers:(NSArray<NSString *> *)notificationIdentifiers speakableGroupNames:(NSArray<INSpeakableString *> *)speakableGroupNames conversationIdentifiers:(NSArray<NSString *> *)conversationIdentifiers;

Parameters

recipients

The recipients of the messages. You can specify multiple people to search for messages received by multiple users.

senders

The senders of the messages. You can specify multiple people to search for messages sent by multiple users.

searchTerms

An array of terms to look for in the message contents. Each term constitutes a search string to be matched in the message contents.

attributes

Additional message attributes to consider during the search. For a list of possible values, see INMessageAttributeOptions.

dateTimeRange

The dates associated with the messages. Use this parameter to specify the range of dates to search.

identifiers

The identifier strings of the messages. Use this parameter when you want to specify messages based on their unique ID.

notificationIdentifiers

An array of identifiers from UNNotification objects. Use this parameter to search the notifications associated with your app.

speakableGroupNames

An array of strings representing any group addresses receiving the message.

conversationIdentifiers

An array of conversation identifiers. Use this parameter to search one or more conversations.

Return Value

An initialized intent or nil if the object could not be created.

Discussion

Typically, you don’t create instances of this class yourself. Siri creates instances when the user asks to search their messages. However, you can use this method during testing to create intent objects in order to validate your intent handling code paths. Specify nil for any parameters that you do not want used during the search.