One Logo Pool Ball
CarKey · IOS API REFERENCE

RemoteKeylessEntryConfigurableEnduringAction

struct · iOS 18.0+ · SDK 27.1

struct RemoteKeylessEntryConfigurableEnduringAction

An action with an optional stopping point that you want to perform on a vehicle. Use a ``RemoteKeylessEntryConfigurableEnduringAction`` object to store details about an action that you can stop or let run to completion. For example, you might use this type of action to lower or raise the top of a convertible vehicle. The object stores information about the vehicle feature to control and the action to take on that feature. It also stores the identifier for the vehicle itself. After you create a ``RemoteKeylessEntryConfigurableEnduringAction`` object, call your session's ``CarKeyRemoteControlSession/perform(_:)-7mpsy`` method to execute the action. Use the returned ``RemoteKeylessEntryAction/ExecutionRequest`` object to determine the success or failure of the request.

Members (4)

init · iOS 18.0+

init

TypeScript
static init(functionID: FunctionIdentifier, actionID: ActionIdentifier, vehicleID: string): RemoteKeylessEntryConfigurableEnduringAction
Swift declaration
init(functionID: FunctionIdentifier, actionID: ActionIdentifier, vehicleID: String)

Creates a new action object with the specified action-specific details and vehicle ID. This method creates an immutable action object that you can pass to your session’s ``CarKeyRemoteControlSession/perform(_:)-7mpsy`` method. - Parameters: - functionID: The vehicle-specific code that identifies the feature to activate. For example, the vehicle might have a specific code to identify the roof mechanism on a convertible vehicle. - actionID: The vehicle-specific code that defines what action to take on the vehicle feature. For example, a vehicle might have separate actions to raise or lower the top on a convertible. - vehicleID: The target vehicle for the action. Choose the vehicle from one of the session’s vehicle reports. Specify the string in the ``VehicleReport/identifier`` property of the corresponding report. - Returns: An enduring action object with the specified information.

get · iOS 18.0+

functionID

TypeScript
get functionID(): FunctionIdentifier
Swift declaration
let functionID: FunctionIdentifier

The vehicle-specific code that identifies which feature you want to control. You define the function identifiers for your vehicles and what features they represent.

get · iOS 18.0+

recipientVehicleID

TypeScript
get recipientVehicleID(): string
Swift declaration
let recipientVehicleID: String

The vehicle to receive the action request. This string is the same one that appears in the ``VehicleReport/identifier`` property of one of the session's vehicle reports.

get · iOS 18.0+

actionID

TypeScript
get actionID(): ActionIdentifier
Swift declaration
let actionID: ActionIdentifier

The vehicle-specific code that identifies what action to take on the targeted feature. You define the action identifiers for your vehicles and what actions they perform on the vehicle function.

Skipped declarations

No declarations were skipped in this snapshot.

All CarKey types →