One Logo Pool Ball
CarKey · IOS API REFERENCE

RemoteKeylessEntryAction

struct · iOS 16.0+ · SDK 27.1

struct RemoteKeylessEntryAction

An automatically ending action that you want to perform on a vehicle. Use a ``RemoteKeylessEntryAction`` object to store details about an action that runs to completion after you start it. For example, you might use this type of action to unlock the door locks of the vehicle. The object stores information about the feature you want to control and the action to take on that feature. It also stores the identifier for the vehicle itself. After you create a ``RemoteKeylessEntryAction`` object, call your session's ``CarKeyRemoteControlSession/perform(_:)-8ac0c`` method to execute the action. Use the returned ``RemoteKeylessEntryAction/ExecutionRequest`` object to determine the success or failure of the request.

Members (4)

init · iOS 16.0+

init

TypeScript
static init(functionID: FunctionIdentifier, actionID: ActionIdentifier, vehicleID: string): RemoteKeylessEntryAction
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(_:)-8ac0c`` method. - Parameters: - functionID: The vehicle-specific code that identifies the feature to activate. For example, the vehicle might have a specific code to access the door locks. - actionID: The vehicle-specific code that defines what action to take on the vehicle feature. For example, a vehicle might have separate actions to lock and unlock the vehicle’s doors. - 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 action object with the specified information.

get · iOS 16.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 16.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 16.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 →