summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLFileManagerConfiguration.html
blob: 2070fa8f4aad3aeaa0600840fa65a133398ec34f (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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<h1>SDLFileManagerConfiguration Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-artworkRetryCount">artworkRetryCount</a></li>
  <li><a href="#section-fileRetryCount">fileRetryCount</a></li>
  <li><a href="#section-+defaultConfiguration">+defaultConfiguration</a></li>
  <li><a href="#section--init">-init</a></li>
  <li><a href="#section--initWithArtworkRetryCount:fileRetryCount:">-initWithArtworkRetryCount:fileRetryCount:</a></li>
</ul>

<h3>Overview</h3>

<p>Undocumented</p>


<section class="section task-group-section">
  <h3 id="section-artworkRetryCount">
      artworkRetryCount
  </h3>
  
  <p>Defines the number of times the file manager will attempt to reupload <code><a href="../Classes/SDLArtwork.html">SDLArtwork</a></code> files in the event of a failed upload to Core.</p>

<p>Defaults to 1. To disable reuploads, set to 0.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">artworkRetryCount</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">artworkRetryCount</span><span class="p">:</span> <span class="kt">UInt8</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-fileRetryCount">
      fileRetryCount
  </h3>
  
  <p>Defines the number of times the file manager will attempt to reupload general <code><a href="../Classes/SDLFile.html">SDLFile</a></code>s in the event of a failed upload to Core.</p>

<p>Defaults to 1. To disable reuploads, set to 0.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">fileRetryCount</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">fileRetryCount</span><span class="p">:</span> <span class="kt">UInt8</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-+defaultConfiguration">
      +defaultConfiguration
  </h3>
  
  <p>Creates a default file manager configuration.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">defaultConfiguration</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="p">`</span><span class="nv">default</span><span class="p">`()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>

  
  
  <div>
    <h4>Return Value</h4>
    <p>A default configuration that may be customized.</p>
  </div>
  
  <h3 id="section--init">
      -init
  </h3>
  
  <p>Use <code>defaultConfiguration</code> instead</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre>

  
  
  
  
  <h3 id="section--initWithArtworkRetryCount:fileRetryCount:">
      -initWithArtworkRetryCount:fileRetryCount:
  </h3>
  
  <p>Creates a file manager configuration with customized upload retry counts.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithArtworkRetryCount</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">artworkRetryCount</span>
                                   <span class="nf">fileRetryCount</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">fileRetryCount</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">artworkRetryCount</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">fileRetryCount</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre>

  
  
  <div>
    <h4>Return Value</h4>
    <p>The configuration</p>
  </div>
  
</section>