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

SDLCloudAppProperties Class Reference

Section Contents

Overview

Undocumented

-initWithAppID:

Convenience init for required parameters.

Objective-C

- (nonnull instancetype)initWithAppID:(nonnull NSString *)appID;

Swift

init(appID: String)

Parameters

appID

The id of the cloud app

Return Value

A SDLCloudAppProperties object

-initWithAppID:nicknames:enabled:authToken:cloudTransportType:hybridAppPreference:endpoint:

Convenience init for all parameters.

Objective-C

- (nonnull instancetype)initWithAppID:(nonnull NSString *)appID
                            nicknames:(nullable NSArray<NSString *> *)nicknames
                              enabled:(BOOL)enabled
                            authToken:(nullable NSString *)authToken
                   cloudTransportType:(nullable NSString *)cloudTransportType
                  hybridAppPreference:
                      (nullable SDLHybridAppPreference)hybridAppPreference
                             endpoint:(nullable NSString *)endpoint;

Swift

convenience init(appID: String, nicknames: [String]?, enabled: Bool, authToken: String?, cloudTransportType: String?, hybridAppPreference: SDLHybridAppPreference?, endpoint: String?)

Parameters

appID

The id of the cloud app

nicknames

An array of app names a cloud app is allowed to register with

enabled

If true, the cloud app will appear in the HMI’s app list; if false, the cloud app will not appear in the HMI’s app list

authToken

Used to authenticate websocket connection on app activation

cloudTransportType

Specifies the connection type Core should use

hybridAppPreference

Specifies the user preference to use the cloud app version or mobile app version when both are available

endpoint

The websocket endpoint

Return Value

A SDLCloudAppProperties object

nicknames

An array of app names a cloud app is allowed to register with. If included in a SetCloudAppProperties request, this value will overwrite the existing nicknames field in the app policies section of the policy table.

Array of Strings, Optional, String length: minlength=0 maxlength=100, Array size: minsize=0 maxsize=100

Objective-C

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

Swift

var nicknames: [String]? { get set }

appID

The id of the cloud app.

String, Required, maxlength=100

Objective-C

@property (readwrite, strong, nonatomic) NSString *_Nonnull appID;

Swift

var appID: String { get set }

enabled

If true, the cloud app will appear in the HMI’s app list; if false, the cloud app will not appear in the HMI’s app list.

Boolean, Optional

Objective-C

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

Swift

var enabled: (NSNumber & SDLBool)? { get set }

authToken

Used to authenticate websocket connection on app activation.

String, Optional, maxlength=65535

Objective-C

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

Swift

var authToken: String? { get set }

cloudTransportType

Specifies the connection type Core should use. Currently the ones that work in SDL Core are WS or WSS, but an OEM can implement their own transport adapter to handle different values.

String, Optional, maxlength=100

Objective-C

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

Swift

var cloudTransportType: String? { get set }

hybridAppPreference

Specifies the user preference to use the cloud app version or mobile app version when both are available.

SDLHybridAppPreference, Optional

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SDLHybridAppPreference hybridAppPreference;

Swift

var hybridAppPreference: SDLHybridAppPreference? { get set }

endpoint

The websocket endpoint.

String, Optional, maxlength=65535

Objective-C

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

Swift

var endpoint: String? { get set }
View on GitHub.com
Previous Section Next Section