INSearchForMediaIntentHandling

Trait INSearchForMediaIntentHandling 

Source
pub unsafe trait INSearchForMediaIntentHandling: NSObjectProtocol {
    // Provided methods
    unsafe fn handleSearchForMedia_completion(
        &self,
        intent: &INSearchForMediaIntent,
        completion: &DynBlock<dyn Fn(NonNull<INSearchForMediaIntentResponse>)>,
    )
       where Self: Sized + Message { ... }
    unsafe fn confirmSearchForMedia_completion(
        &self,
        intent: &INSearchForMediaIntent,
        completion: &DynBlock<dyn Fn(NonNull<INSearchForMediaIntentResponse>)>,
    )
       where Self: Sized + Message { ... }
    unsafe fn resolveMediaItemsForSearchForMedia_withCompletion(
        &self,
        intent: &INSearchForMediaIntent,
        completion: &DynBlock<dyn Fn(NonNull<NSArray<INSearchForMediaMediaItemResolutionResult>>)>,
    )
       where Self: Sized + Message { ... }
}
Available on crate feature INSearchForMediaIntent only.
Expand description

Protocol to declare support for handling an INSearchForMediaIntent. 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.

See also Apple’s documentation

Provided Methods§

Source

unsafe fn handleSearchForMedia_completion( &self, intent: &INSearchForMediaIntent, completion: &DynBlock<dyn Fn(NonNull<INSearchForMediaIntentResponse>)>, )
where Self: Sized + Message,

Available on crate features INIntent and INIntentResponse and INSearchForMediaIntentResponse and block2 only.

Handling method - Execute the task represented by the INSearchForMediaIntent that’s passed in

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

Parameter intent: The input intent

Parameter completion: The response handling block takes a INSearchForMediaIntentResponse containing the details of the result of having executed the intent

See: INSearchForMediaIntentResponse

Source

unsafe fn confirmSearchForMedia_completion( &self, intent: &INSearchForMediaIntent, completion: &DynBlock<dyn Fn(NonNull<INSearchForMediaIntentResponse>)>, )
where Self: Sized + Message,

Available on crate features INIntent and INIntentResponse and INSearchForMediaIntentResponse and block2 only.

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.

Parameter intent: The input intent

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

See: INSearchForMediaIntentResponse

Source

unsafe fn resolveMediaItemsForSearchForMedia_withCompletion( &self, intent: &INSearchForMediaIntent, completion: &DynBlock<dyn Fn(NonNull<NSArray<INSearchForMediaMediaItemResolutionResult>>)>, )
where Self: Sized + Message,

Available on crate features INIntent and INIntentResolutionResult and INMediaItemResolutionResult and INSearchForMediaMediaItemResolutionResult and block2 only.

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.

Parameter intent: The input intent

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

See: INIntentResolutionResult

Trait Implementations§

Source§

impl ProtocolType for dyn INSearchForMediaIntentHandling

Source§

const NAME: &'static str = "INSearchForMediaIntentHandling"

The name of the Objective-C protocol that this type represents. Read more
Source§

fn protocol() -> Option<&'static AnyProtocol>

Get a reference to the Objective-C protocol object that this type represents. Read more
Source§

impl<T> ImplementedBy<T> for dyn INSearchForMediaIntentHandling

Implementations on Foreign Types§

Source§

impl<T> INSearchForMediaIntentHandling for ProtocolObject<T>

Implementors§