summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLDeleteFile.html
blob: 2fa755b0052c16258fd5c85ceabb53d4d08f4534 (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
<h1>SDLDeleteFile Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithFileName:">-initWithFileName:</a></li>
  <li><a href="#section-syncFileName">syncFileName</a></li>
</ul>

<h3>Overview</h3>

<p>Used to delete a file resident on the SDL module in the app&rsquo;s local cache.
 Not supported on first generation SDL vehicles
 <p></p>

<p>Since <b>SmartDeviceLink 2.0</b><br>
 see SDLPutFile SDLListFiles</p>


<section class="section task-group-section">
  <h3 id="section--initWithFileName:">
      -initWithFileName:
  </h3>
  
  <p>Convenience init to delete a file</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">initWithFileName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</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">fileName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>fileName</dt>
      <dd><p>A file reference name</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLDeleteFile object</p>
  </div>
  
  <h3 id="section-syncFileName">
      syncFileName
  </h3>
  
  <p>a file reference name
@discussion a String value representing a file reference name</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">syncFileName</span><span class="p">;</span></code></pre>

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

  
  
  
</section>