summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLRPCMessage.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLRPCMessage.html')
-rw-r--r--docs/Classes/SDLRPCMessage.html77
1 files changed, 61 insertions, 16 deletions
diff --git a/docs/Classes/SDLRPCMessage.html b/docs/Classes/SDLRPCMessage.html
index a70ad1917..f6cbc6d30 100644
--- a/docs/Classes/SDLRPCMessage.html
+++ b/docs/Classes/SDLRPCMessage.html
@@ -72,12 +72,12 @@
-initWithName:
</h3>
- <p>Undocumented</p>
+ <p>Convenience init</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre>
+ <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">initWithName</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">name</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -85,17 +85,27 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>name</dt>
+ <dd><p>The name of the message</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>A SDLRPCMessage object</p>
+ </div>
<h3 id="section--initWithDictionary:">
-initWithDictionary:
</h3>
- <p>Undocumented</p>
+ <p>Convenience init</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre>
+ <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">initWithDictionary</span><span class="p">:</span>
+ <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -103,12 +113,21 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>dict</dt>
+ <dd><p>A dictionary with the format @{messageType: @{parameters}}</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>A SDLRPCMessage object</p>
+ </div>
<h3 id="section--getFunctionName">
-getFunctionName
</h3>
- <p>Undocumented</p>
+ <p>Returns the function name.</p>
@@ -121,12 +140,16 @@
+ <div>
+ <h4>Return Value</h4>
+ <p>The function name</p>
+ </div>
<h3 id="section--setFunctionName:">
-setFunctionName:
</h3>
- <p>Undocumented</p>
+ <p>Sets the function name.</p>
@@ -139,17 +162,22 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>functionName</dt>
+ <dd><p>The function name</p></dd>
+ </dl>
<h3 id="section--getParameters:">
-getParameters:
</h3>
- <p>Undocumented</p>
+ <p>Returns the value associated with the provided key. If the key does not exist, null is returned.</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nf">getParameters</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span><span class="p">;</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nf">getParameters</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">functionName</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -157,17 +185,27 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>functionName</dt>
+ <dd><p>The key name</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>The value associated with the function name</p>
+ </div>
<h3 id="section--setParameters:value:">
-setParameters:value:
</h3>
- <p>Undocumented</p>
+ <p>Sets a key-value pair using the function name as the key.</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setParameters</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> <span class="nf">value</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setParameters</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">functionName</span>
+ <span class="nf">value</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -175,17 +213,24 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>functionName</dt>
+ <dd><p>The name for the key</p></dd>
+ <dt>value</dt>
+ <dd><p>The value associated with the function name</p></dd>
+ </dl>
<h3 id="section-bulkData">
bulkData
</h3>
- <p>Undocumented</p>
+ <p>The data in the message</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSData</span> <span class="o">*</span><span class="n">bulkData</span></code></pre>
+ <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">NSData</span> <span class="o">*</span><span class="n">bulkData</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -198,12 +243,12 @@
name
</h3>
- <p>Undocumented</p>
+ <p>The name of the message</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">name</span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">name</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -216,12 +261,12 @@
messageType
</h3>
- <p>Undocumented</p>
+ <p>The type of data in the message</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n"><a href="../Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@messageType">messageType</a></span></code></pre>
+ <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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"><a href="../Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@messageType">messageType</a></span><span class="p">;</span></code></pre>
<h4>Swift</h4>