summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLButtonPress.html
blob: 488290b331085726501bde077a52207338d1e901 (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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<h1>SDLButtonPress Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithButtonName:moduleType:">-initWithButtonName:moduleType:</a></li>
  <li><a href="#section--initWithButtonName:moduleType:moduleId:">-initWithButtonName:moduleType:moduleId:</a></li>
  <li><a href="#section--initWithButtonName:moduleType:moduleId:buttonPressMode:">-initWithButtonName:moduleType:moduleId:buttonPressMode:</a></li>
  <li><a href="#section-moduleType">moduleType</a></li>
  <li><a href="#section-moduleId">moduleId</a></li>
  <li><a href="#section-buttonName">buttonName</a></li>
  <li><a href="#section-buttonPressMode">buttonPressMode</a></li>
</ul>

<h3>Overview</h3>

<p>This RPC allows a remote control type mobile application to simulate a hardware button press event.</p>

<p>@since RPC 4.5</p>


<section class="section task-group-section">
  <h3 id="section--initWithButtonName:moduleType:">
      -initWithButtonName:moduleType:
  </h3>
  
  <p>Constructs a newly allocated SDLButtonPress object with the given parameters</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">initWithButtonName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span><span class="p">)</span><span class="nv">buttonName</span>
                                <span class="nf">moduleType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span><span class="p">)</span><span class="nv">moduleType</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">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span><span class="p">,</span> <span class="nv">moduleType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>buttonName</dt>
      <dd><p>the name of the button</p></dd>
      <dt>moduleType</dt>
      <dd><p>the module where the button should be pressed</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLButtonPress class.</p>
  </div>
  
  <h3 id="section--initWithButtonName:moduleType:moduleId:">
      -initWithButtonName:moduleType:moduleId:
  </h3>
  
  <p>Constructs a newly allocated SDLButtonPress object with the given parameters</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">initWithButtonName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span><span class="p">)</span><span class="nv">buttonName</span>
                                <span class="nf">moduleType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span><span class="p">)</span><span class="nv">moduleType</span>
                                  <span class="nf">moduleId</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleId</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">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span><span class="p">,</span> <span class="nv">moduleType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span><span class="p">,</span> <span class="nv">moduleId</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>buttonName</dt>
      <dd><p>the name of the button</p></dd>
      <dt>moduleType</dt>
      <dd><p>the module where the button should be pressed</p></dd>
      <dt>moduleId</dt>
      <dd><p>the id of the module</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLButtonPress class.</p>
  </div>
  
  <h3 id="section--initWithButtonName:moduleType:moduleId:buttonPressMode:">
      -initWithButtonName:moduleType:moduleId:buttonPressMode:
  </h3>
  
  <p>Constructs a newly allocated SDLButtonPress object with the given parameters</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">initWithButtonName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span><span class="p">)</span><span class="nv">buttonName</span>
                                <span class="nf">moduleType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span><span class="p">)</span><span class="nv">moduleType</span>
                                  <span class="nf">moduleId</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleId</span>
                           <span class="nf">buttonPressMode</span><span class="p">:</span>
                               <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode">SDLButtonPressMode</a></span><span class="p">)</span><span class="nv">buttonPressMode</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">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span><span class="p">,</span> <span class="nv">moduleType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span><span class="p">,</span> <span class="nv">moduleId</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">buttonPressMode</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode">SDLButtonPressMode</a></span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>buttonName</dt>
      <dd><p>the name of the button</p></dd>
      <dt>moduleType</dt>
      <dd><p>the module where the button should be pressed</p></dd>
      <dt>moduleId</dt>
      <dd><p>the id of the module</p></dd>
      <dt>buttonPressMode</dt>
      <dd><p>indicates LONG or SHORT button press event</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An instance of the SDLButtonPress class.</p>
  </div>
  
  <h3 id="section-moduleType">
      moduleType
  </h3>
  
  <p>The module where the button should be pressed.</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">strong</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="n">_Nonnull</span> <span class="n">moduleType</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">moduleType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-moduleId">
      moduleId
  </h3>
  
  <p>Id of a module, published by System Capability.</p>

<p>Optional</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">strong</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">moduleId</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">moduleId</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-buttonName">
      buttonName
  </h3>
  
  <p>The name of supported RC climate or radio button.</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">strong</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="n">_Nonnull</span> <span class="n">buttonName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-buttonPressMode">
      buttonPressMode
  </h3>
  
  <p>Indicates whether this is a LONG or SHORT button press event.</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">strong</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode">SDLButtonPressMode</a></span> <span class="n">_Nonnull</span> <span class="n">buttonPressMode</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">buttonPressMode</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode">SDLButtonPressMode</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>