apple.intents.protocol

Interface INSearchForAccountsIntentHandling

public interface INSearchForAccountsIntentHandling

Protocol to declare support for handling an INSearchForAccountsIntent. 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	INSearchForAccountsIntentHandling.Block_confirmSearchForAccountsCompletion
static interface	INSearchForAccountsIntentHandling.Block_handleSearchForAccountsCompletion
static interface	INSearchForAccountsIntentHandling.Block_resolveAccountNicknameForSearchForAccountsWithCompletion
static interface	INSearchForAccountsIntentHandling.Block_resolveAccountTypeForSearchForAccountsWithCompletion
static interface	INSearchForAccountsIntentHandling.Block_resolveOrganizationNameForSearchForAccountsWithCompletion
static interface	INSearchForAccountsIntentHandling.Block_resolveRequestedBalanceTypeForSearchForAccountsWithCompletion

Method Summary

Modifier and Type	Method and Description
default void	confirmSearchForAccountsCompletion(INSearchForAccountsIntent intent, INSearchForAccountsIntentHandling.Block_confirmSearchForAccountsCompletion completion) Confirmation method - Validate that this intent is ready for the next step (i.e.
void	handleSearchForAccountsCompletion(INSearchForAccountsIntent intent, INSearchForAccountsIntentHandling.Block_handleSearchForAccountsCompletion completion) Handling method - Execute the task represented by the INSearchForAccountsIntent that's passed in
default void	resolveAccountNicknameForSearchForAccountsWithCompletion(INSearchForAccountsIntent intent, INSearchForAccountsIntentHandling.Block_resolveAccountNicknameForSearchForAccountsWithCompletion completion) Resolution methods - Determine if this intent is ready for the next step (confirmation)
default void	resolveAccountTypeForSearchForAccountsWithCompletion(INSearchForAccountsIntent intent, INSearchForAccountsIntentHandling.Block_resolveAccountTypeForSearchForAccountsWithCompletion completion)
default void	resolveOrganizationNameForSearchForAccountsWithCompletion(INSearchForAccountsIntent intent, INSearchForAccountsIntentHandling.Block_resolveOrganizationNameForSearchForAccountsWithCompletion completion)
default void	resolveRequestedBalanceTypeForSearchForAccountsWithCompletion(INSearchForAccountsIntent intent, INSearchForAccountsIntentHandling.Block_resolveRequestedBalanceTypeForSearchForAccountsWithCompletion completion)

Method Detail

confirmSearchForAccountsCompletion

default void confirmSearchForAccountsCompletion(INSearchForAccountsIntent intent,
                                                INSearchForAccountsIntentHandling.Block_confirmSearchForAccountsCompletion 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 INSearchForAccountsIntentResponse containing additional details about the intent that may be relevant for the system to show the user prior to handling.

See Also:

INSearchForAccountsIntentResponse

handleSearchForAccountsCompletion

void handleSearchForAccountsCompletion(INSearchForAccountsIntent intent,
                                       INSearchForAccountsIntentHandling.Block_handleSearchForAccountsCompletion completion)

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

See Also:

INSearchForAccountsIntentResponse

resolveAccountNicknameForSearchForAccountsWithCompletion

default void resolveAccountNicknameForSearchForAccountsWithCompletion(INSearchForAccountsIntent intent,
                                                                      INSearchForAccountsIntentHandling.Block_resolveAccountNicknameForSearchForAccountsWithCompletion 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

resolveAccountTypeForSearchForAccountsWithCompletion

default void resolveAccountTypeForSearchForAccountsWithCompletion(INSearchForAccountsIntent intent,
                                                                  INSearchForAccountsIntentHandling.Block_resolveAccountTypeForSearchForAccountsWithCompletion completion)

resolveOrganizationNameForSearchForAccountsWithCompletion

default void resolveOrganizationNameForSearchForAccountsWithCompletion(INSearchForAccountsIntent intent,
                                                                       INSearchForAccountsIntentHandling.Block_resolveOrganizationNameForSearchForAccountsWithCompletion completion)

resolveRequestedBalanceTypeForSearchForAccountsWithCompletion

default void resolveRequestedBalanceTypeForSearchForAccountsWithCompletion(INSearchForAccountsIntent intent,
                                                                           INSearchForAccountsIntentHandling.Block_resolveRequestedBalanceTypeForSearchForAccountsWithCompletion completion)