Class

# NotificationResponseAction

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

The base class for the types of actions a user can take in response to a notification.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                                                        | Type                               | Read-Only | Shared |
|-----------------------------------------------------------------------------|------------------------------------|-----------|--------|
| `AuthenticationRequired<notificationresponseaction.authenticationrequired>` | `Boolean</api/data_types/boolean>` |           |        |
| `BringToForeground<notificationresponseaction.bringtoforeground>`           | `Boolean</api/data_types/boolean>` |           |        |
| `Caption<notificationresponseaction.caption>`                               | `String</api/data_types/string>`   |           |        |
| `Destructive<notificationresponseaction.destructive>`                       | `Boolean</api/data_types/boolean>` |           |        |
| `Identifier<notificationresponseaction.identifier>`                         | `String</api/data_types/string>`   |           |        |

## Property descriptions

<div id="notificationresponseaction.authenticationrequired">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

NotificationResponseAction.AuthenticationRequired

**AuthenticationRequired** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, the device must be unlocked to display the action.

<div id="notificationresponseaction.bringtoforeground">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

NotificationResponseAction.BringToForeground

**BringToForeground** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, this action brings the app to the foreground.

<div id="notificationresponseaction.caption">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

NotificationResponseAction.Caption

**Caption** As `String</api/data_types/string>`

> The caption of the button for the action.

<div id="notificationresponseaction.destructive">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

NotificationResponseAction.Destructive

**Destructive** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, you are indicating that this action is destructive in some way.
>
> A destructive action is one where the user will lose data in a way that isn't reversible or easily reversible.
>
> The captions of destructive actions will be drawn in red. Despite this fact, the caption should make it *very clear* that the action is destructive.

<div id="notificationresponseaction.identifier">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

NotificationResponseAction.Identifier

**Identifier** As `String</api/data_types/string>`

> The value that will be passed to the `NotificationCenter.UserResponded<mobilenotifications.userresponded>` event.
>
> This value allows you to know which action the user took when the `NotificationCenter.UserResponded<mobilenotifications.userresponded>` event is called.

## Notes

This is a base class. Instances can't be directly instantiated. Instead you create `NotificationResponseButton</api/user_interface/notifications/notificationresponsebutton>` and `NotificationResponseTextField</api/user_interface/notifications/notificationresponsetextfield>` object.

## Compatibility

|                       |        |
|-----------------------|--------|
| **Project Types**     | Mobile |
| **Operating Systems** | iOS    |

<div class="seealso">

`Object</api/data_types/additional_types/object>` parent class; `NotificationResponseButton</api/user_interface/notifications/notificationresponsebutton>` and `NotificationResponseTextField</api/user_interface/notifications/notificationresponsetextfield>` classes.

</div>
