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

SDLSetGlobalProperties Class Reference

Section Contents

Overview

Sets global property values

Since SmartDeviceLink 1.0

See SDLResetGlobalProperties

-initWithHelpText:timeoutText:

Initialize SetGlobalProperties with help text and timeout text

Objective-C

- (nonnull instancetype)initWithHelpText:(nullable NSString *)helpText
                             timeoutText:(nullable NSString *)timeoutText;

Swift

init(helpText: String?, timeoutText: String?)

Parameters

helpText

A string that will be turned into TTS chunks for the help prompt

timeoutText

A string that will be turned into TTS chunks for the timeout prompt

Return Value

The SetGlobalProperties RPC

-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:

Initialize SetGlobalProperties with help text, timeout text, help title, and help items

Objective-C

- (nonnull instancetype)initWithHelpText:(nullable NSString *)helpText
                             timeoutText:(nullable NSString *)timeoutText
                             vrHelpTitle:(nullable NSString *)vrHelpTitle
                                  vrHelp:(nullable NSArray<SDLVRHelpItem *> *)
                                             vrHelp;

Swift

init(helpText: String?, timeoutText: String?, vrHelpTitle: String?, vrHelp: [SDLVRHelpItem]?)

Parameters

helpText

A string that will be turned into TTS chunks for the help prompt

timeoutText

A string that will be turned into TTS chunks for the timeout prompt

vrHelpTitle

The title of the help interface prompt

vrHelp

The items of the help interface prompt

Return Value

The SetGlobalProperties RPC

-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:

Initialize SetGlobalProperties with all possible items

Objective-C

- (nonnull instancetype)
  initWithHelpText:(nullable NSString *)helpText
       timeoutText:(nullable NSString *)timeoutText
       vrHelpTitle:(nullable NSString *)vrHelpTitle
            vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp
         menuTitle:(nullable NSString *)menuTitle
          menuIcon:(nullable SDLImage *)menuIcon
keyboardProperties:(nullable SDLKeyboardProperties *)keyboardProperties;

Swift

init(helpText: String?, timeoutText: String?, vrHelpTitle: String?, vrHelp: [SDLVRHelpItem]?, menuTitle: String?, menuIcon: SDLImage?, keyboardProperties: SDLKeyboardProperties?)

Parameters

helpText

A string that will be turned into TTS chunks for the help prompt

timeoutText

A string that will be turned into TTS chunks for the timeout prompt

vrHelpTitle

The title of the help interface prompt

vrHelp

The items of the help interface prompt

menuTitle

The title of the menu button

menuIcon

The icon on the menu button

keyboardProperties

The properties of a keyboard prompt

Return Value

The SetGlobalProperties RPC

helpPrompt

Help prompt for when the user asks for help with an interface prompt

Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLTTSChunk *> *helpPrompt;

Swift

var helpPrompt: [SDLTTSChunk]? { get set }

timeoutPrompt

Help prompt for when an interface prompt times out

Optional, Array, at least 1 item

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLTTSChunk *> *timeoutPrompt;

Swift

var timeoutPrompt: [SDLTTSChunk]? { get set }

vrHelpTitle

Sets a voice recognition Help Title

Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSString *vrHelpTitle;

Swift

var vrHelpTitle: String? { get set }

vrHelp

Sets the items listed in the VR help screen used in an interaction started by Push to Talk

@since SmartDeviceLink 2.0

Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLVRHelpItem *> *vrHelp;

Swift

var vrHelp: [SDLVRHelpItem]? { get set }

menuTitle

Text for the menu button label

Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSString *menuTitle;

Swift

var menuTitle: String? { get set }

menuIcon

Icon for the menu button

Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable) SDLImage *menuIcon;

Swift

var menuIcon: SDLImage? { get set }

keyboardProperties

On-screen keyboard (perform interaction) configuration

Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SDLKeyboardProperties *keyboardProperties;

Swift

var keyboardProperties: SDLKeyboardProperties? { get set }
View on GitHub.com
Previous Section Next Section