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
SDLWindowCapability

SDLWindowCapability Class Reference

Section Contents

Overview

Reflects content of DisplayCapabilities, ButtonCapabilities and SoftButtonCapabilities

@since SDL 6.0

-initWithWindowID:textFields:imageFields:imageTypeSupported:templatesAvailable:numCustomPresetsAvailable:buttonCapabilities:softButtonCapabilities:menuLayoutsAvailable:dynamicUpdateCapabilities:

Objective-C

- (nonnull instancetype)
             initWithWindowID:(nullable NSNumber<SDLInt> *)windowID
                   textFields:(nullable NSArray<SDLTextField *> *)textFields
                  imageFields:(nullable NSArray<SDLImageField *> *)imageFields
           imageTypeSupported:
               (nullable NSArray<SDLImageType> *)imageTypeSupported
           templatesAvailable:(nullable NSArray<NSString *> *)templatesAvailable
    numCustomPresetsAvailable:
        (nullable NSNumber<SDLUInt> *)numCustomPresetsAvailable
           buttonCapabilities:
               (nullable NSArray<SDLButtonCapabilities *> *)buttonCapabilities
       softButtonCapabilities:(nullable NSArray<SDLSoftButtonCapabilities *> *)
                                  softButtonCapabilities
         menuLayoutsAvailable:
             (nullable NSArray<SDLMenuLayout> *)menuLayoutsAvailable
    dynamicUpdateCapabilities:
        (nullable SDLDynamicUpdateCapabilities *)dynamicUpdateCapabilities;

Swift

init(windowID: (NSNumber & SDLInt)?, textFields: [SDLTextField]?, imageFields: [SDLImageField]?, imageTypeSupported: [SDLImageType]?, templatesAvailable: [String]?, numCustomPresetsAvailable: (NSNumber & SDLUInt)?, buttonCapabilities: [SDLButtonCapabilities]?, softButtonCapabilities: [SDLSoftButtonCapabilities]?, menuLayoutsAvailable: [SDLMenuLayout]?, dynamicUpdateCapabilities: SDLDynamicUpdateCapabilities?)

Parameters

windowID

- windowID

textFields

- textFields

imageFields

- imageFields

imageTypeSupported

- imageTypeSupported

templatesAvailable

- templatesAvailable

numCustomPresetsAvailable

- numCustomPresetsAvailable

buttonCapabilities

- buttonCapabilities

softButtonCapabilities

- softButtonCapabilities

menuLayoutsAvailable

- menuLayoutsAvailable

dynamicUpdateCapabilities

- dynamicUpdateCapabilities

Return Value

A SDLWindowCapability object

windowID

The specified ID of the window. Can be set to a predefined window, or omitted for the main window on the main display.

Size: min 1 max 100

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLUInt> *windowID;

Swift

var windowID: (NSNumber & SDLUInt)? { get set }

textFields

A set of all fields that support text data. - see: TextField

Size: min 1 max 100

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLTextField *> *textFields;

Swift

var textFields: [SDLTextField]? { get set }

imageFields

A set of all fields that support images. - see: ImageField

Size: min 0 max 1000

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLImageField *> *imageFields;

Swift

var imageFields: [SDLImageField]? { get set }

imageTypeSupported

Provides information about image types supported by the system.

Size: min 0 max 1000

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLImageType> *imageTypeSupported;

Swift

var imageTypeSupported: [SDLImageType]? { get set }

templatesAvailable

A set of all window templates available on the head unit.

Size: min 0 max 100

Objective-C

@property (nonatomic, strong, nullable) NSArray<NSString *> *templatesAvailable;

Swift

var templatesAvailable: [String]? { get set }

numCustomPresetsAvailable

The number of on-window custom presets available (if any); otherwise omitted.

Size: min 1 max 100

Objective-C

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

Swift

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

buttonCapabilities

The number of buttons and the capabilities of each on-window button.

Size: min 1 max 100

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLButtonCapabilities *> *buttonCapabilities;

Swift

var buttonCapabilities: [SDLButtonCapabilities]? { get set }

softButtonCapabilities

The number of soft buttons available on-window and the capabilities for each button.

Size: min 1 max 100

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities;

Swift

var softButtonCapabilities: [SDLSoftButtonCapabilities]? { get set }

menuLayoutsAvailable

An array of available menu layouts. If this parameter is not provided, only the LIST layout is assumed to be available.

Optional, array of 1 to 100, see SDLMenuLayout

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLMenuLayout> *menuLayoutsAvailable;

Swift

var menuLayoutsAvailable: [SDLMenuLayout]? { get set }

dynamicUpdateCapabilities

Contains the head unit’s capabilities for dynamic updating features declaring if the module will send dynamic update RPCs.

@since SDL 7.0.0

Objective-C

@property (nonatomic, strong, nullable) SDLDynamicUpdateCapabilities *dynamicUpdateCapabilities;

Swift

var dynamicUpdateCapabilities: SDLDynamicUpdateCapabilities? { get set }
View on GitHub.com
Previous Section Next Section