summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLOnSystemRequest.h
blob: c4a540f9551d4151a7ff37ffd8d7339396a2afc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
//  SDLOnSystemRequest.h
//

#import "SDLRPCNotification.h"

#import "SDLFileType.h"
#import "SDLRequestType.h"

NS_ASSUME_NONNULL_BEGIN

/**
 An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)
 */
@interface SDLOnSystemRequest : SDLRPCNotification

/**
 The type of system request.
 */
@property (strong, nonatomic) SDLRequestType requestType;

/**
 A request subType used when the `requestType` is `OEM_SPECIFIC`.

 Optional, Max length 255
 */
@property (strong, nonatomic, nullable) NSString *requestSubType;

/**
 Optional URL for HTTP requests. If blank, the binary data shall be forwarded to the app. If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.
 */
@property (nullable, strong, nonatomic) NSString *url;

/**
 Optional timeout for HTTP requests Required if a URL is provided
 */
@property (nullable, strong, nonatomic) NSNumber<SDLInt> *timeout;

/**
 Optional file type (meant for HTTP file requests).
 */
@property (nullable, strong, nonatomic) SDLFileType fileType;

/**
 Optional offset in bytes for resuming partial data chunks
 */
@property (nullable, strong, nonatomic) NSNumber<SDLUInt> *offset;

/**
 Optional length in bytes for resuming partial data chunks
 */
@property (nullable, strong, nonatomic) NSNumber<SDLUInt> *length;

@end

NS_ASSUME_NONNULL_END