summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLDisplayCapability.html
blob: cd09d6e8ef6657ff5dc9c8c3001ae2a885c5ae44 (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
<h1>SDLDisplayCapability Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithDisplayName:">-initWithDisplayName:</a></li>
  <li><a href="#section--initWithDisplayName:windowCapabilities:windowTypeSupported:">-initWithDisplayName:windowCapabilities:windowTypeSupported:</a></li>
  <li><a href="#section-displayName">displayName</a></li>
  <li><a href="#section-windowTypeSupported">windowTypeSupported</a></li>
  <li><a href="#section-windowCapabilities">windowCapabilities</a></li>
</ul>

<h3>Overview</h3>

<p>Contain the display related information and all windows related to that display.</p>

<p>@since SDL 6.0</p>


<section class="section task-group-section">
  <h3 id="section--initWithDisplayName:">
      -initWithDisplayName:
  </h3>
  
  <p>Init with required properties</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">initWithDisplayName</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">displayName</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">displayName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>displayName</dt>
      <dd><p>Name of the display.</p></dd>
  </dl>
  
  <h3 id="section--initWithDisplayName:windowCapabilities:windowTypeSupported:">
      -initWithDisplayName:windowCapabilities:windowTypeSupported:
  </h3>
  
  <p>Init with all the properties</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">initWithDisplayName</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">displayName</span>
     <span class="nf">windowCapabilities</span><span class="p">:</span>
         <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLWindowCapability.html">SDLWindowCapability</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">windowCapabilities</span>
    <span class="nf">windowTypeSupported</span><span class="p">:</span>
        <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLWindowTypeCapabilities.html">SDLWindowTypeCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">windowTypeSupported</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">displayName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">windowCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLWindowCapability.html">SDLWindowCapability</a></span><span class="p">]?,</span> <span class="nv">windowTypeSupported</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLWindowTypeCapabilities.html">SDLWindowTypeCapabilities</a></span><span class="p">]?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>displayName</dt>
      <dd><p>Name of the display.</p></dd>
      <dt>windowCapabilities</dt>
      <dd><p>Contains a list of capabilities of all windows related to the app. - see: windowCapabilities</p></dd>
      <dt>windowTypeSupported</dt>
      <dd><p>Informs the application how many windows the app is allowed to create per type.</p></dd>
  </dl>
  
  <h3 id="section-displayName">
      displayName
  </h3>
  
  <p>Name of the display.</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">displayName</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">displayName</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-windowTypeSupported">
      windowTypeSupported
  </h3>
  
  <p>Informs the application how many windows the app is allowed to create per type.</p>

<p>Min size 1
Max size 100</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">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLWindowTypeCapabilities.html">SDLWindowTypeCapabilities</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">windowTypeSupported</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">windowTypeSupported</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLWindowTypeCapabilities.html">SDLWindowTypeCapabilities</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>

  
  
  
  <h3 id="section-windowCapabilities">
      windowCapabilities
  </h3>
  
  <p>Contains a list of capabilities of all windows related to the app. Once the app has registered the capabilities of all windows will be provided, but GetSystemCapability still allows requesting window capabilities of all windows.</p>

<p>After registration, only windows with capabilities changed will be included. Following cases will cause only affected windows to be included:</p>

<ol>
<li>App creates a new window. After the window is created, a system capability notification will be sent related only to the created window.</li>
<li>App sets a new template to the window. The new template changes window capabilities. The notification will reflect those changes to the single window.</li>
</ol>

<p>Min size 1, Max size 1000</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">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLWindowCapability.html">SDLWindowCapability</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">windowCapabilities</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">windowCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLWindowCapability.html">SDLWindowCapability</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>