Contents

alertTemplate

Displays important information to the user.

Overview

Use the alertTemplate element to display important information, such as a message telling the user to perform an action before continuing. At a minimum, provide a description of the alert and a button so the user can take any required actions. The following figure shows the basic layout for an alertTemplate page. The theme for the alert template defaults to the system preference.

[Image]

Main Elements

The following listing shows the main elements of the alertTemplate element in TVML format:

<alertTemplate>
   <background>

   </background>
   <title>…</title>
   <description>…</description>
   <button>
      <text>…</text>
   </button>
   <text>…</text>
</alertTemplate>

Element Descriptions

background

Background elements, such as audio.

button

A button that typically allows the user to dismiss the alert or to bring up a new template page. The button element contains a text element that shows the name of the button.

description

The main text for the alert.

text

A brief description of what the button does.

title

The title of the alert, which should briefly communicate its purpose.

Example

The following listing shows the TVML for an alertTemplate example:

<document>
   <alertTemplate>
      <title>Update Available</title>
      <description>Get the latest tvOS version</description>
      <button>
         <text>Update Now</text>
      </button>
      <button>
         <text>Cancel</text>
      </button>
   </alertTemplate>
</document>

The following figure shows the output for the above example:

[Image]

Topics

Valid TVML Attributes

See Also

Full-Page Templates