-
Notifications
You must be signed in to change notification settings - Fork 19
/
Copy pathProtocols.html
412 lines (386 loc) · 20.8 KB
/
Protocols.html
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
<!DOCTYPE html>
<html lang="en">
<head>
<title>Protocols Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
</head>
<body>
<a title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Clue Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">Clue Reference</a>
<img id="carat" src="img/carat.png" />
Protocols Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Categories.html">Categories</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Categories/NSError(CLUNetworkAdditions).html">NSError(CLUNetworkAdditions)</a>
</li>
<li class="nav-group-task">
<a href="Categories/NSException(CLUExceptionAdditions).html">NSException(CLUExceptionAdditions)</a>
</li>
<li class="nav-group-task">
<a href="Categories/NSHTTPURLResponse(CLUNetworkAdditions).html">NSHTTPURLResponse(CLUNetworkAdditions)</a>
</li>
<li class="nav-group-task">
<a href="Categories/NSURLRequest(CLUNetworkAdditions).html">NSURLRequest(CLUNetworkAdditions)</a>
</li>
<li class="nav-group-task">
<a href="Categories/NSURLResponse(CLUNetworkAdditions).html">NSURLResponse(CLUNetworkAdditions)</a>
</li>
<li class="nav-group-task">
<a href="Categories.html#/c:objc(cy)UIImageView@CLUViewRecordableAdditions">UIImageView(CLUViewRecordableAdditions)</a>
</li>
<li class="nav-group-task">
<a href="Categories.html#/c:objc(cy)UILabel@CLUViewRecordableAdditions">UILabel(CLUViewRecordableAdditions)</a>
</li>
<li class="nav-group-task">
<a href="Categories.html#/c:objc(cy)UITextField@CLUViewRecordableAdditions">UITextField(CLUViewRecordableAdditions)</a>
</li>
<li class="nav-group-task">
<a href="Categories/UIView(CLUViewRecordableAdditions).html">UIView(CLUViewRecordableAdditions)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/CLUDataWriter.html">CLUDataWriter</a>
</li>
<li class="nav-group-task">
<a href="Classes.html#/c:objc(cs)CLUDeviceInfoModule">CLUDeviceInfoModule</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUExceptionInfoModule.html">CLUExceptionInfoModule</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUGeneralGestureRecognizer.html">CLUGeneralGestureRecognizer</a>
</li>
<li class="nav-group-task">
<a href="Classes.html#/c:objc(cs)CLUMailDelegate">CLUMailDelegate</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUMailHelper.html">CLUMailHelper</a>
</li>
<li class="nav-group-task">
<a href="Classes.html#/c:objc(cs)CLUNetworkModule">CLUNetworkModule</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUObserveModule.html">CLUObserveModule</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUOptions.html">CLUOptions</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLURecordIndicatorView.html">CLURecordIndicatorView</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLURecordIndicatorViewManager.html">CLURecordIndicatorViewManager</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUReportComposer.html">CLUReportComposer</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUReportFileManager.html">CLUReportFileManager</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUTouch.html">CLUTouch</a>
</li>
<li class="nav-group-task">
<a href="Classes.html#/c:objc(cs)CLUURLProtocol">CLUURLProtocol</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUURLProtocolConfiguration.html">CLUURLProtocolConfiguration</a>
</li>
<li class="nav-group-task">
<a href="Classes.html#/c:objc(cs)CLUUserInteractionModule">CLUUserInteractionModule</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUVideoModule.html">CLUVideoModule</a>
</li>
<li class="nav-group-task">
<a href="Classes/CLUVideoWriter.html">CLUVideoWriter</a>
</li>
<li class="nav-group-task">
<a href="Classes.html#/c:objc(cs)CLUViewStructureModule">CLUViewStructureModule</a>
</li>
<li class="nav-group-task">
<a href="Classes/ClueController.html">ClueController</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/CLUInfoModule.html">CLUInfoModule</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CLUInteractionObserverDelegate.html">CLUInteractionObserverDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CLUNetworkObserverDelegate.html">CLUNetworkObserverDelegate</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CLURecordableModule.html">CLURecordableModule</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CLUViewRecordableProperties.html">CLUViewRecordableProperties</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CLUWritable.html">CLUWritable</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Protocols</h1>
<p>The following protocols are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)CLUInfoModule"></a>
<a name="//apple_ref/objc/Protocol/CLUInfoModule" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)CLUInfoModule">CLUInfoModule</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p><code>CLUInfoModule</code> protocol describe info modules (like Device Info module or Exception module), static one-time modules which needs to write their data only once during recording.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Every info modules have to implement this protocol to be able to work normally inside the system
</div>
<a href="Protocols/CLUInfoModule.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight"><code><span class="k">@protocol</span> <span class="nc">CLUInfoModule</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre>
</div>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">protocol</span> <span class="kt">CLUInfoModule</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)CLUInteractionObserverDelegate"></a>
<a name="//apple_ref/objc/Protocol/CLUInteractionObserverDelegate" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)CLUInteractionObserverDelegate">CLUInteractionObserverDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p><code>CLUInteractionObserverDelegate</code> protocol describe delegate methods which will handle all touches events sent by custom gesture recognizer (see <code><a href="Classes/CLUGeneralGestureRecognizer.html">CLUGeneralGestureRecognizer</a></code>)</p>
<a href="Protocols/CLUInteractionObserverDelegate.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight"><code><span class="k">@protocol</span> <span class="nc">CLUInteractionObserverDelegate</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre>
</div>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">protocol</span> <span class="kt">CLUInteractionObserverDelegate</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)CLUNetworkObserverDelegate"></a>
<a name="//apple_ref/objc/Protocol/CLUNetworkObserverDelegate" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)CLUNetworkObserverDelegate">CLUNetworkObserverDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p><code>CLUNetworkObserverDelegate</code> protocol describe delegate methods which will handle all network operations events sent by custom <code>NSURLProtocol</code> (see <code><a href="Classes.html#/c:objc(cs)CLUURLProtocol">CLUURLProtocol</a></code> and <code><a href="Classes/CLUURLProtocolConfiguration.html">CLUURLProtocolConfiguration</a></code>)</p>
<a href="Protocols/CLUNetworkObserverDelegate.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight"><code><span class="k">@protocol</span> <span class="nc">CLUNetworkObserverDelegate</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre>
</div>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">protocol</span> <span class="kt">CLUNetworkObserverDelegate</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)CLURecordableModule"></a>
<a name="//apple_ref/objc/Protocol/CLURecordableModule" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)CLURecordableModule">CLURecordableModule</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p><code>CLURecordableModule</code> protocol describe recordable module (like Video, View Structure, Network modules etc) which needs to track or inspect some specific information over time (like view structure for example) and record this information with specific timestamp using Writers</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Every recordable modules have to implement this protocol to be able to work normally inside the system
</div>
<a href="Protocols/CLURecordableModule.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight"><code><span class="k">@protocol</span> <span class="nc">CLURecordableModule</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre>
</div>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">protocol</span> <span class="kt">CLURecordableModule</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)CLUViewRecordableProperties"></a>
<a name="//apple_ref/objc/Protocol/CLUViewRecordableProperties" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)CLUViewRecordableProperties">CLUViewRecordableProperties</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p><code>CLUViewRecordableProperties</code> protocol describe common interface for UIView’s (and all subclasses) properties parsing into dictionary which will be used in JSON encoding to the specific file.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Needs to be implemented in all custom UIView related categories with properties parsing methods (see <code>UIView (CLUViewRecordableAdditions)</code>, <code>UILabel (CLUViewRecordableAdditions)</code>, <code>UIImageView (CLUViewRecordableAdditions)</code>, <code>UITextField (CLUViewRecordableAdditions)</code> for exmaples)
</div>
<a href="Protocols/CLUViewRecordableProperties.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight"><code><span class="k">@protocol</span> <span class="nc">CLUViewRecordableProperties</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre>
</div>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">protocol</span> <span class="kt">CLUViewRecordableProperties</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)CLUWritable"></a>
<a name="//apple_ref/objc/Protocol/CLUWritable" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)CLUWritable">CLUWritable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p><code>CLUWritable</code> protocol describe writers (like <code><a href="Classes/CLUDataWriter.html">CLUDataWriter</a></code> or <code><a href="Classes/CLUVideoWriter.html">CLUVideoWriter</a></code>) which needs to actually write new data to specific file (could be text file, video file etc.)</p>
<a href="Protocols/CLUWritable.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight"><code><span class="k">@protocol</span> <span class="nc">CLUWritable</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre>
</div>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">protocol</span> <span class="kt">CLUWritable</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>© 2017 <a class="link" href="https://github.com/Geek-1001/Clue" target="_blank" rel="external">Ahmed Sulaiman</a>. All rights reserved. (Last updated: 2017-04-14)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>