apple.intents.protocol

Interface INStartCallIntentHandling

public interface INStartCallIntentHandling

Protocol to declare support for handling an INStartCallIntent. By implementing this protocol, a class can provide logic for resolving, confirming and handling the intent.

The minimum requirement for an implementing class is that it should be able to handle the intent. The resolution and confirmation methods are optional. The handling method is always called last, after resolving and confirming the intent.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	INStartCallIntentHandling.Block_confirmStartCallCompletion
static interface	INStartCallIntentHandling.Block_handleStartCallCompletion
static interface	INStartCallIntentHandling.Block_resolveCallCapabilityForStartCallWithCompletion
static interface	INStartCallIntentHandling.Block_resolveCallRecordToCallBackForStartCallWithCompletion
static interface	INStartCallIntentHandling.Block_resolveContactsForStartCallWithCompletion
static interface	INStartCallIntentHandling.Block_resolveDestinationTypeForStartCallWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmStartCallCompletion(INStartCallIntent intent, INStartCallIntentHandling.Block_confirmStartCallCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleStartCallCompletion(INStartCallIntent intent, INStartCallIntentHandling.Block_handleStartCallCompletion completion) Handling method - Execute the task represented by the INStartCallIntent that's passed in
default void	resolveCallCapabilityForStartCallWithCompletion(INStartCallIntent intent, INStartCallIntentHandling.Block_resolveCallCapabilityForStartCallWithCompletion completion)
default void	resolveCallRecordToCallBackForStartCallWithCompletion(INStartCallIntent intent, INStartCallIntentHandling.Block_resolveCallRecordToCallBackForStartCallWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveContactsForStartCallWithCompletion(INStartCallIntent intent, INStartCallIntentHandling.Block_resolveContactsForStartCallWithCompletion completion)
default void	resolveDestinationTypeForStartCallWithCompletion(INStartCallIntent intent, INStartCallIntentHandling.Block_resolveDestinationTypeForStartCallWithCompletion completion)

Method Detail

confirmStartCallCompletion

default void confirmStartCallCompletion(INStartCallIntent intent,
                                        INStartCallIntentHandling.Block_confirmStartCallCompletion completion)

Confirmation method - Validate that this intent is ready for the next step (i.e. handling)

Called prior to asking the app to handle the intent. The app should return a response object that contains additional information about the intent, which may be relevant for the system to show the user prior to handling. If unimplemented, the system will assume the intent is valid following resolution, and will assume there is no additional information relevant to this intent.

Parameters:

intent - The input intent

completion - The response block contains an INStartCallIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INStartCallIntentResponse

handleStartCallCompletion

void handleStartCallCompletion(INStartCallIntent intent,
                               INStartCallIntentHandling.Block_handleStartCallCompletion completion)

Handling method - Execute the task represented by the INStartCallIntent that's passed in

Called to actually execute the intent. The app must return a response for this intent.

Parameters:

intent - The input intent

completion - The response handling block takes a INStartCallIntentResponse containing the details of the result of having executed the intent

See Also:

INStartCallIntentResponse

resolveCallCapabilityForStartCallWithCompletion

default void resolveCallCapabilityForStartCallWithCompletion(INStartCallIntent intent,
                                                             INStartCallIntentHandling.Block_resolveCallCapabilityForStartCallWithCompletion completion)

resolveContactsForStartCallWithCompletion

default void resolveContactsForStartCallWithCompletion(INStartCallIntent intent,
                                                       INStartCallIntentHandling.Block_resolveContactsForStartCallWithCompletion completion)

resolveDestinationTypeForStartCallWithCompletion

default void resolveDestinationTypeForStartCallWithCompletion(INStartCallIntent intent,
                                                              INStartCallIntentHandling.Block_resolveDestinationTypeForStartCallWithCompletion completion)

resolveCallRecordToCallBackForStartCallWithCompletion

default void resolveCallRecordToCallBackForStartCallWithCompletion(INStartCallIntent intent,
                                                                   INStartCallIntentHandling.Block_resolveCallRecordToCallBackForStartCallWithCompletion completion)

Resolution methods - Determine if this intent is ready for the next step (confirmation)

Called to make sure the app extension is capable of handling this intent in its current form. This method is for validating if the intent needs any further fleshing out.

Parameters:

intent - The input intent

completion - The response block contains an INIntentResolutionResult for the parameter being resolved

See Also:

INIntentResolutionResult