summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLPerformInteractionResponse.html
blob: 30dbab92cdbe8151a17e3808df09405a5b3a07ec (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
<h1>SDLPerformInteractionResponse Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-choiceID">choiceID</a></li>
  <li><a href="#section-manualTextEntry">manualTextEntry</a></li>
  <li><a href="#section-triggerSource">triggerSource</a></li>
</ul>

<h3>Overview</h3>

<p>PerformInteraction Response is sent, when SDLPerformInteraction has been called</p>

<p>@since SDL 1.0</p>


<section class="section task-group-section">
  <h3 id="section-choiceID">
      choiceID
  </h3>
  
  <p>@abstract ID of the choice that was selected in response to PerformInteraction. </p>

<p>@discussion Only is valid if general result is <q>success:true</q>.</p>

<p>Optional, Integer, 0 - 2,000,000,000</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">choiceID</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">choiceID</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</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-manualTextEntry">
      manualTextEntry
  </h3>
  
  <p>@abstract Manually entered text selection, e.g. through keyboard</p>

<p>@discussion Can be returned in lieu of choiceID, depending on trigger source</p>

<p>Optional, Max length 500 chars</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">manualTextEntry</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">manualTextEntry</span><span class="p">:</span> <span class="kt">String</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-triggerSource">
      triggerSource
  </h3>
  
  <p>@abstract A <em>SDLTriggerSource</em> object which will be shown in the HMI</p>

<p>@discussion Only is valid if resultCode is SUCCESS.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><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">nullable</span><span class="p">)</span>
    <span class="n"><a href="../Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource">SDLTriggerSource</a></span> <span class="n">triggerSource</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">triggerSource</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource">SDLTriggerSource</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>

  
  
  
</section>