apple.intents.protocol

Interface INTransferMoneyIntentHandling

public interface INTransferMoneyIntentHandling

Protocol to declare support for handling an INTransferMoneyIntent. 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	INTransferMoneyIntentHandling.Block_confirmTransferMoneyCompletion
static interface	INTransferMoneyIntentHandling.Block_handleTransferMoneyCompletion
static interface	INTransferMoneyIntentHandling.Block_resolveFromAccountForTransferMoneyWithCompletion
static interface	INTransferMoneyIntentHandling.Block_resolveToAccountForTransferMoneyWithCompletion
static interface	INTransferMoneyIntentHandling.Block_resolveTransactionAmountForTransferMoneyWithCompletion
static interface	INTransferMoneyIntentHandling.Block_resolveTransactionNoteForTransferMoneyWithCompletion
static interface	INTransferMoneyIntentHandling.Block_resolveTransactionScheduledDateForTransferMoneyWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmTransferMoneyCompletion(INTransferMoneyIntent intent, INTransferMoneyIntentHandling.Block_confirmTransferMoneyCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleTransferMoneyCompletion(INTransferMoneyIntent intent, INTransferMoneyIntentHandling.Block_handleTransferMoneyCompletion completion) Handling method - Execute the task represented by the INTransferMoneyIntent that's passed in
default void	resolveFromAccountForTransferMoneyWithCompletion(INTransferMoneyIntent intent, INTransferMoneyIntentHandling.Block_resolveFromAccountForTransferMoneyWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveToAccountForTransferMoneyWithCompletion(INTransferMoneyIntent intent, INTransferMoneyIntentHandling.Block_resolveToAccountForTransferMoneyWithCompletion completion)
default void	resolveTransactionAmountForTransferMoneyWithCompletion(INTransferMoneyIntent intent, INTransferMoneyIntentHandling.Block_resolveTransactionAmountForTransferMoneyWithCompletion completion)
default void	resolveTransactionNoteForTransferMoneyWithCompletion(INTransferMoneyIntent intent, INTransferMoneyIntentHandling.Block_resolveTransactionNoteForTransferMoneyWithCompletion completion)
default void	resolveTransactionScheduledDateForTransferMoneyWithCompletion(INTransferMoneyIntent intent, INTransferMoneyIntentHandling.Block_resolveTransactionScheduledDateForTransferMoneyWithCompletion completion)

Method Detail

confirmTransferMoneyCompletion

default void confirmTransferMoneyCompletion(INTransferMoneyIntent intent,
                                            INTransferMoneyIntentHandling.Block_confirmTransferMoneyCompletion 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 INTransferMoneyIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INTransferMoneyIntentResponse

handleTransferMoneyCompletion

void handleTransferMoneyCompletion(INTransferMoneyIntent intent,
                                   INTransferMoneyIntentHandling.Block_handleTransferMoneyCompletion completion)

Handling method - Execute the task represented by the INTransferMoneyIntent 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 INTransferMoneyIntentResponse containing the details of the result of having executed the intent

See Also:

INTransferMoneyIntentResponse

resolveFromAccountForTransferMoneyWithCompletion

default void resolveFromAccountForTransferMoneyWithCompletion(INTransferMoneyIntent intent,
                                                              INTransferMoneyIntentHandling.Block_resolveFromAccountForTransferMoneyWithCompletion 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

resolveToAccountForTransferMoneyWithCompletion

default void resolveToAccountForTransferMoneyWithCompletion(INTransferMoneyIntent intent,
                                                            INTransferMoneyIntentHandling.Block_resolveToAccountForTransferMoneyWithCompletion completion)

resolveTransactionAmountForTransferMoneyWithCompletion

default void resolveTransactionAmountForTransferMoneyWithCompletion(INTransferMoneyIntent intent,
                                                                    INTransferMoneyIntentHandling.Block_resolveTransactionAmountForTransferMoneyWithCompletion completion)

resolveTransactionNoteForTransferMoneyWithCompletion

default void resolveTransactionNoteForTransferMoneyWithCompletion(INTransferMoneyIntent intent,
                                                                  INTransferMoneyIntentHandling.Block_resolveTransactionNoteForTransferMoneyWithCompletion completion)

resolveTransactionScheduledDateForTransferMoneyWithCompletion

default void resolveTransactionScheduledDateForTransferMoneyWithCompletion(INTransferMoneyIntent intent,
                                                                           INTransferMoneyIntentHandling.Block_resolveTransactionScheduledDateForTransferMoneyWithCompletion completion)