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
|
<h1>SDLAppServiceRecord Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--initWithServiceID:serviceManifest:servicePublished:serviceActive:">-initWithServiceID:serviceManifest:servicePublished:serviceActive:</a></li>
<li><a href="#section-serviceID">serviceID</a></li>
<li><a href="#section-serviceManifest">serviceManifest</a></li>
<li><a href="#section-servicePublished">servicePublished</a></li>
<li><a href="#section-serviceActive">serviceActive</a></li>
</ul>
<h3>Overview</h3>
<p>This is the record of an app service publisher that the module has. It should contain the most up to date information including the service’s active state.</p>
<p>@since RPC 5.1</p>
<section class="section task-group-section">
<h3 id="section--initWithServiceID:serviceManifest:servicePublished:serviceActive:">
-initWithServiceID:serviceManifest:servicePublished:serviceActive:
</h3>
<p>Convenience init for all 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">initWithServiceID</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">serviceID</span>
<span class="nf">serviceManifest</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAppServiceManifest.html">SDLAppServiceManifest</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceManifest</span>
<span class="nf">servicePublished</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">servicePublished</span>
<span class="nf">serviceActive</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">serviceActive</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">serviceID</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">serviceManifest</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAppServiceManifest.html">SDLAppServiceManifest</a></span><span class="p">,</span> <span class="nv">servicePublished</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">serviceActive</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>serviceID</dt>
<dd><p>A unique ID tied to this specific service record</p></dd>
<dt>serviceManifest</dt>
<dd><p>Manifest for the service that this record is for</p></dd>
<dt>servicePublished</dt>
<dd><p>If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable</p></dd>
<dt>serviceActive</dt>
<dd><p>If true, the service is the active primary service of the supplied service type.</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLAppServiceRecord object</p>
</div>
<h3 id="section-serviceID">
serviceID
</h3>
<p>A unique ID tied to this specific service record. The ID is supplied by the module that services publish themselves.</p>
<p>String, Required</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">serviceID</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">serviceID</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-serviceManifest">
serviceManifest
</h3>
<p>Manifest for the service that this record is for.</p>
<p>SDLAppServiceManifest, Required</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="../Classes/SDLAppServiceManifest.html">SDLAppServiceManifest</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">serviceManifest</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">serviceManifest</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAppServiceManifest.html">SDLAppServiceManifest</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-servicePublished">
servicePublished
</h3>
<p>If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable.</p>
<p>Boolean, Required</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">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">_Nonnull</span> <span class="n">servicePublished</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">servicePublished</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="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-serviceActive">
serviceActive
</h3>
<p>If true, the service is the active primary service of the supplied service type. It will receive all potential RPCs that are passed through to that service type. If false, it is not the primary service of the supplied type. See servicePublished for its availability.</p>
<p>Boolean, Required</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">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">_Nonnull</span> <span class="n">serviceActive</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">serviceActive</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="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</section>
|
