Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

SDLCancelInteraction Class Reference

Section Contents

Overview

Undocumented

-initWithFunctionID:

Convenience init for dismissing the currently presented modal view (either an alert, slider, scrollable message, or perform interation).

Objective-C

- (nonnull instancetype)initWithFunctionID:(UInt32)functionID;

Swift

init(functionID: UInt32)

Parameters

functionID

The ID of the type of modal view to dismiss

Return Value

A SDLCancelInteraction object

-initWithFunctionID:cancelID:

Convenience init for dismissing a specific view.

Objective-C

- (nonnull instancetype)initWithFunctionID:(UInt32)functionID
                                  cancelID:(UInt32)cancelID;

Swift

init(functionID: UInt32, cancelID: UInt32)

Parameters

functionID

The ID of the type of interaction to dismiss

cancelID

The ID of the specific interaction to dismiss

Return Value

A SDLCancelInteraction object

-initWithAlertCancelID:

Convenience init for dismissing an alert.

Objective-C

- (nonnull instancetype)initWithAlertCancelID:(UInt32)cancelID;

Swift

init(alertCancelID cancelID: UInt32)

Parameters

cancelID

The ID of the specific interaction to dismiss

Return Value

A SDLCancelInteraction object

-initWithSliderCancelID:

Convenience init for dismissing a slider.

Objective-C

- (nonnull instancetype)initWithSliderCancelID:(UInt32)cancelID;

Swift

init(sliderCancelID cancelID: UInt32)

Parameters

cancelID

The ID of the specific interaction to dismiss

Return Value

A SDLCancelInteraction object

-initWithScrollableMessageCancelID:

Convenience init for dismissing a scrollable message.

Objective-C

- (nonnull instancetype)initWithScrollableMessageCancelID:(UInt32)cancelID;

Swift

init(scrollableMessageCancelID cancelID: UInt32)

Parameters

cancelID

The ID of the specific interaction to dismiss

Return Value

A SDLCancelInteraction object

-initWithPerformInteractionCancelID:

Convenience init for dismissing a perform interaction.

Objective-C

- (nonnull instancetype)initWithPerformInteractionCancelID:(UInt32)cancelID;

Swift

init(performInteractionCancelID cancelID: UInt32)

Parameters

cancelID

The ID of the specific interaction to dismiss

Return Value

A SDLCancelInteraction object

+alert

Convenience init for dismissing the currently presented alert.

Objective-C

+ (nonnull instancetype)alert;

Swift

class func alert() -> Self

Return Value

A SDLCancelInteraction object

+slider

Convenience init for dismissing the currently presented slider.

Objective-C

+ (nonnull instancetype)slider;

Swift

class func slider() -> Self

Return Value

A SDLCancelInteraction object

+scrollableMessage

Convenience init for dismissing the currently presented scrollable message.

Objective-C

+ (nonnull instancetype)scrollableMessage;

Swift

class func scrollableMessage() -> Self

Return Value

A SDLCancelInteraction object

+performInteraction

Convenience init for dismissing the currently presented perform interaction.

Objective-C

+ (nonnull instancetype)performInteraction;

Swift

class func performInteraction() -> Self

Return Value

A SDLCancelInteraction object

cancelID

The ID of the specific interaction to dismiss. If not set, the most recent of the RPC type set in functionID will be dismissed.

Integer, Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSNumber<SDLInt> *cancelID;

Swift

var cancelID: (NSNumber & SDLInt)? { get set }

functionID

The ID of the type of interaction to dismiss.

Only values 10 (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), and 26 (SliderID) are permitted.

Integer, Required

Objective-C

@property (readwrite, strong, nonatomic) NSNumber<SDLInt> *_Nonnull functionID;

Swift

var functionID: NSNumber & SDLInt { get set }
View on GitHub.com
Previous Section Next Section