/
Countly.xml
1018 lines (1018 loc) · 46.8 KB
/
Countly.xml
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>Countly</name>
</assembly>
<members>
<member name="T:CountlySDK.Countly">
<summary>
This class is the public API for the Countly Windows Phone SDK.
</summary>
</member>
<member name="M:CountlySDK.Countly.SaveCollection``1(System.Collections.Generic.List{``0},System.String)">
<summary>
Saves collection to the storage
</summary>
<returns>True if success, otherwise - False</returns>
</member>
<!-- Badly formed XML comment ignored for member "M:CountlySDK.Countly.UpdateSession(System.Object,System.Object)" -->
<member name="F:CountlySDK.Entities.CountlyConfig.deviceIdMethod">
<summary>
Which method for deviceId generation is used
</summary>
</member>
<member name="T:CountlySDK.Entities.Device">
<summary>
This class provides static methods to retrieve information about the current device.
</summary>
</member>
<member name="M:CountlySDK.Entities.Device.IsNetworkAvailable">
<summary>
Indicates whether any network connection is available
Filter connections below a specified speed, as well as virtual network cards.
</summary>
<returns>
<c>true</c> if a network connection is available; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:CountlySDK.Entities.Device.IsNetworkAvailable(System.Int64)">
<summary>
Indicates whether any network connection is available.
Filter connections below a specified speed, as well as virtual network cards.
</summary>
<param name="minimumSpeed">The minimum speed required. Passing 0 will not filter connection using speed.</param>
<returns>
<c>true</c> if a network connection is available; otherwise, <c>false</c>.
</returns>
</member>
<member name="M:CountlySDK.Entities.BeginSession.#ctor(System.String,CountlySDK.CountlyCommon.Entities.DeviceId,System.String,CountlySDK.Entities.Metrics,System.String,CountlySDK.Helpers.TimeHelper.TimeInstant)">
<summary>
Creates BeginSession object with provided values
</summary>
<param name="appKey">App key for the application being tracked; find in the Countly Dashboard under Management > Applications</param>
<param name="deviceId">Unique ID for the device the app is running on</param>
<param name="sdkVersion">SDK version string</param>
<param name="metrics">Metrics parameters</param>
</member>
<member name="M:CountlySDK.Entities.BeginSession.#ctor">
<summary>
Needed for JSON deserialization
</summary>
</member>
<member name="T:CountlySDK.Entities.CountlyEvent">
<summary>
This class holds the data for a single Count.ly custom event instance.
</summary>
</member>
<member name="P:CountlySDK.Entities.CountlyEvent.Key">
<summary>
Key attribute, must be non-empty
</summary>
</member>
<member name="P:CountlySDK.Entities.CountlyEvent.Count">
<summary>
Count parameter, must me positive number
</summary>
</member>
<member name="P:CountlySDK.Entities.CountlyEvent.Sum">
<summary>
Sum parameter, can be null
</summary>
</member>
<member name="P:CountlySDK.Entities.CountlyEvent.Duration">
<summary>
Duration of event, can be null
</summary>
</member>
<member name="P:CountlySDK.Entities.CountlyEvent.Timestamp">
<summary>
Timestamp of event, can be null
</summary>
</member>
<member name="P:CountlySDK.Entities.CountlyEvent.Segmentation">
<summary>
Segmentation parameter
</summary>
</member>
<member name="P:CountlySDK.Entities.CountlyEvent.segmentation">
<summary>
Segmentation json-ready object
</summary>
</member>
<member name="M:CountlySDK.Entities.CountlyEvent.#ctor">
<summary>
Needed for JSON deserialization
</summary>
</member>
<member name="M:CountlySDK.Entities.CountlyEvent.#ctor(System.String,System.Int32,System.Nullable{System.Double},System.Nullable{System.Double},CountlySDK.Segmentation,System.Nullable{System.Int64})">
<summary>
Create Countly event with provided values
</summary>
<param name="Key">Key attribute, must be non-empty</param>
<param name="Count">Count parameter, must me positive number</param>
<param name="Sum">Sum parameter, can be null</param>
<param name="Segmentation">Segmentation parameter</param>
</member>
<member name="T:CountlySDK.Entities.CountlyUserDetails">
<summary>
Holds user-specific info in json-ready format
</summary>
</member>
<member name="T:CountlySDK.Entities.CustomInfo">
<summary>
Holds a dictionary of custom info values
</summary>
</member>
<member name="E:CountlySDK.Entities.CustomInfo.CollectionChanged">
<summary>
Raised when collection is changed
</summary>
</member>
<member name="M:CountlySDK.Entities.CustomInfo.Add(System.String,System.String)">
<summary>
Adds new custom item
</summary>
<param name="Name">item name</param>
<param name="Value">item value</param>
</member>
<member name="M:CountlySDK.Entities.CustomInfo.Remove(System.String)">
<summary>
Removes custom item
</summary>
<param name="Name">item name</param>
</member>
<member name="M:CountlySDK.Entities.CustomInfo.Clear">
<summary>
Clears items collection
</summary>
</member>
<member name="P:CountlySDK.Entities.CustomInfo.Item(System.String)">
<summary>
Gets or sets item value based on provided item name
</summary>
<param name="name">item name</param>
<returns>item value</returns>
</member>
<member name="M:CountlySDK.Entities.CustomInfo.#ctor">
<summary>
Needed for JSON deserialization
</summary>
</member>
<member name="M:CountlySDK.Entities.CustomInfo.ToDictionary">
<summary>
Returns items as key/value dictionary pairs
</summary>
<returns></returns>
</member>
<member name="T:CountlySDK.Entities.CustomInfoItem">
<summary>
Holds data about segmentation value
</summary>
</member>
<member name="P:CountlySDK.Entities.CustomInfoItem.Name">
<summary>
Property name
</summary>
</member>
<member name="P:CountlySDK.Entities.CustomInfoItem.Value">
<summary>
Property value
</summary>
</member>
<member name="M:CountlySDK.Entities.CustomInfoItem.#ctor(System.String,System.String)">
<summary>
Creates object with provided values
</summary>
<param name="Name">Property name</param>
<param name="Value">Property value</param>
</member>
<member name="M:CountlySDK.Entities.CustomInfoItem.#ctor">
<summary>
Needed for JSON deserialization
</summary>
</member>
<member name="M:CountlySDK.Entities.EndSession.#ctor(System.String,CountlySDK.CountlyCommon.Entities.DeviceId,System.String,System.String,CountlySDK.Helpers.TimeHelper.TimeInstant,System.Nullable{System.Int64})">
<summary>
Creates EndSession object with provided values
</summary>
<param name="appKey">App key for the application being tracked; find in the Countly Dashboard under Management > Applications</param>
<param name="deviceId">Unique ID for the device the app is running on</param>
</member>
<member name="M:CountlySDK.Entities.EntityBase.DeviceBase.GetDeviceId">
<summary>
Returns the unique device identificator
</summary>
</member>
<member name="M:CountlySDK.Entities.EntityBase.DeviceBase.SetDeviceId(System.String)">
<summary>
Sets the unique device identificator
</summary>
</member>
<member name="M:CountlySDK.Entities.EntityBase.DeviceBase.InitDeviceId(CountlySDK.Entities.EntityBase.DeviceBase.DeviceIdMethodInternal,System.String)">
<summary>
Initialize deviceId with developer provided device id in configuration or with Random generated Id and Cache it.
</summary>
<param name="deviceIdMethod">preferred method</param>
<param name="suppliedDeviceId">device id to use</param>
<returns></returns>
</member>
<member name="M:CountlySDK.Entities.EntityBase.DeviceBase.SetPreferredDeviceIdMethod(CountlySDK.Entities.EntityBase.DeviceBase.DeviceIdMethodInternal,System.String)">
<summary>
Set preferred method for generating device id. If a Id is already provided, use that and
set method to developerSupplied
</summary>
<param name="deviceIdMethod">preferred method</param>
<param name="suppliedDeviceId">device id to use</param>
<returns></returns>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.OS">
<summary>
Returns the display name of the current operating system
</summary>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.OSVersion">
<summary>
Returns the current operating system version as a displayable string
</summary>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.Manufacturer">
<summary>
Returns the current device manufacturer
</summary>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.DeviceName">
<summary>
Returns the local machine name
</summary>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.AppVersion">
<summary>
Returns application version from Package.appxmanifest
</summary>
</member>
<!-- Badly formed XML comment ignored for member "P:CountlySDK.Entities.EntityBase.DeviceBase.Resolution" -->
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.Carrier">
<summary>
Returns cellular mobile operator
</summary>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.Orientation">
<summary>
Returns current device orientation
</summary>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.RamCurrent">
<summary>
Returns available RAM space
</summary>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.RamTotal">
<summary>
Returns total RAM size
</summary>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.Online">
<summary>
Returns current device connection to the internet
</summary>
</member>
<member name="P:CountlySDK.Entities.EntityBase.DeviceBase.Locale">
<summary>
Returns devices current locale
</summary>
</member>
<member name="T:CountlySDK.Entities.ExceptionEvent">
<summary>
This class holds the data about an application exception
</summary>
</member>
<member name="M:CountlySDK.Entities.ExceptionEvent.#ctor">
<summary>
Needed for JSON deserialization
</summary>
</member>
<member name="T:CountlySDK.Entities.Metrics">
<summary>
Holds device-specific info in json-ready format
</summary>
</member>
<member name="P:CountlySDK.Entities.Metrics.OS">
<summary>
Name of the current operating system
</summary>
</member>
<member name="P:CountlySDK.Entities.Metrics.OSVersion">
<summary>
Current operating system version
</summary>
</member>
<member name="P:CountlySDK.Entities.Metrics.Device">
<summary>
Local machine name (windows) or current device model (mobile)
</summary>
</member>
<member name="P:CountlySDK.Entities.Metrics.Resolution">
<summary>
Device resolution
</summary>
</member>
<member name="P:CountlySDK.Entities.Metrics.Carrier">
<summary>
Cellular mobile operator (where applicable)
</summary>
</member>
<member name="P:CountlySDK.Entities.Metrics.AppVersion">
<summary>
Application version
</summary>
</member>
<member name="P:CountlySDK.Entities.Metrics.Locale">
<summary>
Locale
</summary>
</member>
<member name="M:CountlySDK.Entities.Metrics.#ctor(System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
Creates Metrics object with provided values
</summary>
<param name="OS">Name of the current operating system</param>
<param name="OSVersion">Current operating system version</param>
<param name="Device">Current device model</param>
<param name="Resolution">Device resolution</param>
<param name="Carrier">Cellular mobile operator</param>
<param name="AppVersion">Application version</param>
</member>
<member name="M:CountlySDK.Entities.Metrics.ToString">
<summary>
Serializes object into json
</summary>
<returns></returns>
</member>
<member name="M:CountlySDK.Entities.UpdateSession.#ctor(System.String,CountlySDK.CountlyCommon.Entities.DeviceId,System.Int32,System.String,System.String,CountlySDK.Helpers.TimeHelper.TimeInstant)">
<summary>
Creates UpdateSession object with provided values
</summary>
<param name="appKey">App key for the application being tracked; find in the Countly Dashboard under Management > Applications</param>
<param name="deviceId">Unique ID for the device the app is running on</param>
<param name="duration">Session duration in seconds</param>
</member>
<member name="M:CountlySDK.Helpers.StorageNetStd.DeleteFile(System.String)">
<summary>
Delete file
</summary>
<param name="filename">Filename to delete</param>
</member>
<member name="T:CountlySDK.Helpers.TimerHelper">
<summary>
Used in place of DispatchTimer
</summary>
</member>
<member name="M:CountlySDK.Helpers.TimeHelper.ToUnixTime(System.DateTime)">
<summary>
Converts DateTime to Unix time format
</summary>
<param name="date">DateTime object</param>
<returns>Unix timestamp</returns>
</member>
<member name="M:CountlySDK.Helpers.UtilityHelper.IsNullOrEmptyOrWhiteSpace(System.String)">
<summary>
Indicates whether the given value is null, empty or consists only of white space characters
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:CountlySDK.Helpers.UtilityHelper.GenerateStreamFromString(System.String)">
<summary>
Create a stream from given string
Used when sending data to server
</summary>
<param name="s"></param>
<returns></returns>
</member>
<member name="P:CountlySDK.CountlyCommon.CountlyBase.IsLoggingEnabled">
<summary>
Determines if Countly debug messages are displayed to Output window
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.SaveEvents">
<summary>
Saves events to the storage
</summary>
<returns>True if success, otherwise - False</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.SaveSessions">
<summary>
Saves sessions to the storage
</summary>
<returns>True if success, otherwise - False</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.SaveExceptions">
<summary>
Saves exceptions to the storage
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.SaveUnhandledException(CountlySDK.Entities.ExceptionEvent)">
<summary>
Saves the given unhandled exception to storage
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.SaveUserDetails">
<summary>
Saves user details info to the storage
</summary>
</member>
<!-- Badly formed XML comment ignored for member "M:CountlySDK.CountlyCommon.CountlyBase.Upload" -->
<member name="M:CountlySDK.CountlyCommon.CountlyBase.UploadSessions">
<summary>
Uploads sessions queue to Countly server
</summary>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.StartEvent(System.String)">
<summary>
Start a timed event.
</summary>
<param name="key">event key</param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.CancelEvent(System.String)">
<summary>
Cancel a timed event.
</summary>
<param name="key">event key</param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.CancelAllTimedEvents">
<summary>
Add all recorded events to request queue
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.EndEvent(System.String,CountlySDK.Segmentation,System.Int32,System.Nullable{System.Double})">
<summary>
End a timed event.
</summary>
<param name="key">event key</param>
<param name="segmentation">custom segmentation you want to set, leave null if you don't want to add anything</param>
<param name="count">how many of these events have occurred, default value is "1"</param>
<param name="sum">set sum if needed, default value is "0"</param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordEvent(System.String)">
<summary>
Records a custom event with no segmentation values, a count of one and a sum of zero
</summary>
<param name="Key">Name of the custom event, required, must not be the empty string</param>
<returns>True if event is uploaded successfully, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordEvent(System.String,System.Int32)">
<summary>
Records a custom event with no segmentation values, the specified count, and a sum of zero.
</summary>
<param name="Key">Name of the custom event, required, must not be the empty string</param>
<param name="Count">Count to associate with the event, should be more than zero</param>
<returns>True if event is uploaded successfully, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordEvent(System.String,System.Int32,System.Nullable{System.Double})">
<summary>
Records a custom event with no segmentation values, and the specified count and sum.
</summary>
<param name="Key">Name of the custom event, required, must not be the empty string</param>
<param name="Count">Count to associate with the event, should be more than zero</param>
<param name="Sum">Sum to associate with the event</param>
<returns>True if event is uploaded successfully, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordEvent(System.String,System.Int32,CountlySDK.Segmentation)">
<summary>
Records a custom event with the specified segmentation values and count, and a sum of zero.
</summary>
<param name="Key">Name of the custom event, required, must not be the empty string</param>
<param name="Count">Count to associate with the event, should be more than zero</param>
<param name="Segmentation">Segmentation object to associate with the event, can be null</param>
<returns>True if event is uploaded successfully, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordEvent(System.String,System.Int32,System.Nullable{System.Double},CountlySDK.Segmentation)">
<summary>
Records a custom event with the specified segmentation values, count and a sum
</summary>
<param name="Key">Name of the custom event, required, must not be the empty string</param>
<param name="Count">Count to associate with the event, should be more than zero</param>
<param name="Sum">Sum to associate with the event</param>
<param name="Segmentation">Segmentation object to associate with the event, can be null</param>
<returns>True if event is uploaded successfully, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordEvent(System.String,System.Int32,System.Nullable{System.Double},System.Nullable{System.Double},CountlySDK.Segmentation)">
<summary>
Records a custom event with the specified segmentation values, count and a sum
</summary>
<param name="Key">Name of the custom event, required, must not be the empty string</param>
<param name="Count">Count to associate with the event, should be more than zero</param>
<param name="Sum">Sum to associate with the event</param>
<param name="Duration">Event duration</param>
<param name="Segmentation">Segmentation object to associate with the event, can be null</param>
<returns>True if event is uploaded successfully, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordEventInternal(System.String,System.Int32,System.Nullable{System.Double},System.Nullable{System.Double},CountlySDK.Segmentation)">
<summary>
Records a custom event with the specified values
</summary>
<param name="Key">Name of the custom event, required, must not be the empty string</param>
<param name="Count">Count to associate with the event, should be more than zero</param>
<param name="Sum">Sum to associate with the event</param>
<param name="Segmentation">Segmentation object to associate with the event, can be null</param>
<returns>True if event is uploaded successfully, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.UploadEvents">
<summary>
Uploads event queue to Countly server
</summary>
<returns>True if success</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordException(System.String)">
<summary>
Records exception
</summary>
<param name="error">exception title</param>
<returns>True if exception successfully uploaded, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordException(System.String,System.String)">
<summary>
Records exception with stacktrace
</summary>
<param name="error">exception title</param>
<param name="stackTrace">exception stacktrace</param>
<returns>True if exception successfully uploaded, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordUnhandledException(System.String,System.String)">
<summary>
Records unhandled exception with stacktrace
</summary>
<param name="error">exception title</param>
<param name="stackTrace">exception stacktrace</param>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordException(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String})">
<summary>
Records exception with stacktrace and custom info
</summary>
<param name="error">exception title</param>
<param name="stackTrace">exception stacktrace</param>
<param name="customInfo">exception custom info</param>
<returns>True if exception successfully uploaded, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordException(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
<summary>
Records exception with stacktrace and custom info
</summary>
<param name="error">exception title</param>
<param name="stackTrace">exception stacktrace</param>
<param name="customInfo">exception custom info</param>
<param name="unhandled">bool indicates is exception is fatal or not</param>
<returns>True if exception successfully uploaded, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordExceptionInternal(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean)">
<summary>
Records exception with stacktrace and custom info
</summary>
<param name="error">exception title</param>
<param name="stackTrace">exception stacktrace</param>
<param name="customInfo">exception custom info</param>
<param name="unhandled">bool indicates is exception is fatal or not</param>
<returns>True if exception successfully uploaded, False - queued for delayed upload</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.UploadExceptions">
<summary>
Uploads exceptions queue to Countly server
</summary>
<returns>True if success</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.UploadUserDetails">
<summary>
Uploads user details
</summary>
<returns>true if details are successfully uploaded, false otherwise</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.OnUserDetailsChanged">
<summary>
Raised when user details property is changed
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.UploadUserPicture(System.IO.Stream)">
<summary>
Uploads user picture. Accepted picture formats are .png, .gif and .jpeg and picture will be resized to maximal 150x150 dimensions
</summary>
<param name="imageStream">Image stream</param>
<returns>true if image is successfully uploaded, false otherwise</returns>
</member>
<!-- Badly formed XML comment ignored for member "M:CountlySDK.CountlyCommon.CountlyBase.Halt" -->
<member name="M:CountlySDK.CountlyCommon.CountlyBase.HaltInternal(System.Boolean)">
<summary>
This should clear all internal state
</summary>
<param name="clearStorage"></param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.AddBreadCrumb(System.String)">
<summary>
Adds log breadcrumb
</summary>
<param name="log">log string</param>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.AddCrashBreadCrumb(System.String)">
<summary>
Adds log breadcrumb
</summary>
<param name="log">log string</param>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.SendRequestWithEmptyLocation">
<summary>
Sends a request with an empty "location" parameter.
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.OnInitComplete">
<summary>
Run session startup logic and start timer with the specified interval
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.GetDeviceIDType">
<summary>
Returns the device id type
</summary>
<returns>DeviceIdType</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.SessionBegin">
<summary>
Start tracking a session
Should be called only once
</summary>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.SessionUpdate(System.Int32)">
<summary>
Manually update session
</summary>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.SessionEnd">
<summary>
End tracking a session
</summary>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.ChangeDeviceId(System.String,System.Boolean)">
<summary>
Change this devices Id
</summary>
<param name="newDeviceId">New Id that should be used</param>
<param name="serverSideMerge">If set to true, old user id's data will be merged into new user</param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.RecordView(System.String)">
<summary>
Records view
</summary>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.reportViewDuration">
<summary>
Reports duration of last view
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.CountlyBase.BackendMode">
<summary>
Backend mode to handle multi application cases and
data migrations
</summary>
<returns>BackendMode interface to use backend mode features</returns>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.serverUrl">
<summary>
Server url
[Mandatory field]
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.appKey">
<summary>
Application key
[Mandatory field]
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.appVersion">
<summary>
Application version
[Mandatory field]
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.developerProvidedDeviceId">
<summary>
Device Id provided by the developer. If value is not null,
changes the DeviceIdMethod to 'developerSupplied' and overwrites
the previously used/saved deviceId
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.consentRequired">
<summary>
If user consent for features is required. If enabled, then features
will not work without explicitly granting permission.
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.sdkFolderName">
<summary>
Folder name that the SDK will use in isolated storage
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.givenConsent">
<summary>
Features for which consent is given or denied. These set values are not persistent
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.sessionUpdateInterval">
<summary>
After how many seconds a session update is sent
</summary>
</member>
<!-- Badly formed XML comment ignored for member "F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.MaxKeyLength" -->
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.MaxValueSize">
<summary>
Maximum size of all values in our key-value pairs
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.MaxSegmentationValues">
<summary>
Max amount of custom (dev provided) segmentation in one event
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.MaxStackTraceLinesPerThread">
<summary>
Limits how many stack trace lines would be recorded per thread
</summary>
</member>
<member name="F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.MaxStackTraceLineLength">
<summary>
Limits how many characters are allowed per stack trace line
</summary>
</member>
<!-- Badly formed XML comment ignored for member "F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.MaxBreadcrumbCount" -->
<!-- Badly formed XML comment ignored for member "F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.backendMode" -->
<!-- Badly formed XML comment ignored for member "F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.EventQueueThreshold" -->
<!-- Badly formed XML comment ignored for member "F:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.RequestQueueMaxSize" -->
<member name="M:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.DisableLocation">
<summary>
Disabled the location tracking on the Countly server
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.SetLocation(System.String,System.String,System.String,System.String)">
<summary>
Set location parameters that will be used during init.
</summary>
<param name="countryCode">ISO Country code for the user's country</param>
<param name="city">Name of the user's city</param>
<param name="gpsCoordinates">comma separate lat and long values.<example>"56.42345,123.45325"</example> </param>
<param name="ipAddress">user's IP Address</param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.EnableBackendMode">
<summary>
Enabled backend mode. When backend mode enabled other feature calls are disabled
</summary>
<returns>Config for the call chaining</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.SetMaxRequestQueueSize(System.Int32)">
<summary>
Sets maximum size of the request queue, default value is 1000
This will currently works for only backend mode
</summary>
<param name="requestQueueMaxSize">new request queue size</param>
<returns>Config for the call chaining</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.SetEventQueueSizeToSend(System.Int32)">
<summary>
Changes the maximum size of the event queue, default value is 10
This will currently works for only backend mode
</summary>
<param name="eventsQueueSize">new event queue size</param>
<returns>Config for the call chaining</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.SetBackendModeAppEQSizeToSend(System.Int32)">
<summary>
Changes the maximum size of the event queue size for an app, default value is 1000
This will only work for backend mode
</summary>
<param name="appEQSize"></param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.CountlyConfigBase.SetBackendModeServerEQSizeToSend(System.Int32)">
<summary>
Changes the maximum size of the event queue size for all of the event queues, default value is 10000
This will only work for backend mode
</summary>
<param name="serverEQSize"></param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.DeviceId.#ctor">
<summary>
Needed for JSON deserialization
</summary>
</member>
<member name="T:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase">
<summary>
Holds user-specific info in json-ready format
</summary>
</member>
<member name="E:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.UserDetailsChanged">
<summary>
raised when any of properties are changed
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.Name">
<summary>
Name
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.Username">
<summary>
Username or login info
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.Email">
<summary>
User email address
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.Organization">
<summary>
User organization
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.Phone">
<summary>
User phone
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.Picture">
<summary>
Web URL to picture
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.Gender">
<summary>
User gender
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.BirthYear">
<summary>
User birth year
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.Custom">
<summary>
User custom data
</summary>
</member>
<member name="P:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase._custom">
<summary>
Custom data ready for json serializer
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.#ctor">
<summary>
Needed for JSON deserialization
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.UploadUserPicture(System.IO.Stream)">
<summary>
Uploads user picture. Accepted picture formats are .png, .gif and .jpeg and picture will be resized to maximal 150x150 dimensions
</summary>
<param name="imageStream">Image stream</param>
<returns>true if image is successfully uploaded, false otherwise</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Entities.EntityBase.CountlyUserDetailsBase.ToString">
<summary>
Serializes object into json
</summary>
<returns>json representation string</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Helpers.RequestHelper.BuildRequest(System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Builds request by adding Base params into supplied queryParams parameters.
The data is appended in the URL.
</summary>
<param name="queryParams"></param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Helpers.RequestHelper.BuildQueryString(System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary>
Builds query string using supplied queryParams parameters.
</summary>
<param name="queryParams"></param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Helpers.StorageBase.SaveToFile``1(System.String,System.Object)">
<summary>
Saves object into file
</summary>
<typeparam name="T">Object type</typeparam>
<param name="filename">File to save to</param>
<param name="objForSave">Object to save</param>
<returns>True if success, otherwise - False</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Helpers.StorageBase.LoadFromFile``1(System.String)">
<summary>
Load object from file
</summary>
<typeparam name="T">Object type</typeparam>
<param name="filename">Filename to load from</param>
<returns>Object from file</returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Helpers.StorageBase.DeleteFile(System.String)">
<summary>
Delete file
</summary>
<param name="filename">Filename to delete</param>
</member>
<member name="M:CountlySDK.CountlyCommon.Helpers.StorageBase.GetFolderPath(System.String)">
<summary>
Required for testing
</summary>
<param name="folderName"></param>
<returns></returns>
</member>
<member name="F:CountlySDK.CountlyCommon.Helpers.StorageBase.sdkFolder">
<summary>
Retrive storage folder name
</summary>
</member>
<member name="M:CountlySDK.CountlyCommon.Server.ApiBase.Call(System.String,System.IO.Stream)">
<summary>
Platform specific task wrapper
</summary>
<param name="address"></param>
<param name="imageData"></param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Server.ApiBase.CallJob(System.String,System.IO.Stream)">
<summary>
Common job handler
</summary>
<param name="address"></param>
<param name="imageData"></param>
<returns></returns>
</member>
<member name="M:CountlySDK.CountlyCommon.Server.ApiBase.RequestAsync(System.String,System.String,System.IO.Stream)">
<summary>
Platform specific networking code
</summary>
<param name="address"></param>
<param name="requestData"></param>
<param name="imageData"></param>
<returns></returns>
</member>
<member name="T:CountlySDK.Segmentation">
<summary>
Holds an array of segmentation values
</summary>
</member>
<member name="P:CountlySDK.Segmentation.segmentation">
<summary>
Segmenation array
</summary>
</member>
<member name="M:CountlySDK.Segmentation.#ctor">
<summary>
Needed for JSON deserialization
</summary>
</member>
<member name="M:CountlySDK.Segmentation.Add(System.String,System.String)">
<summary>
Add new segmentation value
</summary>
<param name="Key">Segmenation key</param>
<param name="Value">Segmenation value</param>
</member>
<member name="T:CountlySDK.SegmentationItem">
<summary>
Holds data about segmentation value
</summary>
</member>
<member name="P:CountlySDK.SegmentationItem.Key">
<summary>
Segmentation key
</summary>
</member>
<member name="P:CountlySDK.SegmentationItem.Value">