Class

INPauseWorkoutIntent

A request to pause the current workout that also stops the gathering of workout data.

Declaration

class INPauseWorkoutIntent : INIntent

Overview

SiriKit creates an INPauseWorkoutIntent object when the user asks to pause a currently running workout. Pausing a workout stops the gathering of workout data without clearing the current workout progress information. Use this intent object to validate workout parameters.

To handle this intent, the handler object in your Intents extension must adopt the INPauseWorkoutIntentHandling protocol. Your handler should confirm the request and create an INPauseWorkoutIntentResponse object that indicates it’s possible to pause the workout. SiriKit launches your app and passes it an NSUserActivity object that your app must then use to pause the workout.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Pause workout intent attributes

Attribute

Description

Supported by

Siri Intents, Siri Suggestions

Always requires unlocked device

Yes

Example Phrases

Users can ask Siri to pause a workout in a variety of ways. Table 2 provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list isn’t exhaustive and Siri may recognize many other phrases.

Table 2

Siri phrases that trigger the pausing of a workout

Locale

Example 1

Example 2

en

Pause my workout in <appName>

zh_CN

暂停<appName>跑步

暂停<appName>上的运动

zh_HK

用動動暫停健身

喺<appName>暫停跑步

zh_TW

<appName>暫停訓練

用<appName>停止跑步

yue_CN

用动动暂停健身

喺<appName>暫停跑步

ar

ايقاف مؤقت للتمرين في <appName>

توقف مؤقت التمرين

da

Sæt min træning på pause i <appName>

Pauser min træning i <appName>

de

Meinen <appName> Workout pausieren

Meinen <appName> Workout unterbrechen

es

Pausa mi entreno de <appName>

Pausar mi entranamiento en <appName>

fi

Keskeytä <appName> harjoittelu

Pidä tauko <appName> treenissä

fr

Mets en pause mon entrainement sur <appName>

Mettre en pause l'entrainement <appName>

he

השהה אימון באמצעות <appName>

it

Metti in pausa il mio allenamento in <appName>

Sospendi il mio esercizio con <appName>

ja

<appName>のワークアウトを一時停止

<appName>のワークアウトを中断

ko

<appName>에서 달리기 잠시 중지해

<appName>으로 수엉 일시 중지해

ms

Jedakan latihan dalam <appName>

Jeda senaman di <appName>

nb

Pause treningen i <appName>

Pause <appName> treningen

nl

Pauzeer mijn work-out in <appName>

pt

Pausar meu exercício no <appName>

Pause minha atividade do <appName>

ru

Приостанови тренировку в <appName>

Тренировку в <appName> на паузу

sv

Pausa min träning i <appName>

Pausa mitt <appName> träningspass

th

พักวิ่งใน <appName>

พักการออกกำลังกายใน <appName>

tr

<appName> koşusunu duraklat

koşuyu duraklat <appName>

In Table 2, <appName> represents the name of the app whose Intents extension pauses the workout. If your app uses specific names for workouts, you can tell Siri about those names using the INVocabulary class.

Topics

Creating the Intent Object

init(workoutName: INSpeakableString?)

Initializes an intent object with the specified workout name.

Specifying Workout Details

var workoutName: INSpeakableString?

The name of the workout to pause.

Relationships

Inherits From

Conforms To

See Also

Pause a Workout

protocol INPauseWorkoutIntentHandling

An interface that handles requests to pause a workout.

class INPauseWorkoutIntentResponse

Your app’s response to a pause workout intent.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software