forked from fork6ine/wartls4.0
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSentry.Protocol.xml
1538 lines (1536 loc) · 62 KB
/
Sentry.Protocol.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>Sentry.Protocol</name>
</assembly>
<members>
<member name="T:Sentry.Protocol.BaseScope">
<summary>
The Scoped part of the protocol
</summary>
<remarks>
Members are included in the event but often modified as part
of a scope manipulation which could affect multiple outgoing events.
</remarks>
</member>
<member name="P:Sentry.Protocol.BaseScope.ScopeOptions">
<summary>
An optional scope option
</summary>
<remarks>
Options are not mandatory. it allows defining callback for deciding
on adding breadcrumbs and the max breadcrumbs allowed
</remarks>
<returns>
The options or null, if no options were defined.
</returns>
</member>
<member name="P:Sentry.Protocol.BaseScope.Level">
<summary>
Sentry level
</summary>
</member>
<member name="P:Sentry.Protocol.BaseScope.Transaction">
<summary>
The name of the transaction in which there was an event.
</summary>
<remarks>
A transaction should only be defined when it can be well defined
On a Web framework, for example, a transaction is the route template
rather than the actual request path. That is so GET /user/10 and /user/20
(which have route template /user/{id}) are identified as the same transaction.
</remarks>
</member>
<member name="P:Sentry.Protocol.BaseScope.Request">
<summary>
Gets or sets the HTTP.
</summary>
<value>
The HTTP.
</value>
</member>
<member name="P:Sentry.Protocol.BaseScope.Contexts">
<summary>
Gets the structured Sentry context
</summary>
<value>
The contexts.
</value>
</member>
<member name="P:Sentry.Protocol.BaseScope.User">
<summary>
Gets the user information
</summary>
<value>
The user.
</value>
</member>
<member name="P:Sentry.Protocol.BaseScope.Environment">
<summary>
The environment name, such as 'production' or 'staging'.
</summary>
<remarks>Requires Sentry 8.0 or higher</remarks>
</member>
<member name="P:Sentry.Protocol.BaseScope.Sdk">
<summary>
SDK information
</summary>
<remarks>New in Sentry version: 8.4</remarks>
</member>
<member name="P:Sentry.Protocol.BaseScope.Fingerprint">
<summary>
A list of strings used to dictate the deduplication of this event.
</summary>
<seealso href="https://docs.sentry.io/learn/rollups/#custom-grouping"/>
<remarks>
A value of {{ default }} will be replaced with the built-in behavior, thus allowing you to extend it, or completely replace it.
New in version Protocol: version '7'
</remarks>
<example> { "fingerprint": ["myrpc", "POST", "/foo.bar"] } </example>
<example> { "fingerprint": ["{{ default }}", "http://example.com/my.url"] } </example>
</member>
<member name="P:Sentry.Protocol.BaseScope.Breadcrumbs">
<summary>
A trail of events which happened prior to an issue.
</summary>
<seealso href="https://docs.sentry.io/learn/breadcrumbs/"/>
</member>
<member name="P:Sentry.Protocol.BaseScope.Extra">
<summary>
An arbitrary mapping of additional metadata to store with the event.
</summary>
</member>
<member name="P:Sentry.Protocol.BaseScope.Tags">
<summary>
Arbitrary key-value for this event
</summary>
</member>
<member name="M:Sentry.Protocol.BaseScope.#ctor(Sentry.Protocol.IScopeOptions)">
<summary>
Creates a scope with the specified options
</summary>
</member>
<member name="T:Sentry.Protocol.Breadcrumb">
<summary>
Series of application events
</summary>
</member>
<member name="P:Sentry.Protocol.Breadcrumb.SerializableTimestamp">
<summary>
A timestamp representing when the breadcrumb occurred.
</summary>
<remarks>
This can be either an ISO datetime string, or a Unix timestamp.
</remarks>
</member>
<member name="P:Sentry.Protocol.Breadcrumb.Message">
<summary>
If a message is provided, it’s rendered as text and the whitespace is preserved.
Very long text might be abbreviated in the UI.
</summary>
</member>
<member name="P:Sentry.Protocol.Breadcrumb.Type">
<summary>
The type of breadcrumb.
</summary>
<remarks>
The default type is default which indicates no specific handling.
Other types are currently http for HTTP requests and navigation for navigation events.
</remarks>
</member>
<member name="P:Sentry.Protocol.Breadcrumb.Data">
<summary>
Data associated with this breadcrumb.
</summary>
<remarks>
Contains a sub-object whose contents depend on the breadcrumb type.
Additional parameters that are unsupported by the type are rendered as a key/value table.
</remarks>
</member>
<member name="P:Sentry.Protocol.Breadcrumb.Category">
<summary>
Dotted strings that indicate what the crumb is or where it comes from.
</summary>
<remarks>
Typically it’s a module name or a descriptive string.
For instance aspnet.mvc.filter could be used to indicate that it came from an Action Filter.
</remarks>
</member>
<member name="P:Sentry.Protocol.Breadcrumb.Level">
<summary>
The level of the event.
</summary>
<remarks>
Levels are used in the UI to emphasize and deemphasize the crumb.
</remarks>
</member>
<member name="M:Sentry.Protocol.Breadcrumb.#ctor(System.String,System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.String,Sentry.Protocol.BreadcrumbLevel)">
<summary>
Initializes a new instance of the <see cref="T:Sentry.Protocol.Breadcrumb"/> class.
</summary>
<param name="message">The message.</param>
<param name="type">The type.</param>
<param name="data">The data.</param>
<param name="category">The category.</param>
<param name="level">The level.</param>
</member>
<member name="M:Sentry.Protocol.Breadcrumb.#ctor(System.Nullable{System.DateTimeOffset},System.String,System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.String,Sentry.Protocol.BreadcrumbLevel)">
</member>
<member name="T:Sentry.Protocol.BreadcrumbLevel">
<summary>
The level of the Breadcrumb
</summary>
</member>
<member name="F:Sentry.Protocol.BreadcrumbLevel.Debug">
<summary>
Debug level
</summary>
</member>
<member name="F:Sentry.Protocol.BreadcrumbLevel.Info">
<summary>
Information level
</summary>
<remarks>
This is value 0, hence, default
</remarks>
</member>
<member name="F:Sentry.Protocol.BreadcrumbLevel.Warning">
<summary>
Warning breadcrumb level
</summary>
</member>
<member name="F:Sentry.Protocol.BreadcrumbLevel.Error">
<summary>
Error breadcrumb level
</summary>
</member>
<member name="F:Sentry.Protocol.BreadcrumbLevel.Critical">
<summary>
Critical breadcrumb level
</summary>
</member>
<member name="F:Sentry.Protocol.Constants.Platform">
<summary>
Platform key that defines an events is coming from any .NET implementation
</summary>
</member>
<member name="T:Sentry.Protocol.App">
<summary>
Describes the application.
</summary>
<remarks>
As opposed to the runtime, this is the actual application that
was running and carries meta data about the current session.
</remarks>
<seealso href="https://docs.sentry.io/clientdev/interfaces/contexts/"/>
</member>
<member name="F:Sentry.Protocol.App.Type">
<summary>
Tells Sentry which type of context this is.
</summary>
</member>
<member name="P:Sentry.Protocol.App.Identifier">
<summary>
Version-independent application identifier, often a dotted bundle ID.
</summary>
</member>
<member name="P:Sentry.Protocol.App.StartTime">
<summary>
Formatted UTC timestamp when the application was started by the user.
</summary>
</member>
<member name="P:Sentry.Protocol.App.Hash">
<summary>
Application specific device identifier.
</summary>
</member>
<member name="P:Sentry.Protocol.App.BuildType">
<summary>
String identifying the kind of build, e.g. testflight.
</summary>
</member>
<member name="P:Sentry.Protocol.App.Name">
<summary>
Human readable application name, as it appears on the platform.
</summary>
</member>
<member name="P:Sentry.Protocol.App.Version">
<summary>
Human readable application version, as it appears on the platform.
</summary>
</member>
<member name="P:Sentry.Protocol.App.Build">
<summary>
Internal build identifier, as it appears on the platform.
</summary>
</member>
<member name="M:Sentry.Protocol.App.Clone">
<summary>
Clones this instance
</summary>
<returns></returns>
</member>
<member name="T:Sentry.Protocol.Browser">
<summary>
Carries information about the browser or user agent for web-related errors.
This can either be the browser this event ocurred in, or the user agent of a
web request that triggered the event.
</summary>
<seealso href="https://docs.sentry.io/clientdev/interfaces/contexts/"/>
</member>
<member name="F:Sentry.Protocol.Browser.Type">
<summary>
Tells Sentry which type of context this is.
</summary>
</member>
<member name="P:Sentry.Protocol.Browser.Name">
<summary>
Display name of the browser application.
</summary>
</member>
<member name="P:Sentry.Protocol.Browser.Version">
<summary>
Version string of the browser.
</summary>
</member>
<member name="M:Sentry.Protocol.Browser.Clone">
<summary>
Clones this instance
</summary>
<returns></returns>
</member>
<member name="T:Sentry.Protocol.Contexts">
<summary>
Represents Sentry's structured Context
</summary>
<inheritdoc />
<seealso href="https://docs.sentry.io/clientdev/interfaces/contexts/" />
</member>
<member name="P:Sentry.Protocol.Contexts.App">
<summary>
Describes the application.
</summary>
</member>
<member name="P:Sentry.Protocol.Contexts.Browser">
<summary>
Describes the browser.
</summary>
</member>
<member name="P:Sentry.Protocol.Contexts.Device">
<summary>
Describes the device.
</summary>
</member>
<member name="P:Sentry.Protocol.Contexts.OperatingSystem">
<summary>
Defines the operating system.
</summary>
<remarks>
In web contexts, this is the operating system of the browser (normally pulled from the User-Agent string).
</remarks>
</member>
<member name="P:Sentry.Protocol.Contexts.Runtime">
<summary>
This describes a runtime in more detail.
</summary>
</member>
<member name="M:Sentry.Protocol.Contexts.Clone">
<summary>
Creates a deep clone of this context
</summary>
<returns></returns>
</member>
<member name="M:Sentry.Protocol.Contexts.CopyTo(Sentry.Protocol.Contexts)">
<summary>
Copies the items of the context while cloning the known types
</summary>
<param name="to">To.</param>
</member>
<member name="T:Sentry.Protocol.Device">
<summary>
Describes the device that caused the event. This is most appropriate for mobile applications.
</summary>
<seealso href="https://docs.sentry.io/clientdev/interfaces/contexts/"/>
</member>
<member name="F:Sentry.Protocol.Device.Type">
<summary>
Tells Sentry which type of context this is.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.Name">
<summary>
The name of the device. This is typically a hostname.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.Family">
<summary>
The family of the device.
</summary>
<remarks>
This is normally the common part of model names across generations.
</remarks>
<example>
iPhone, Samsung Galaxy
</example>
</member>
<member name="P:Sentry.Protocol.Device.Model">
<summary>
The model name.
</summary>
<example>
Samsung Galaxy S3
</example>
</member>
<member name="P:Sentry.Protocol.Device.ModelId">
<summary>
An internal hardware revision to identify the device exactly.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.Architecture">
<summary>
The CPU architecture.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.BatteryLevel">
<summary>
If the device has a battery an integer defining the battery level (in the range 0-100).
</summary>
</member>
<member name="P:Sentry.Protocol.Device.Orientation">
<summary>
This can be a string portrait or landscape to define the orientation of a device.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.Simulator">
<summary>
A boolean defining whether this device is a simulator or an actual device.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.MemorySize">
<summary>
Total system memory available in bytes.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.FreeMemory">
<summary>
Free system memory in bytes.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.UsableMemory">
<summary>
Memory usable for the app in bytes.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.StorageSize">
<summary>
Total device storage in bytes.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.FreeStorage">
<summary>
Free device storage in bytes.
</summary>
</member>
<member name="P:Sentry.Protocol.Device.ExternalStorageSize">
<summary>
Total size of an attached external storage in bytes (e.g.: android SDK card).
</summary>
</member>
<member name="P:Sentry.Protocol.Device.ExternalFreeStorage">
<summary>
Free size of an attached external storage in bytes (e.g.: android SDK card).
</summary>
</member>
<member name="P:Sentry.Protocol.Device.BootTime">
<summary>
A formatted UTC timestamp when the system was booted.
</summary>
<example>
018-02-08T12:52:12Z
</example>
</member>
<member name="P:Sentry.Protocol.Device.Timezone">
<summary>
The timezone of the device.
</summary>
<example>
Europe/Vienna
</example>
</member>
<member name="M:Sentry.Protocol.Device.Clone">
<summary>
Clones this instance
</summary>
<returns></returns>
</member>
<member name="T:Sentry.Protocol.DeviceOrientation">
<summary>
Defines the orientation of a device.
</summary>
</member>
<member name="F:Sentry.Protocol.DeviceOrientation.Portrait">
<summary>
Portrait
</summary>
</member>
<member name="F:Sentry.Protocol.DeviceOrientation.Landscape">
<summary>
Landscape
</summary>
</member>
<member name="T:Sentry.Protocol.Gpu">
<summary>
Graphics device unit
</summary>
<seealso href="https://docs.sentry.io/development/sdk-dev/interfaces/gpu/"/>
</member>
<member name="F:Sentry.Protocol.Gpu.Type">
<summary>
Tells Sentry which type of context this is.
</summary>
</member>
<member name="P:Sentry.Protocol.Gpu.Name">
<summary>
The name of the graphics device
</summary>
<example>
iPod touch: Apple A8 GPU
Samsung S7: Mali-T880
</example>
</member>
<member name="P:Sentry.Protocol.Gpu.Id">
<summary>
The PCI Id of the graphics device
</summary>
<remarks>
Combined with <see cref="P:Sentry.Protocol.Gpu.VendorId"/> uniquely identifies the GPU
</remarks>
</member>
<member name="P:Sentry.Protocol.Gpu.VendorId">
<summary>
The PCI vendor Id of the graphics device
</summary>
<remarks>
Combined with <see cref="P:Sentry.Protocol.Gpu.Id"/> uniquely identifies the GPU
</remarks>
<seealso href="https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifiers-for-pci-devices"/>
<seealso href="http://pci-ids.ucw.cz/read/PC/"/>
</member>
<member name="P:Sentry.Protocol.Gpu.VendorName">
<summary>
The vendor name reported by the graphic device
</summary>
<example>
Apple, ARM, WebKit
</example>
</member>
<member name="P:Sentry.Protocol.Gpu.MemorySize">
<summary>
Total GPU memory available in mega-bytes.
</summary>
</member>
<member name="P:Sentry.Protocol.Gpu.ApiType">
<summary>
Device type
</summary>
<remarks>The low level API used</remarks>
<example>Metal, Direct3D11, OpenGLES3, PlayStation4, XboxOne</example>
</member>
<member name="P:Sentry.Protocol.Gpu.MultiThreadedRendering">
<summary>
Whether the GPU is multi-threaded rendering or not.
</summary>
</member>
<member name="P:Sentry.Protocol.Gpu.Version">
<summary>
The Version of the API of the graphics device
</summary>
<example>
iPod touch: Metal
Android: OpenGL ES 3.2 v1.r22p0-01rel0.f294e54ceb2cb2d81039204fa4b0402e
WebGL Windows: OpenGL ES 3.0 (WebGL 2.0 (OpenGL ES 3.0 Chromium))
OpenGL 2.0, Direct3D 9.0c
</example>
</member>
<member name="P:Sentry.Protocol.Gpu.NpotSupport">
<summary>
The Non-Power-Of-Two support level
</summary>
<example>
Full
</example>
</member>
<member name="M:Sentry.Protocol.Gpu.Clone">
<summary>
Clones this instance
</summary>
<returns></returns>
</member>
<member name="T:Sentry.Protocol.OperatingSystem">
<summary>
Represents Sentry's context for OS
</summary>
<remarks>
Defines the operating system that caused the event. In web contexts, this is the operating system of the browser (normally pulled from the User-Agent string).
</remarks>
<seealso href="https://docs.sentry.io/clientdev/interfaces/contexts/#context-types"/>
</member>
<member name="F:Sentry.Protocol.OperatingSystem.Type">
<summary>
Tells Sentry which type of context this is.
</summary>
</member>
<member name="P:Sentry.Protocol.OperatingSystem.Name">
<summary>
The name of the operating system.
</summary>
</member>
<member name="P:Sentry.Protocol.OperatingSystem.Version">
<summary>
The version of the operating system.
</summary>
</member>
<member name="P:Sentry.Protocol.OperatingSystem.RawDescription">
<summary>
An optional raw description that Sentry can use in an attempt to normalize OS info.
</summary>
<remarks>
When the system doesn't expose a clear API for <see cref="P:Sentry.Protocol.OperatingSystem.Name"/> and <see cref="P:Sentry.Protocol.OperatingSystem.Version"/>
this field can be used to provide a raw system info (e.g: uname)
</remarks>
</member>
<member name="P:Sentry.Protocol.OperatingSystem.Build">
<summary>
The internal build revision of the operating system.
</summary>
</member>
<member name="P:Sentry.Protocol.OperatingSystem.KernelVersion">
<summary>
If known, this can be an independent kernel version string. Typically
this is something like the entire output of the 'uname' tool.
</summary>
</member>
<member name="P:Sentry.Protocol.OperatingSystem.Rooted">
<summary>
An optional boolean that defines if the OS has been jailbroken or rooted.
</summary>
</member>
<member name="M:Sentry.Protocol.OperatingSystem.Clone">
<summary>
Clones this instance
</summary>
<returns></returns>
</member>
<member name="T:Sentry.Protocol.Runtime">
<summary>
This describes a runtime in more detail.
</summary>
<remarks>
Typically this context is used multiple times if multiple runtimes are involved (for instance if you have a JavaScript application running on top of JVM)
</remarks>
<seealso href="https://docs.sentry.io/clientdev/interfaces/contexts/"/>
</member>
<member name="F:Sentry.Protocol.Runtime.Type">
<summary>
Tells Sentry which type of context this is.
</summary>
</member>
<member name="P:Sentry.Protocol.Runtime.Name">
<summary>
The name of the runtime.
</summary>
</member>
<member name="P:Sentry.Protocol.Runtime.Version">
<summary>
The version identifier of the runtime.
</summary>
</member>
<member name="P:Sentry.Protocol.Runtime.RawDescription">
<summary>
An optional raw description that Sentry can use in an attempt to normalize Runtime info.
</summary>
<remarks>
When the system doesn't expose a clear API for <see cref="P:Sentry.Protocol.Runtime.Name"/> and <see cref="P:Sentry.Protocol.Runtime.Version"/>
this field can be used to provide a raw system info (e.g: .NET Framework 4.7.1)
</remarks>
</member>
<member name="P:Sentry.Protocol.Runtime.Build">
<summary>
An optional build number
</summary>
<see href="https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed"/>
</member>
<member name="M:Sentry.Protocol.Runtime.Clone">
<summary>
Clones this instance
</summary>
<returns></returns>
</member>
<member name="T:Sentry.Protocol.Mechanism">
<summary>
Sentry Exception Mechanism
</summary>
<remarks>
The exception mechanism is an optional field residing in the Exception Interface.
It carries additional information about the way the exception was created on the target system.
This includes general exception values obtained from operating system or runtime APIs, as well as mechanism-specific values.
</remarks>
<see href="https://docs.sentry.io/clientdev/interfaces/mechanism/"/>
</member>
<member name="P:Sentry.Protocol.Mechanism.Type">
<summary>
Required unique identifier of this mechanism determining rendering and processing of the mechanism data
</summary>
<remarks>
The type attribute is required to send any exception mechanism attribute,
even if the SDK cannot determine the specific mechanism.
In this case, set the type to "generic". See below for an example.
</remarks>
</member>
<member name="P:Sentry.Protocol.Mechanism.Description">
<summary>
Optional human readable description of the error mechanism and a possible hint on how to solve this error
</summary>
</member>
<member name="P:Sentry.Protocol.Mechanism.HelpLink">
<summary>
Optional fully qualified URL to an online help resource, possible interpolated with error parameters
</summary>
</member>
<member name="P:Sentry.Protocol.Mechanism.Handled">
<summary>
Optional flag indicating whether the exception has been handled by the user (e.g. via try..catch)
</summary>
</member>
<member name="P:Sentry.Protocol.Mechanism.Meta">
<summary>
Optional information from the operating system or runtime on the exception mechanism
</summary>
<remarks>
The mechanism meta data usually carries error codes reported by the runtime or operating system,
along with a platform dependent interpretation of these codes.
SDKs can safely omit code names and descriptions for well known error codes, as it will be filled out by Sentry.
For proprietary or vendor-specific error codes, adding these values will give additional information to the user.
</remarks>
<see href="https://docs.sentry.io/clientdev/interfaces/mechanism/#meta-information"/>
</member>
<member name="P:Sentry.Protocol.Mechanism.Data">
<summary>
Arbitrary extra data that might help the user understand the error thrown by this mechanism
</summary>
</member>
<member name="T:Sentry.Protocol.SentryException">
<summary>
Sentry Exception interface
</summary>
<see href="https://docs.sentry.io/clientdev/interfaces/exception/"/>
</member>
<member name="P:Sentry.Protocol.SentryException.Type">
<summary>
Exception Type
</summary>
</member>
<member name="P:Sentry.Protocol.SentryException.Value">
<summary>
The exception value
</summary>
</member>
<member name="P:Sentry.Protocol.SentryException.Module">
<summary>
The optional module, or package which the exception type lives in
</summary>
</member>
<member name="P:Sentry.Protocol.SentryException.ThreadId">
<summary>
An optional value which refers to a thread in the threads interface.
</summary>
<seealso href="https://docs.sentry.io/clientdev/interfaces/threads/"/>
<seealso cref="T:Sentry.Protocol.SentryThread"/>
</member>
<member name="P:Sentry.Protocol.SentryException.Stacktrace">
<summary>
Stack trace
</summary>
<see href="https://docs.sentry.io/clientdev/interfaces/stacktrace/"/>
</member>
<member name="P:Sentry.Protocol.SentryException.Mechanism">
<summary>
An optional mechanism that created this exception.
</summary>
<see href="https://docs.sentry.io/clientdev/interfaces/mechanism/"/>
</member>
<member name="P:Sentry.Protocol.SentryException.Data">
<summary>
Arbitrary extra data that related to this error
</summary>
<remarks>
The protocol does not yet support data at this level.
For this reason this property is not serialized.
The data is moved to the event level on Extra until such support is added
</remarks>
</member>
<member name="T:Sentry.Protocol.SentryStackFrame">
<summary>
A frame of a stacktrace
</summary>
<see href="https://docs.sentry.io/clientdev/interfaces/stacktrace/"/>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.FileName">
<summary>
The relative file path to the call
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.Function">
<summary>
The name of the function being called
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.Module">
<summary>
Platform-specific module path
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.LineNumber">
<summary>
The line number of the call
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.ColumnNumber">
<summary>
The column number of the call
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.AbsolutePath">
<summary>
The absolute path to filename
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.ContextLine">
<summary>
Source code in filename at line number
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.PreContext">
<summary>
A list of source code lines before context_line (in order) – usually [lineno - 5:lineno]
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.PostContext">
<summary>
A list of source code lines after context_line (in order) – usually [lineno + 1:lineno + 5]
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.InApp">
<summary>
Signifies whether this frame is related to the execution of the relevant code in this stacktrace.
</summary>
<example>
For example, the frames that might power the framework’s web server of your app are probably not relevant,
however calls to the framework’s library once you start handling code likely are.
</example>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.Vars">
<summary>
A mapping of variables which were available within this frame (usually context-locals).
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.FramesOmitted">
<summary>
Which frames were omitted, if any.
</summary>
<remarks>
If the list of frames is large, you can explicitly tell the system that you’ve omitted a range of frames.
The frames_omitted must be a single tuple two values: start and end.
</remarks>
<example>
If you only removed the 8th frame, the value would be (8, 9), meaning it started at the 8th frame,
and went until the 9th (the number of frames omitted is end-start).
The values should be based on a one-index.
</example>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.Package">
<summary>
The assembly where the code resides
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.Platform">
<summary>
This can override the platform for a single frame. Otherwise the platform of the event is assumed.
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.ImageAddress">
<summary>
Optionally an address of the debug image to reference.
If this is set and a known image is defined by debug_meta then symbolication can take place.
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.SymbolAddress">
<summary>
An optional address that points to a symbol.
We actually use the instruction address for symbolication but this can be used to calculate an instruction offset automatically.
</summary>
</member>
<member name="P:Sentry.Protocol.SentryStackFrame.InstructionOffset">
<summary>
The instruction offset
</summary>
<remarks>
The official docs refer to it as 'The difference between instruction address and symbol address in bytes.'
In .NET this means the IL Offset within the assembly
</remarks>
</member>
<member name="T:Sentry.Protocol.SentryStackTrace">
<summary>
Sentry Stacktrace interface
</summary>
<remarks>
A stacktrace contains a list of frames, each with various bits (most optional) describing the context of that frame. Frames should be sorted from oldest to newest.
</remarks>
<see href="https://docs.sentry.io/clientdev/interfaces/stacktrace/"/>
</member>
<member name="P:Sentry.Protocol.SentryStackTrace.Frames">
<summary>
The list of frames in the stack
</summary>
<remarks>
The list of frames should be ordered by the oldest call first.
</remarks>
</member>
<member name="T:Sentry.Protocol.IScopeOptions">
<summary>
Options used by <see cref="T:Sentry.Protocol.BaseScope"/>
</summary>
</member>
<member name="P:Sentry.Protocol.IScopeOptions.MaxBreadcrumbs">
<summary>
Gets or sets the maximum breadcrumbs.
</summary>
<remarks>
When the number of events reach this configuration value,
older breadcrumbs start dropping to make room for new ones.
</remarks>
<value>
The maximum breadcrumbs per scope.
</value>
</member>
<member name="P:Sentry.Protocol.IScopeOptions.BeforeBreadcrumb">
<summary>
Invoked before storing a new breadcrumb
</summary>
<remarks>
Allows the callback handler access to a breadcrumb and allows modification
or totally dropping the breadcrumb by returning null.
</remarks>
</member>
<member name="T:Sentry.Protocol.LogEntry">
<summary>
Sentry Message interface
</summary>
<remarks>
This interface enables support to structured logging.
</remarks>
<example>
"sentry.interfaces.Message": {
"message": "Message for event: {eventId}",
"params": [10]
}
</example>
<seealso href="https://docs.sentry.io/clientdev/interfaces/message/"/>
</member>
<member name="P:Sentry.Protocol.LogEntry.Message">
<summary>
The raw message string (uninterpolated)
</summary>
<remarks>
Must be no more than 1000 characters in length.
</remarks>
</member>
<member name="P:Sentry.Protocol.LogEntry.Params">
<summary>
The optional list of formatting parameters
</summary>
</member>
<member name="P:Sentry.Protocol.LogEntry.Formatted">
<summary>
The formatted message
</summary>
</member>
<member name="T:Sentry.Protocol.Package">
<summary>
Represents a package used to compose the SDK
</summary>
</member>
<member name="P:Sentry.Protocol.Package.Name">
<summary>
The name of the package
</summary>
<example>
nuget:Sentry
nuget:Sentry.AspNetCore
</example>
</member>
<member name="P:Sentry.Protocol.Package.Version">
<summary>
The version of the package
</summary>
<example>
1.0.0-rc1
</example>
</member>
<member name="M:Sentry.Protocol.Package.#ctor(System.String,System.String)">
<summary>
Creates a new instance of a <see cref="T:Sentry.Protocol.Package"/>
</summary>
<param name="name">The package name.</param>
<param name="version">The package version.</param>
</member>
<member name="T:Sentry.Protocol.Request">
<summary>
Sentry HTTP interface
</summary>
<example>
"request": {
"url": "http://absolute.uri/foo",
"method": "POST",
"data": {
"foo": "bar"
},
"query_string": "hello=world",
"cookies": "foo=bar",