summaryrefslogtreecommitdiff
path: root/docs/Enums.html
blob: 7d531fabf486ef1b33e798b53457e48200e34b27 (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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<h1>Enums  Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-SDLArtworkImageFormat">SDLArtworkImageFormat</a></li>
  <li><a href="#section-SDLManagerError">SDLManagerError</a></li>
  <li><a href="#section-SDLFileManagerError">SDLFileManagerError</a></li>
  <li><a href="#section-SDLLogBytesDirection">SDLLogBytesDirection</a></li>
  <li><a href="#section-SDLLogFlag">SDLLogFlag</a></li>
  <li><a href="#section-SDLLogLevel">SDLLogLevel</a></li>
  <li><a href="#section-SDLLogFormatType">SDLLogFormatType</a></li>
  <li><a href="#section-SDLPermissionGroupType">SDLPermissionGroupType</a></li>
  <li><a href="#section-SDLPermissionGroupStatus">SDLPermissionGroupStatus</a></li>
  <li><a href="#section-SDLProtocolError">SDLProtocolError</a></li>
  <li><a href="#section-SDLFrameType">SDLFrameType</a></li>
  <li><a href="#section-SDLServiceType">SDLServiceType</a></li>
  <li><a href="#section-SDLFrameInfo">SDLFrameInfo</a></li>
  <li><a href="#section-SDLRPCMessageType">SDLRPCMessageType</a></li>
  <li><a href="#section-SDLStreamingEncryptionFlag">SDLStreamingEncryptionFlag</a></li>
</ul>

<h3>Overview</h3>

<p>The following enums are available globally.</p>


<section class="section task-group-section">
  <h3 id="section-SDLArtworkImageFormat">
      SDLArtworkImageFormat
  </h3>
  
  <p>Undocumented</p>

  <a href="Enums/SDLArtworkImageFormat.html" class="slightly-smaller">See more</a>
  
  
  
  
  
  <h3 id="section-SDLManagerError">
      SDLManagerError
  </h3>
  
  <p>Errors associated with the SDLManager class.</p>

  <a href="Enums/SDLManagerError.html" class="slightly-smaller">See more</a>
  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">enum</span> <span class="n">SDLManagerError</span> <span class="p">{}</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">enum</span> <span class="kt">SDLManagerError</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>

  
  
  
  <h3 id="section-SDLFileManagerError">
      SDLFileManagerError
  </h3>
  
  <p>Errors associated with the SDLFileManager class.</p>

  <a href="Enums/SDLFileManagerError.html" class="slightly-smaller">See more</a>
  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">enum</span> <span class="n">SDLFileManagerError</span> <span class="p">{}</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">enum</span> <span class="kt">SDLFileManagerError</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>

  
  
  
  <h3 id="section-SDLLogBytesDirection">
      SDLLogBytesDirection
  </h3>
  
  <p>Undocumented</p>

  <a href="Enums/SDLLogBytesDirection.html" class="slightly-smaller">See more</a>
  
  
  
  
  
  <h3 id="section-SDLLogFlag">
      SDLLogFlag
  </h3>
  
  <p>Flags used for SDLLogLevel to provide correct enum values. This is purely for internal use.</p>

<ul>
<li>SDLLogFlagVerbose:   Verbose level logging</li>
<li>SDLLogFlagDebug:     Debug level logging</li>
<li>SDLLogFlagWarning:   Warning level logging</li>
<li>SDLLogFlagError:     Error level logging.</li>
</ul>

  <a href="Enums/SDLLogFlag.html" class="slightly-smaller">See more</a>
  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">enum</span> <span class="n">SDLLogFlag</span> <span class="p">{}</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">struct</span> <span class="kt">SDLLogFlag</span> <span class="p">:</span> <span class="kt">OptionSet</span></code></pre>

  
  
  
  <h3 id="section-SDLLogLevel">
      SDLLogLevel
  </h3>
  
  <p>An enum describing a level of logging.</p>

<ul>
<li>SDLLogLevelDefault:  This is used to describe that a <q>specific</q> logging will instead use the global log level, for example, a module may use the global log level instead of its own by specifying this level.</li>
<li>SDLLogLevelOff:      This is used to describe a level that involves absolutely no logs being output.</li>
<li>SDLLogLevelError:    Only error level logs will be output.</li>
<li>SDLLogLevelWarning:  Both error and warning level logs will be output.</li>
<li>SDLLogLevelDebug:    Error, warning, and debug level logs will be output. This level will never be output in RELEASE environments.</li>
<li>SDLLogLevelVerbose:  All level logs will be output. This level will never be output in RELEASE environments.</li>
</ul>

  <a href="Enums/SDLLogLevel.html" class="slightly-smaller">See more</a>
  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">enum</span> <span class="n">SDLLogLevel</span> <span class="p">{}</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">enum</span> <span class="kt">SDLLogLevel</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>

  
  
  
  <h3 id="section-SDLLogFormatType">
      SDLLogFormatType
  </h3>
  
  <p>The output format of logs; how they will appear when printed out into a string.</p>

<ul>
<li>SDLLogFormatTypeSimple:      A bare-bones log format: <code>09:52:07:324 🔹 (SDL)Protocol – a random test i guess</code></li>
<li>SDLLogFormatTypeDefault:     A middle detail default log format: <code>09:52:07:324 🔹 (SDL)Protocol:SDLV2ProtocolHeader:25 – Some log message</code></li>
<li>SDLLogFormatTypeDetailed:    A very detailed log format: <code>09:52:07:324 🔹 DEBUG com.apple.main-thread:(SDL)Protocol:[SDLV2ProtocolHeader parse:]:74 – Some log message</code></li>
</ul>

  <a href="Enums/SDLLogFormatType.html" class="slightly-smaller">See more</a>
  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">enum</span> <span class="n">SDLLogFormatType</span> <span class="p">{}</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">enum</span> <span class="kt">SDLLogFormatType</span> <span class="p">:</span> <span class="kt">UInt</span></code></pre>

  
  
  
  <h3 id="section-SDLPermissionGroupType">
      SDLPermissionGroupType
  </h3>
  
  <p>A permission group type which will be used to tell the system what type of changes you want to be notified about for the group.</p>

  <a href="Enums/SDLPermissionGroupType.html" class="slightly-smaller">See more</a>
  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">enum</span> <span class="n">SDLPermissionGroupType</span> <span class="p">{}</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">enum</span> <span class="kt">SDLPermissionGroupType</span> <span class="p">:</span> <span class="kt">UInt</span></code></pre>

  
  
  
  <h3 id="section-SDLPermissionGroupStatus">
      SDLPermissionGroupStatus
  </h3>
  
  <p>The status of the group of RPCs permissions.</p>

  <a href="Enums/SDLPermissionGroupStatus.html" class="slightly-smaller">See more</a>
  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">enum</span> <span class="n">SDLPermissionGroupStatus</span> <span class="p">{}</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">enum</span> <span class="kt">SDLPermissionGroupStatus</span> <span class="p">:</span> <span class="kt">UInt</span></code></pre>

  
  
  
  <h3 id="section-SDLProtocolError">
      SDLProtocolError
  </h3>
  
  <p>Undocumented</p>

  <a href="Enums/SDLProtocolError.html" class="slightly-smaller">See more</a>
  
  
  
  
  
  <h3 id="section-SDLFrameType">
      SDLFrameType
  </h3>
  
  <p>Undocumented</p>

  <a href="Enums/SDLFrameType.html" class="slightly-smaller">See more</a>
  
  
  
  
  
  <h3 id="section-SDLServiceType">
      SDLServiceType
  </h3>
  
  <p>Undocumented</p>

  <a href="Enums/SDLServiceType.html" class="slightly-smaller">See more</a>
  
  
  
  
  
  <h3 id="section-SDLFrameInfo">
      SDLFrameInfo
  </h3>
  
  <p>Undocumented</p>

  <a href="Enums/SDLFrameInfo.html" class="slightly-smaller">See more</a>
  
  
  
  
  
  <h3 id="section-SDLRPCMessageType">
      SDLRPCMessageType
  </h3>
  
  <p>Undocumented</p>

  <a href="Enums/SDLRPCMessageType.html" class="slightly-smaller">See more</a>
  
  
  
  
  
  <h3 id="section-SDLStreamingEncryptionFlag">
      SDLStreamingEncryptionFlag
  </h3>
  
  <p>Undocumented</p>

  <a href="Enums/SDLStreamingEncryptionFlag.html" class="slightly-smaller">See more</a>
  
  
  
  
  
</section>