Contents

setMessageReadStatus

An intent schema that changes the message read status to a given value.

Declaration

var setMessageReadStatus: some AppSchemaIntent { get }

Discussion

To make your app’s actions available to Apple Intelligence, conform your AppIntent to a schema that describes your action to the system. If your app’s functionality aligns with the messages domain and one of your app’s actions matches the setMessageReadStatus schema, you can generate the properties and protocol conformance the schema requires for your intent implementation with the @AppIntent( .messages.setMessageReadStatus) Swift macro. To make your app work with Siri, see Apple Intelligence and Siri AI.

The following example shows an intent that conforms to the setMessageReadStatus schema:

@AppIntent(schema: .messages.setMessageReadStatus)
struct SetMessageReadStatusIntent {
    var message: <#MessageEntity#>
    var isRead: Bool

    func perform() async throws -> some IntentResult {
        <#code#>
    }
}

The schema supports the following system experiences:

  • Siri

  • Shortcuts

For more information about the App Intents framework and the experiences it supports, see Getting started with the App Intents framework.

See Also

Actions