summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLFileManagerConfiguration.h
blob: 7bf61df9f65d87b8aeb6816a68d019e3544fc222 (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
//
//  SDLFileManagerConfiguration.h
//  SmartDeviceLink
//
//  Created by Nicole on 7/12/18.
//  Copyright © 2018 smartdevicelink. All rights reserved.
//

#import <UIKit/UIKit.h>

#import "NSNumber+NumberType.h"

NS_ASSUME_NONNULL_BEGIN

/// File manager configuration information
@interface SDLFileManagerConfiguration : NSObject <NSCopying>

/**
 *  Defines the number of times the file manager will attempt to reupload `SDLArtwork` files in the event of a failed upload to Core.
 *
 *  Defaults to 1. To disable reuploads, set to 0.
 */
@property (assign, nonatomic) UInt8 artworkRetryCount;

/**
 *  Defines the number of times the file manager will attempt to reupload general `SDLFile`s in the event of a failed upload to Core.
 *
 *  Defaults to 1. To disable reuploads, set to 0.
 */
@property (assign, nonatomic) UInt8 fileRetryCount;

/**
 *  Creates a default file manager configuration.
 *
 *  @return A default configuration that may be customized.
 */
+ (instancetype)defaultConfiguration;

/**
 Use `defaultConfiguration` instead
 */
- (instancetype)init NS_UNAVAILABLE;

/**
 *  Creates a file manager configuration with customized upload retry counts.
 *
 *  @return The configuration
 */
- (instancetype)initWithArtworkRetryCount:(UInt8)artworkRetryCount fileRetryCount:(UInt8)fileRetryCount;

@end

NS_ASSUME_NONNULL_END