SDLSystemRequest Class Reference

Section Contents

Overview

An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)

@since SmartDeviceLink 3.0

-initWithType:fileName:

Create a generic system request with a file name

Objective-C

- (nonnull instancetype)initWithType:(nonnull SDLRequestType)requestType
                            fileName:(nullable NSString *)fileName;

Swift

init(type requestType: SDLRequestType, fileName: String?)

Parameters

requestType

The request type to use

fileName

The name of the file to use

Return Value

The request

-initWithProprietaryType:fileName:

Create an OEM_PROPRIETARY system request with a subtype and file name

Objective-C

- (nonnull instancetype)initWithProprietaryType:
                            (nonnull NSString *)proprietaryType
                                       fileName:(nullable NSString *)fileName;

Swift

init(proprietaryType: String, fileName: String?)

Parameters

proprietaryType

The proprietary requestSubType to be used

fileName

The name of the file to use

Return Value

The request

requestType

The type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system.

Required

Objective-C

@property (nonatomic, strong) SDLRequestType _Nonnull requestType;

Swift

var requestType: SDLRequestType { get set }

requestSubType

A request subType used when the requestType is OEM_SPECIFIC.

Optional, Max length 255

Objective-C

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

Swift

var requestSubType: String? { get set }

fileName

Filename of HTTP data to store in predefined system staging area.

Required if requestType is HTTP. PROPRIETARY requestType should ignore this parameter.

Objective-C

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

Swift

var fileName: String? { get set }