summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLEncryptionConfiguration.html
blob: 5ac6b6558895241cabcb32a99ed00d59bdb5abab (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
<h1>SDLEncryptionConfiguration Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-securityManagers">securityManagers</a></li>
  <li><a href="#section-delegate">delegate</a></li>
  <li><a href="#section-+defaultConfiguration">+defaultConfiguration</a></li>
  <li><a href="#section--initWithSecurityManagers:delegate:">-initWithSecurityManagers:delegate:</a></li>
</ul>

<h3>Overview</h3>

<p>The encryption configuration data</p>


<section class="section task-group-section">
  <h3 id="section-securityManagers">
      securityManagers
  </h3>
  
  <p>A set of security managers used to encrypt traffic data. Each OEM has their own proprietary security manager.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">Class</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">&gt;&gt;</span> <span class="o">*</span><span class="n">securityManagers</span><span class="p">;</span></code></pre>

  
  
  
  
  <h3 id="section-delegate">
      delegate
  </h3>
  
  <p>A delegate callback that will tell you when an acknowledgement has occurred for starting as secure service.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">weak</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/SDLServiceEncryptionDelegate.html">SDLServiceEncryptionDelegate</a></span><span class="o">&gt;</span> <span class="n">delegate</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLServiceEncryptionDelegate.html">SDLServiceEncryptionDelegate</a></span><span class="p">?</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 encryption 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--initWithSecurityManagers:delegate:">
      -initWithSecurityManagers:delegate:
  </h3>
  
  <p>Creates a secure configuration for each of the security managers provided.</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">initWithSecurityManagers</span><span class="p">:</span>
        <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">Class</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">&gt;&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">securityManagers</span>
                    <span class="nf">delegate</span><span class="p">:</span>
                        <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/SDLServiceEncryptionDelegate.html">SDLServiceEncryptionDelegate</a></span><span class="o">&gt;</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span></code></pre>

  
  
  
  <h4>Parameters</h4>
  <dl>
      <dt>securityManagers</dt>
      <dd><p>The security managers to be used.</p></dd>
      <dt>delegate</dt>
      <dd><p>The delegate callback.</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>The configuration</p>
  </div>
  
</section>