diff options
Diffstat (limited to 'docs/Classes/SDLConfiguration.html')
| -rw-r--r-- | docs/Classes/SDLConfiguration.html | 208 |
1 files changed, 193 insertions, 15 deletions
diff --git a/docs/Classes/SDLConfiguration.html b/docs/Classes/SDLConfiguration.html index 8cf87a88c..3a05a5818 100644 --- a/docs/Classes/SDLConfiguration.html +++ b/docs/Classes/SDLConfiguration.html @@ -7,10 +7,15 @@ <li><a href="#section-lockScreenConfig">lockScreenConfig</a></li> <li><a href="#section-loggingConfig">loggingConfig</a></li> <li><a href="#section-streamingMediaConfig">streamingMediaConfig</a></li> + <li><a href="#section-fileManagerConfig">fileManagerConfig</a></li> <li><a href="#section--initWithLifecycle:lockScreen:logging:">-initWithLifecycle:lockScreen:logging:</a></li> + <li><a href="#section--initWithLifecycle:lockScreen:logging:fileManager:">-initWithLifecycle:lockScreen:logging:fileManager:</a></li> <li><a href="#section-+configurationWithLifecycle:lockScreen:logging:">+configurationWithLifecycle:lockScreen:logging:</a></li> + <li><a href="#section-+configurationWithLifecycle:lockScreen:logging:fileManager:">+configurationWithLifecycle:lockScreen:logging:fileManager:</a></li> <li><a href="#section--initWithLifecycle:lockScreen:logging:streamingMedia:">-initWithLifecycle:lockScreen:logging:streamingMedia:</a></li> + <li><a href="#section--initWithLifecycle:lockScreen:logging:streamingMedia:fileManager:">-initWithLifecycle:lockScreen:logging:streamingMedia:fileManager:</a></li> <li><a href="#section-+configurationWithLifecycle:lockScreen:logging:streamingMedia:">+configurationWithLifecycle:lockScreen:logging:streamingMedia:</a></li> + <li><a href="#section-+configurationWithLifecycle:lockScreen:logging:streamingMedia:fileManager:">+configurationWithLifecycle:lockScreen:logging:streamingMedia:fileManager:</a></li> </ul> <h3>Overview</h3> @@ -80,7 +85,7 @@ streamingMediaConfig </h3> - <p>The configuration</p> + <p>The streaming media configuration.</p> @@ -95,11 +100,30 @@ + <h3 id="section-fileManagerConfig"> + fileManagerConfig + </h3> + + <p>The file manager configuration.</p> + + + + <h4>Objective-C</h4> + <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">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">fileManagerConfig</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">fileManagerConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + <h3 id="section--initWithLifecycle:lockScreen:logging:"> -initWithLifecycle:lockScreen:logging: </h3> - <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</p> + <p>Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen and logging configurations.</p> @@ -120,9 +144,46 @@ <dt>lifecycleConfig</dt> <dd><p>The lifecycle configuration to be used.</p></dd> <dt>lockScreenConfig</dt> - <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd> + <dd><p>The lockscreen configuration to be used. If nil, the <code>enabledConfiguration</code> will be used.</p></dd> + <dt>logConfig</dt> + <dd><p>The logging configuration to be used. If nil, the <code>defaultConfiguration</code> will be used.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + + <h3 id="section--initWithLifecycle:lockScreen:logging:fileManager:"> + -initWithLifecycle:lockScreen:logging:fileManager: + </h3> + + <p>Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging and file manager configurations.</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">initWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span> + <span class="nf">lockScreen</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span> + <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span> + <span class="nf">fileManager</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</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">lifecycle</span> <span class="nv">lifecycleConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span><span class="p">,</span> <span class="n">lockScreen</span> <span class="nv">lockScreenConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span><span class="p">?,</span> <span class="n">logging</span> <span class="nv">logConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span><span class="p">?,</span> <span class="n">fileManager</span> <span class="nv">fileManagerConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span><span class="p">?)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>lifecycleConfig</dt> + <dd><p>The lifecycle configuration to be used.</p></dd> + <dt>lockScreenConfig</dt> + <dd><p>The lockscreen configuration to be used. If nil, the <code>enabledConfiguration</code> will be used.</p></dd> <dt>logConfig</dt> - <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd> + <dd><p>The logging configuration to be used. If nil, the <code>defaultConfiguration</code> will be used.</p></dd> + <dt>fileManagerConfig</dt> + <dd><p>The file manager configuration to be used or <code>defaultConfiguration</code> if nil.</p></dd> </dl> <div> <h4>Return Value</h4> @@ -133,7 +194,7 @@ +configurationWithLifecycle:lockScreen:logging: </h3> - <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</p> + <p>Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen and logging configurations.</p> @@ -152,9 +213,45 @@ <dt>lifecycleConfig</dt> <dd><p>The lifecycle configuration to be used.</p></dd> <dt>lockScreenConfig</dt> - <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd> + <dd><p>The lockscreen configuration to be used. If nil, the <code>enabledConfiguration</code> will be used.</p></dd> + <dt>logConfig</dt> + <dd><p>The logging configuration to be used. If nil, the <code>defaultConfiguration</code> will be used.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + + <h3 id="section-+configurationWithLifecycle:lockScreen:logging:fileManager:"> + +configurationWithLifecycle:lockScreen:logging:fileManager: + </h3> + + <p>Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging and file manager configurations.</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">configurationWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span> + <span class="nf">lockScreen</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span> + <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span> + <span class="nf">fileManager</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>lifecycleConfig</dt> + <dd><p>The lifecycle configuration to be used.</p></dd> + <dt>lockScreenConfig</dt> + <dd><p>The lockscreen configuration to be used. If nil, the <code>enabledConfiguration</code> will be used.</p></dd> <dt>logConfig</dt> - <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd> + <dd><p>The logging configuration to be used. If nil, the <code>defaultConfiguration</code> will be used.</p></dd> + <dt>fileManagerConfig</dt> + <dd><p>The file manager configuration to be used or <code>defaultConfiguration</code> if nil.</p></dd> </dl> <div> <h4>Return Value</h4> @@ -165,7 +262,7 @@ -initWithLifecycle:lockScreen:logging:streamingMedia: </h3> - <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</p> + <p>Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging and streaming media configurations.</p> @@ -188,11 +285,52 @@ <dt>lifecycleConfig</dt> <dd><p>The lifecycle configuration to be used.</p></dd> <dt>lockScreenConfig</dt> - <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd> + <dd><p>The lockscreen configuration to be used. If nil, the <code>enabledConfiguration</code> will be used.</p></dd> + <dt>logConfig</dt> + <dd><p>The logging configuration to be used. If nil, the <code>defaultConfiguration</code> will be used.</p></dd> + <dt>streamingMediaConfig</dt> + <dd><p>The streaming media configuration to be used or nil if not used.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + + <h3 id="section--initWithLifecycle:lockScreen:logging:streamingMedia:fileManager:"> + -initWithLifecycle:lockScreen:logging:streamingMedia:fileManager: + </h3> + + <p>Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging, streaming media and file manager configurations.</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">initWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span> + <span class="nf">lockScreen</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span> + <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span> + <span class="nf">streamingMedia</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">streamingMediaConfig</span> + <span class="nf">fileManager</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</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">lifecycle</span> <span class="nv">lifecycleConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span><span class="p">,</span> <span class="n">lockScreen</span> <span class="nv">lockScreenConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span><span class="p">?,</span> <span class="n">logging</span> <span class="nv">logConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span><span class="p">?,</span> <span class="n">streamingMedia</span> <span class="nv">streamingMediaConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span><span class="p">?,</span> <span class="n">fileManager</span> <span class="nv">fileManagerConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span><span class="p">?)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>lifecycleConfig</dt> + <dd><p>The lifecycle configuration to be used.</p></dd> + <dt>lockScreenConfig</dt> + <dd><p>The lockscreen configuration to be used. If nil, the <code>enabledConfiguration</code> will be used.</p></dd> <dt>logConfig</dt> - <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd> + <dd><p>The logging configuration to be used. If nil, the <code>defaultConfiguration</code> will be used.</p></dd> <dt>streamingMediaConfig</dt> - <dd><p>The streaming media configuration to be used, or nil because it is not needed.</p></dd> + <dd><p>The streaming media configuration to be used or nil if not used.</p></dd> + <dt>fileManagerConfig</dt> + <dd><p>The file manager configuration to be used or <code>defaultConfiguration</code> if nil.</p></dd> </dl> <div> <h4>Return Value</h4> @@ -203,7 +341,7 @@ +configurationWithLifecycle:lockScreen:logging:streamingMedia: </h3> - <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</p> + <p>Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging and streaming media configurations.</p> @@ -224,11 +362,51 @@ <dt>lifecycleConfig</dt> <dd><p>The lifecycle configuration to be used.</p></dd> <dt>lockScreenConfig</dt> - <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd> + <dd><p>The lockscreen configuration to be used. If nil, the <code>enabledConfiguration</code> will be used.</p></dd> + <dt>logConfig</dt> + <dd><p>The logging configuration to be used. If nil, the <code>defaultConfiguration</code> will be used.</p></dd> + <dt>streamingMediaConfig</dt> + <dd><p>The streaming media configuration to be used or nil if not used.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + + <h3 id="section-+configurationWithLifecycle:lockScreen:logging:streamingMedia:fileManager:"> + +configurationWithLifecycle:lockScreen:logging:streamingMedia:fileManager: + </h3> + + <p>Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging, streaming media and file manager configurations.</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">configurationWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span> + <span class="nf">lockScreen</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span> + <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span> + <span class="nf">streamingMedia</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">streamingMediaConfig</span> + <span class="nf">fileManager</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>lifecycleConfig</dt> + <dd><p>The lifecycle configuration to be used.</p></dd> + <dt>lockScreenConfig</dt> + <dd><p>The lockscreen configuration to be used. If nil, the <code>enabledConfiguration</code> will be used.</p></dd> <dt>logConfig</dt> - <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd> + <dd><p>The logging configuration to be used. If nil, the <code>defaultConfiguration</code> will be used.</p></dd> <dt>streamingMediaConfig</dt> - <dd><p>The streaming media configuration to be used, or nil because it is not needed.</p></dd> + <dd><p>The streaming media configuration to be used or nil if not used.</p></dd> + <dt>fileManagerConfig</dt> + <dd><p>The file manager configuration to be used or <code>defaultConfiguration</code> if nil.</p></dd> </dl> <div> <h4>Return Value</h4> |