blob: 135c9be0063aef596680dad905bda17dc149fccb (
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
|
<h1>SDLGetAppServiceData Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--initWithAppServiceType:">-initWithAppServiceType:</a></li>
<li><a href="#section--initAndSubscribeToAppServiceType:">-initAndSubscribeToAppServiceType:</a></li>
<li><a href="#section--initAndUnsubscribeToAppServiceType:">-initAndUnsubscribeToAppServiceType:</a></li>
<li><a href="#section-serviceType">serviceType</a></li>
<li><a href="#section-subscribe">subscribe</a></li>
</ul>
<h3>Overview</h3>
<p>This request asks the module for current data related to the specific service. It also includes an option to subscribe to that service for future updates.</p>
<section class="section task-group-section">
<h3 id="section--initWithAppServiceType:">
-initWithAppServiceType:
</h3>
<p>Convenience init for service type.</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">initWithAppServiceType</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLAppServiceType.h@T@SDLAppServiceType">SDLAppServiceType</a></span><span class="p">)</span><span class="nv">serviceType</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="n">appServiceType</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLAppServiceType.h@T@SDLAppServiceType">SDLAppServiceType</a></span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>serviceType</dt>
<dd><p>The app service type</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLGetAppServiceData object</p>
</div>
<h3 id="section--initAndSubscribeToAppServiceType:">
-initAndSubscribeToAppServiceType:
</h3>
<p>Convenience init for subscribing to a service type.</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">initAndSubscribeToAppServiceType</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLAppServiceType.h@T@SDLAppServiceType">SDLAppServiceType</a></span><span class="p">)</span><span class="nv">serviceType</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="n">andSubscribeToAppServiceType</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLAppServiceType.h@T@SDLAppServiceType">SDLAppServiceType</a></span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>serviceType</dt>
<dd><p>The app service type</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLGetAppServiceData object</p>
</div>
<h3 id="section--initAndUnsubscribeToAppServiceType:">
-initAndUnsubscribeToAppServiceType:
</h3>
<p>Convenience init for unsubscribing to a service type</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">initAndUnsubscribeToAppServiceType</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLAppServiceType.h@T@SDLAppServiceType">SDLAppServiceType</a></span><span class="p">)</span><span class="nv">serviceType</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="n">andUnsubscribeToAppServiceType</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLAppServiceType.h@T@SDLAppServiceType">SDLAppServiceType</a></span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>serviceType</dt>
<dd><p>The app service type</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLGetAppServiceData object</p>
</div>
<h3 id="section-serviceType">
serviceType
</h3>
<p>The type of service that is to be offered by this app. See <code>AppServiceType</code> for known enum equivalent types. Parameter is a string to allow for new service types to be used by apps on older versions of SDL Core.</p>
<p>String, See <code><a href="../Type%20Definitions.html#/c:SDLAppServiceType.h@T@SDLAppServiceType">SDLAppServiceType</a></code>, Required</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">serviceType</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">serviceType</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>
<h3 id="section-subscribe">
subscribe
</h3>
<p>If true, the consumer is requesting to subscribe to all future updates from the service publisher. If false, the consumer doesn’t wish to subscribe and should be unsubscribed if it was previously subscribed.</p>
<p>Boolean, Optional</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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">subscribe</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">subscribe</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</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>
|
