Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
SDLGetInteriorVehicleData

SDLGetInteriorVehicleData Class Reference

Section Contents

Overview

Reads the current status value of specified remote control module (type). When subscribe is true, subscribes for specific remote control module data items. When subscribe is false, unsubscribes for specific remote control module data items. Once subscribed, the application will be notified by the onInteriorVehicleData RPC notification whenever new data is available for the module.

-initWithModuleType:moduleId:

Convenience init to get information of a particular module type with a module ID.

Objective-C

- (nonnull instancetype)initWithModuleType:(nonnull SDLModuleType)moduleType
                                  moduleId:(nonnull NSString *)moduleId;

Swift

init(moduleType: SDLModuleType, moduleId: String)

Parameters

moduleType

The type of a RC module to retrieve module data from the vehicle

moduleId

Id of a module, published by System Capability

Return Value

An SDLGetInteriorVehicleData object

-initAndSubscribeToModuleType:moduleId:

Convenience init to get information and subscribe to a particular module type with a module ID.

Objective-C

- (nonnull instancetype)
    initAndSubscribeToModuleType:(nonnull SDLModuleType)moduleType
                        moduleId:(nonnull NSString *)moduleId;

Swift

init(andSubscribeToModuleType moduleType: SDLModuleType, moduleId: String)

Parameters

moduleType

The type of a RC module to retrieve module data from the vehicle

moduleId

Id of a module, published by System Capability

Return Value

An SDLGetInteriorVehicleData object

-initAndUnsubscribeToModuleType:moduleId:

Convenience init to unsubscribe from particular module with a module ID.

Objective-C

- (nonnull instancetype)
    initAndUnsubscribeToModuleType:(nonnull SDLModuleType)moduleType
                          moduleId:(nonnull NSString *)moduleId;

Swift

init(andUnsubscribeToModuleType moduleType: SDLModuleType, moduleId: String)

Parameters

moduleType

The type of a RC module to retrieve module data from the vehicle

moduleId

Id of a module, published by System Capability

Return Value

An SDLGetInteriorVehicleData object

moduleType

The type of a RC module to retrieve module data from the vehicle.

Objective-C

@property (nonatomic, strong) SDLModuleType _Nonnull moduleType;

Swift

var moduleType: SDLModuleType { get set }

moduleId

Id of a module, published by System Capability.

Optional

Objective-C

@property (nonatomic, strong, nullable) NSString *moduleId;

Swift

var moduleId: String? { get set }

subscribe

If subscribe is true, the head unit will register OnInteriorVehicleData notifications for the requested module (moduleId and moduleType). If subscribe is false, the head unit will unregister OnInteriorVehicleData notifications for the requested module (moduleId and moduleType). If subscribe is not included, the subscription status of the app for the requested module (moduleId and moduleType) will remain unchanged.

optional, Boolean, default Value = false

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *subscribe;

Swift

var subscribe: (NSNumber & SDLBool)? { get set }
View on GitHub.com
Previous Section Next Section