bin/PSFramework.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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>PSFramework</name>
    </assembly>
    <members>
        <member name="T:PSFramework.Commands.RemovePSFNullCommand">
            <summary>
            Implements the Remove-PSFNull command
            </summary>
        </member>
        <member name="F:PSFramework.Commands.RemovePSFNullCommand.InputObject">
            <summary>
            The objects to process
            </summary>
        </member>
        <member name="F:PSFramework.Commands.RemovePSFNullCommand.AllowEmptyCollections">
            <summary>
            Whether empty collections should be passed along
            </summary>
        </member>
        <member name="F:PSFramework.Commands.RemovePSFNullCommand.AllowEmptyStrings">
            <summary>
            Whether empty strings should be legal
            </summary>
        </member>
        <member name="F:PSFramework.Commands.RemovePSFNullCommand.Enumerate">
            <summary>
            Whether the output should be enumerated
            </summary>
        </member>
        <member name="M:PSFramework.Commands.RemovePSFNullCommand.ProcessRecord">
            <summary>
            Process items as they are passed to the cmdlet
            </summary>
        </member>
        <member name="T:PSFramework.Commands.SetPSFConfigCommand">
            <summary>
            Implements the Set-PSFConfig command
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.FullName">
            <summary>
            The full name of the setting
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.Module">
            <summary>
            The name of the module the setting belongs to.
            Is optional due to just specifying a name is legal, in which case the first name segment becomes the module name.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.Name">
            <summary>
            The name of the setting within a module.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.Value">
            <summary>
            The value to apply.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.PersistedValue">
            <summary>
            The persisted value to apply.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.PersistedType">
            <summary>
            The persisted type to apply.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.Description">
            <summary>
            Add documentation to the setting.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.Validation">
            <summary>
            The validation script to use.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.Handler">
            <summary>
            The handling script to apply when changing the value.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.Hidden">
            <summary>
            Whether the setting should be hidden from casual discovery.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.Default">
            <summary>
            Whether the setting should be applied only when nothing exists yet.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.Initialize">
            <summary>
            Whether this is the configuration initialization call.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.SimpleExport">
            <summary>
            Enabling this will cause the module to use friendly json notation on export to file.
            This may result in loss of data precision, but is more userfriendly.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.ModuleExport">
            <summary>
            Whether this setting applies to module scope file export.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.DisableValidation">
            <summary>
            Do not apply the validation script when changing values.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.DisableHandler">
            <summary>
            Do not run the handler script when changing values.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.PassThru">
            <summary>
            Return the changed configuration setting.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand.EnableException">
            <summary>
            Enable throwing exceptions.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._Config">
            <summary>
            The configuration item changed
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._KillIt">
            <summary>
            Whether execution should be terminated silently.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._Initialize">
            <summary>
            Whether this is an initialization execution.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._Persisted">
            <summary>
            Whether persisted values need to be restored.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._Exists">
            <summary>
            Whether the setting already exists.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._PolicyEnforced">
            <summary>
            The setting to be affected was enforced by policy and cannot be changed by the user.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._NameModule">
            <summary>
            Processed name of module.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._NameName">
            <summary>
            Processed name of setting within module.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._NameFull">
            <summary>
            Processed full name of setting.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.SetPSFConfigCommand._ValidationErrorMessage">
            <summary>
            The reason validation failed.
            Filled by ApplyValue.
            </summary>
        </member>
        <member name="M:PSFramework.Commands.SetPSFConfigCommand.BeginProcessing">
            <summary>
            Implements the begin action of Set-PSFConfig
            </summary>
        </member>
        <member name="M:PSFramework.Commands.SetPSFConfigCommand.ProcessRecord">
            <summary>
            Implements the process action of Set-PSFConfig
            </summary>
        </member>
        <member name="M:PSFramework.Commands.SetPSFConfigCommand.ApplyValue(System.Object)">
            <summary>
            Applies a value to a configuration item, invoking validation and handler scriptblocks.
            </summary>
            <param name="Value">The value to apply</param>
        </member>
        <member name="M:PSFramework.Commands.SetPSFConfigCommand.ApplyCommonSettings">
            <summary>
            Abstracts out 
            </summary>
        </member>
        <member name="T:PSFramework.Commands.TestPSFShouldProcessCommand">
            <summary>
            Implements the Test-PSFShouldProcess command
            </summary>
        </member>
        <member name="F:PSFramework.Commands.TestPSFShouldProcessCommand.PSCmdlet">
            <summary>
            The PSCmdlet object of the calling command
            </summary>
        </member>
        <member name="F:PSFramework.Commands.TestPSFShouldProcessCommand.Target">
            <summary>
            The target object to process
            </summary>
        </member>
        <member name="F:PSFramework.Commands.TestPSFShouldProcessCommand.Action">
            <summary>
            Description of the action to perform
            </summary>
        </member>
        <member name="M:PSFramework.Commands.TestPSFShouldProcessCommand.ProcessRecord">
            <summary>
            Perform the query
            </summary>
        </member>
        <member name="T:PSFramework.Commands.WritePSFMessageCommand">
            <summary>
            Cmdlet performing message handling and logging
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.Level">
            <summary>
            This parameter represents the verbosity of the message. The lower the number, the more important it is for a human user to read the message.
            By default, the levels are distributed like this:
            - 1-3 Direct verbose output to the user (using Write-Host)
            - 4-6 Output only visible when requesting extra verbosity (using Write-Verbose)
            - 1-9 Debugging information, written using Write-Debug
            
            In addition, it is possible to select the level "Warning" which moves the message out of the configurable range:
            The user will always be shown this message, unless he silences the entire verbosity.
            
            Possible levels:
            Critical (1), Important / Output / Host (2), Significant (3), VeryVerbose (4), Verbose (5), SomewhatVerbose (6), System (7), Debug (8), InternalComment (9), Warning (666)
            Either one of the strings or its respective number will do as input.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.Message">
            <summary>
            The message to write/log. The function name and timestamp will automatically be prepended.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.Tag">
            <summary>
            Tags to add to the message written.
            This allows filtering and grouping by category of message, targeting specific messages.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.FunctionName">
            <summary>
            The name of the calling function.
            Will be automatically set, but can be overridden when necessary.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.ModuleName">
            <summary>
            The name of the module, the calling function is part of.
            Will be automatically set, but can be overridden when necessary.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.File">
            <summary>
            The file in which Write-PSFMessage was called.
            Will be automatically set, but can be overridden when necessary.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.Line">
            <summary>
            The line on which Write-PSFMessage was called.
            Will be automatically set, but can be overridden when necessary.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.ErrorRecord">
            <summary>
            If an error record should be noted with the message, add the full record here.
            Especially designed for use with Warning-mode, it can legally be used in either mode.
            The error will be added to the $Error variable and enqued in the logging/debugging system.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.Exception">
            <summary>
            Allows specifying an inner exception as input object. This will be passed on to the logging and used for messages.
            When specifying both ErrorRecord AND Exception, Exception wins, but ErrorRecord is still used for record metadata.
            </summary>
        </member>
        <member name="F:PSFramework.Commands.WritePSFMessageCommand.Once">
            <summary>
            Setting this parameter will cause this function to write the message only once per session.
            The string passed here and the calling function's name are used to create a unique ID, which is then used to register the action in the configuration system. Thus will the lockout only be written if called once and not burden the system unduly. This lockout will be written as a hidden value, to see it use Get-PSFConfig -Force. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.OverrideExceptionMessage"> <summary> Disables automatic appending of exception messages. Use in cases where you already have a speaking message interpretation and do not need the original message. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Target"> <summary> Add the object the message is all about, in order to simplify debugging / troubleshooting. For example, when calling this from a function targeting a remote computer, the computername could be specified here, allowing all messages to easily be correlated to the object processed. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.EnableException"> <summary> This parameters disables user-friendly warnings and enables the throwing of exceptions. This is less user friendly, but allows catching exceptions in calling scripts. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand.Breakpoint"> <summary> Enables breakpoints on the current message. By default, setting '-Debug' will NOT cause an interrupt on the current position. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._timestamp"> <summary> The start time of the cmdlet </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._silent"> <summary> Whether this cmdlet is run in silent mode </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._fromStopFunction"> <summary> Whether this cmdlet was called by Stop-PSFFunction </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._callStack"> <summary> The current callstack </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._stackDepth"> <summary> How many items exist on the callstack </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._message"> <summary> The message to write </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._messageSimple"> <summary> The message simplified without timestamps. Used for logging. </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._messageColor"> <summary> The message to write in color </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._messageDeveloper"> <summary> Non-colored version of developermode </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._messageDeveloperColor"> <summary> Colored version of developermode </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._writeHostScript"> <summary> Scriptblock that writes the host messages </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._Tags"> <summary> List of tags to process </summary> </member> <member name="F:PSFramework.Commands.WritePSFMessageCommand._isDebug"> <summary> Whether debug mode is enabled </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._errorQualifiedMessage"> <summary> The input message with the error content included if desired </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._MessageSystem"> <summary> The final message to use for internal logging </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._MessageStreams"> <summary> The final message to use for writing to streams, such as verbose or warning </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._MessageHost"> <summary> The final message to use for host messages (write using Write-PSFHostColor) </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._BreadCrumbsString"> <summary> Provide breadcrumb queue of the callstack </summary> </member> <member name="P:PSFramework.Commands.WritePSFMessageCommand._BreadCrumbsStringColored"> <summary> Provide a breadcrumb queue of the callstack in color tags </summary> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.BeginProcessing"> <summary> Processes the begin phase of the cmdlet </summary> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.ProcessRecord"> <summary> Processes the process phase of the cmdlet </summary> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.ResolveTarget(System.Object)"> <summary> Processes the target transform rules on an input object </summary> <param name="Item">The item to transform</param> <returns>The transformed object</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.ResolveException(System.Exception)"> <summary> Processes the specified exception specified </summary> <param name="Item">The exception to process</param> <returns>The transformed exception</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.ResolveLevel(PSFramework.Message.MessageLevel)"> <summary> Processs the input level and apply policy and rules </summary> <param name="Level">The original level of the message</param> <returns>The processed level</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessage"> <summary> Builds the message item for display of Verbose, Warning and Debug streams </summary> <returns>The message to return</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessageSimple"> <summary> Builds the base message for internal system use. </summary> <returns>The message to return</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessageColor"> <summary> Builds the message item if needed and returns it </summary> <returns>The message to return</returns> </member> <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessageDeveloper"> <summary> Non-host output in developermode </summary> <returns>The string to write on messages that don't go straight to Write-PSFHostColor</returns>
        </member>
        <member name="M:PSFramework.Commands.WritePSFMessageCommand.GetMessageDeveloperColor">
            <summary>
            Host output in developermode
            </summary>
            <returns>The string to write on messages that go straight to Write-PSFHostColor</returns>
        </member>
        <member name="T:PSFramework.ComputerManagement.ComputerManagementHost">
            <summary>
            Host class containing static iresources for the computer management component
            </summary>
        </member>
        <member name="F:PSFramework.ComputerManagement.ComputerManagementHost.PSSessionIdleTimeout">
            <summary>
            The timespan a PSSession may be idle before it is cleared for cleanup
            </summary>
        </member>
        <member name="T:PSFramework.ComputerManagement.PSSessionContainer">
            <summary>
            A class designed to contain PSSessionInfo objects
            </summary>
        </member>
        <member name="M:PSFramework.ComputerManagement.PSSessionContainer.#ctor">
            <summary>
            Creeates a session container dictionary, that is not opinionated about casing.
            </summary>
        </member>
        <member name="M:PSFramework.ComputerManagement.PSSessionContainer.GetExpired">
            <summary>
            Returns a list of all expired sessions
            </summary>
            <returns>The list of expired sessions</returns>
        </member>
        <member name="M:PSFramework.ComputerManagement.PSSessionContainer.GetBroken">
            <summary>
            Returns a list of all sessions that have broken (generally by having hit the hard wsman limits or the remote computer being down)
            </summary>
            <returns>The list of broken sessions.</returns>
        </member>
        <member name="T:PSFramework.ComputerManagement.PSSessionInfo">
            <summary>
            Runtime information object on a PSSession connection. Used to implement session caching and disconnection.
            </summary>
        </member>
        <member name="F:PSFramework.ComputerManagement.PSSessionInfo.Session">
            <summary>
            The session object to inform upon
            </summary>
        </member>
        <member name="F:PSFramework.ComputerManagement.PSSessionInfo.LastUsed">
            <summary>
            The time this session object was last used
            </summary>
        </member>
        <member name="P:PSFramework.ComputerManagement.PSSessionInfo.IsExpired">
            <summary>
            Shows whether the session has expired
            </summary>
        </member>
        <member name="P:PSFramework.ComputerManagement.PSSessionInfo.ComputerName">
            <summary>
            Name of the remote session
            </summary>
        </member>
        <member name="P:PSFramework.ComputerManagement.PSSessionInfo.Availability">
            <summary>
            The current state of the session
            </summary>
        </member>
        <member name="M:PSFramework.ComputerManagement.PSSessionInfo.ResetTimestamp">
            <summary>
            Resets the LastUsed timestamp, ensuring this session is not discarded prematurely.
            </summary>
        </member>
        <member name="M:PSFramework.ComputerManagement.PSSessionInfo.#ctor(System.Management.Automation.Runspaces.PSSession)">
            <summary>
            Creates a session info object from a session object.
            </summary>
            <param name="Session">The session to wrap inside an info object</param>
        </member>
        <member name="T:PSFramework.Configuration.Config">
            <summary>
            Configuration Manager as well as individual configuration object.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.Config.Name">
            <summary>
            The Name of the setting
            </summary>
        </member>
        <member name="P:PSFramework.Configuration.Config.FullName">
            <summary>
            The full name of the configuration entry, comprised of both Module and Name.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.Config.Module">
            <summary>
            The module of the setting. Helps being able to group configurations.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.Config.Description">
            <summary>
            A description of the specific setting
            </summary>
        </member>
        <member name="P:PSFramework.Configuration.Config.Type">
            <summary>
            The data type of the value stored in the configuration element.
            </summary>
        </member>
        <member name="P:PSFramework.Configuration.Config.Value">
            <summary>
            The value stored in the configuration element
            </summary>
        </member>
        <member name="P:PSFramework.Configuration.Config.SafeValue">
            <summary>
            The value stored in the configuration element, but without deserializing objects.
            </summary>
        </member>
        <member name="P:PSFramework.Configuration.Config.Unchanged">
            <summary>
            Whether the value of the configuration setting has been changed since its initialization.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.Config.Handler">
            <summary>
            The handler script that is run whenever the configuration value is set.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.Config.Validation">
            <summary>
            Validates the user input
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.Config.Hidden">
            <summary>
            Setting this to true will cause the element to not be discovered unless using the '-Force' parameter on "Get-DbaConfig"
            </summary>
        </member>
        <member name="P:PSFramework.Configuration.Config.Initialized">
            <summary>
            Whether the setting has been initialized. This handles module imports and avoids modules overwriting settings when imported in multiple runspaces.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.Config.PolicySet">
            <summary>
            Whether this setting was set by policy
            </summary>
        </member>
        <member name="P:PSFramework.Configuration.Config.PolicyEnforced">
            <summary>
            Whether this setting was set by policy and forbids changes to the configuration.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.Config.SimpleExport">
            <summary>
            Enabling this causes export to json to use simple json serialization for data transmission.
            This is suitable for simple data that is not sensitive to conversion losses.
            Simple export leads to exports more easily readable to the human eye.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.Config.ModuleExport">
            <summary>
            Whether this setting should be exported to a module specific file when exporting to json by modulename.
            </summary>
        </member>
        <member name="P:PSFramework.Configuration.Config.RegistryData">
            <summary>
            The finalized value to put into the registry value when using policy to set this setting.
            Deprecated property.
            </summary>
        </member>
        <member name="M:PSFramework.Configuration.Config.SetPersistedValue(PSFramework.Configuration.ConfigurationValueType,System.String)">
            <summary>
            Applies the persisted value to the configuration item.
            This method should only be called by PSFramework internals
            </summary>
            <param name="Type">The type of data being specified</param>
            <param name="ValueString">The value string to register</param>
        </member>
        <member name="T:PSFramework.Configuration.ConfigScope">
            <summary>
            The location where a setting was applied
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigScope.UserDefault">
            <summary>
            The configuration is set as default value for the user
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigScope.UserMandatory">
            <summary>
            The configuration is enforced for the user
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigScope.SystemDefault">
            <summary>
            The configuration is set as default value for all users on the system
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigScope.SystemMandatory">
            <summary>
            The configuration is enforced for all users on the system.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigScope.FileUserLocal">
            <summary>
            The configuration is stored as Json in the per user local machine config directory.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigScope.FileUserShared">
            <summary>
            The configuration is stored as Json in the per user config directory shared across machines.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigScope.FileSystem">
            <summary>
            The configuration is stored as Json in the local computer config directory.
            </summary>
        </member>
        <member name="T:PSFramework.Configuration.ConfigurationHost">
            <summary>
            Host class providing static configuration settings that are constant across all runspaces within the process.
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigurationHost.Configurations">
            <summary>
            Hashtable containing all the configuration entries
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigurationHost.Validation">
            <summary>
            Hashtable containing all the registered validations
            </summary>
        </member>
        <member name="F:PSFramework.Configuration.ConfigurationHost.ImportFromRegistryDone">
            <summary>
            Whether the import from registry has been completed. Prevents multiple imports and overwrites when importing the module multiple times.
            </summary>
        </member>
        <member name="M:PSFramework.Configuration.ConfigurationHost.ConvertToPersistedValue(System.Object)">
            <summary>
            Converts any object into its persisted state.
            </summary>
            <param name="Item">The item to convert.</param>
            <returns>Its persisted state representation.</returns>
        </member>
        <member name="M:PSFramework.Configuration.ConfigurationHost.ConvertFromPersistedValue(System.String,PSFramework.Configuration.ConfigurationValueType)">
            <summary>
            Converts a persisted value back to its original data type
            </summary>
            <param name="PersistedValue">The value in its persisted state</param>
            <param name="Type">The type of the persisted value</param>
            <returns>The natural state of the value originally persisted</returns>
        </member>
        <member name="M:PSFramework.Configuration.ConfigurationHost.ConvertFromPersistedValue(System.String)">
            <summary>
            Converts a persisted value back to its original data type
            </summary>
            <param name="TypeQualifiedPersistedValue">The value in its persisted state, with a prefixed type identifier.</param>
            <returns>The natural state of the value originally persisted</returns>
        </member>
        <member name="M:PSFramework.Configuration.ConfigurationHost.Utf8ToBase64(System.String)">
            <summary>
            Converts a plain text into a base64 string
            </summary>
            <param name="Value">The string to convert</param>
            <returns>base64 encoded version of string.</returns>
        </member>
        <member name="M:PSFramework.Configuration.ConfigurationHost.Base64ToUtf8(System.String)">
            <summary>
            Converts a base64 encoded string into plain text
            </summary>
            <param name="Value">The string to convert</param>
            <returns>Plain Text string</returns>
        </member>
        <member name="T:PSFramework.Configuration.ConfigurationValue">
            <summary>
            Contains all information about a configuration item's value </summary> </member> <member name="P:PSFramework.Configuration.ConfigurationValue.Value"> <summary> The runtime value of the setting. </summary> </member> <member name="P:PSFramework.Configuration.ConfigurationValue.PersistedValue"> <summary> The value in its persisted state </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValue.PersistedType"> <summary> The kind of </summary> </member> <member name="P:PSFramework.Configuration.ConfigurationValue.TypeQualifiedPersistedValue"> <summary> The type qualified representation of the persisted value </summary> </member> <member name="P:PSFramework.Configuration.ConfigurationValue.SafeValue"> <summary> Ensures wanton Get-PSFConfig will not deserialize persisted objects that might have registered deserialization in their module. </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValue._Value"> <summary> Internal storage for the Value property </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValue._PersistedValue"> <summary> Internal storage for the PersistedValue property </summary> </member> <member name="M:PSFramework.Configuration.ConfigurationValue.ToString"> <summary> The string representation of its actual value </summary> <returns>Returns the type-qualified string representation of its value</returns> </member> <member name="M:PSFramework.Configuration.ConfigurationValue.#ctor(System.String,PSFramework.Configuration.ConfigurationValueType)"> <summary> Creates a value object from persisted data </summary> <param name="PersistedValue">The value that will be persisted</param> <param name="PersistedType">The type of the value to be persisted</param> </member> <member name="M:PSFramework.Configuration.ConfigurationValue.#ctor(System.Object)"> <summary> Creates a value object from runtime data </summary> <param name="Value">The value that will be stored</param> </member> <member name="T:PSFramework.Configuration.ConfigurationValueType"> <summary> The data types supported by the configuration system. </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Unknown"> <summary> An unknown type, should be prevented </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Null"> <summary> The value is as empty as the void. </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Bool"> <summary> The value is of a true/false kind </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Int"> <summary> The value is a regular integer </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Double"> <summary> The value is a double numeric value </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Long"> <summary> The value is a long type </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.String"> <summary> The value is a common string </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Timespan"> <summary> The value is a regular timespan </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Datetime"> <summary> The value is a plain datetime </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.ConsoleColor"> <summary> The value is a fancy console color </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Array"> <summary> The value is an array full of booty </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Hashtable"> <summary> The value is a hashtable </summary> </member> <member name="F:PSFramework.Configuration.ConfigurationValueType.Object"> <summary> The value is something indeterminate, but possibly complex </summary> </member> <member name="T:PSFramework.FlowControl.OperatingSystem"> <summary> The various operating systems PowerShell can run on </summary> </member> <member name="F:PSFramework.FlowControl.OperatingSystem.Windows"> <summary> Common windows OS </summary> </member> <member name="F:PSFramework.FlowControl.OperatingSystem.Linux"> <summary> Any Linux distribution </summary> </member> <member name="F:PSFramework.FlowControl.OperatingSystem.MacOS"> <summary> Any Mac Operating System </summary> </member> <member name="T:PSFramework.FlowControl.PSEdition"> <summary> The powershell edition </summary> </member> <member name="F:PSFramework.FlowControl.PSEdition.Desktop"> <summary> The desktop edition of PowerShell - all editions 5.1 or below </summary> </member> <member name="F:PSFramework.FlowControl.PSEdition.Core"> <summary> .NET core based editions of PowerShell </summary> </member> <member name="T:PSFramework.License.License"> <summary> Contains license information for a single product </summary> </member> <member name="F:PSFramework.License.License.Product"> <summary> The name of the product the license is for. </summary> </member> <member name="F:PSFramework.License.License.Manufacturer"> <summary> Who made the license product? </summary> </member> <member name="F:PSFramework.License.License.ProductVersion"> <summary> The version of the product covered by the license. </summary> </member> <member name="F:PSFramework.License.License.ProductType"> <summary> The type of product the licensed product is. </summary> </member> <member name="F:PSFramework.License.License.LicenseName"> <summary> The name of the license. Useful for the usual public licenses. </summary> </member> <member name="F:PSFramework.License.License.LicenseVersion"> <summary> The version of the license. Useful for the usual public licenses. </summary> </member> <member name="F:PSFramework.License.License.LicenseDate"> <summary> When was the product licensed with the specified license. </summary> </member> <member name="F:PSFramework.License.License.LicenseType"> <summary> The type of the license. This allows filtering licenses by their limitations. </summary> </member> <member name="F:PSFramework.License.License.LicenseText"> <summary> The full license text for the pleasure of the reader. </summary> </member> <member name="F:PSFramework.License.License.Description"> <summary> Add some desription to how it is used. </summary> </member> <member name="F:PSFramework.License.License.Parent"> <summary> A parent license to indicate a product used within a product. </summary> </member> <member name="T:PSFramework.License.LicenseHost"> <summary> Host class covering all static needs of the licensing system. </summary> </member> <member name="F:PSFramework.License.LicenseHost.Licenses"> <summary> The list containing all registered licenses. </summary> </member> <member name="M:PSFramework.License.LicenseHost.Add(PSFramework.License.License)"> <summary> Adds a new licenses to the list of registerd licenses. </summary> <param name="License">The license to add</param> </member> <member name="M:PSFramework.License.LicenseHost.Clear"> <summary> Removes all registered Licenses </summary> </member> <member name="M:PSFramework.License.LicenseHost.Get"> <summary> Returns all registered licenses </summary> <returns>All registerd licenses</returns> </member> <member name="M:PSFramework.License.LicenseHost.Remove(PSFramework.License.License)"> <summary> Removes a spceific licenses from the list of registerd licenses </summary> <param name="License">License to remove</param> </member> <member name="T:PSFramework.License.LicenseType"> <summary> What kind of License is this? By default, a license is a free license allowing modification but requiring attribution. </summary> </member> <member name="F:PSFramework.License.LicenseType.Free"> <summary> No special type is present </summary> </member> <member name="F:PSFramework.License.LicenseType.Commercial"> <summary> The license is for a commercial product. This means you have to acquire use permission, such as software licenses, user CALs et al. </summary> </member> <member name="F:PSFramework.License.LicenseType.NoAttribution"> <summary> Reusing this product requires no attribution. Just use it and call it your own. </summary> </member> <member name="F:PSFramework.License.LicenseType.NoModify"> <summary> This product may be used, but must not be modified in any way. </summary> </member> <member name="T:PSFramework.License.ProductType"> <summary> What kind of product is being licensed </summary> </member> <member name="F:PSFramework.License.ProductType.Module"> <summary> The product is a PowerShell module </summary> </member> <member name="F:PSFramework.License.ProductType.Script"> <summary> The Product is a Script of any kind </summary> </member> <member name="F:PSFramework.License.ProductType.Library"> <summary> The Product is a library, bringing functionality to the Shell </summary> </member> <member name="F:PSFramework.License.ProductType.Application"> <summary> The Product is a standalone application, that happens to utilize PowerShell </summary> </member> <member name="F:PSFramework.License.ProductType.Other"> <summary> The Product is anything other than the default types </summary> </member> <member name="T:PSFramework.Logging.LogFileFileType"> <summary> The data format to log to in the logfile logging provider </summary> </member> <member name="F:PSFramework.Logging.LogFileFileType.Csv"> <summary> Write as comma separated value </summary> </member> <member name="F:PSFramework.Logging.LogFileFileType.Html"> <summary> Write as Html fragment </summary> </member> <member name="F:PSFramework.Logging.LogFileFileType.Json"> <summary> Write as Json fragment </summary> </member> <member name="F:PSFramework.Logging.LogFileFileType.Xml"> <summary> Write as Xml fragment </summary> </member> <member name="T:PSFramework.Logging.Provider"> <summary> Class containing all information/content needed for a logging provider </summary> </member> <member name="F:PSFramework.Logging.Provider.Name"> <summary> Each logging provider has a name. Make sure it's unique
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.Enabled">
            <summary>
            Whether the logging provider is enabled. Only when this is set to true will the logging script execute its events.
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.Initialized">
            <summary>
            The provider has had its initial runtime configuration (what is stored in the BeginEvent) applied.
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.InstallationOptional">
            <summary>
            Whether the provider must be installed, in order for it to be used.
            </summary>
        </member>
        <member name="P:PSFramework.Logging.Provider.IncludeModules">
            <summary>
            List of modules to include in the logging. Only messages generated from these modules will be considered by the provider
            </summary>
        </member>
        <member name="P:PSFramework.Logging.Provider.ExcludeModules">
            <summary>
            List of modules to exclude in the logging. Messages generated from these modules will be ignored by this provider.
            </summary>
        </member>
        <member name="P:PSFramework.Logging.Provider.IncludeTags">
            <summary>
            List of tags to include. Only messages with these tags will be considered by this provider.
            </summary>
        </member>
        <member name="P:PSFramework.Logging.Provider.ExcludeTags">
            <summary>
            List of tags to exclude. Messages with these tags will be ignored by this provider.
            </summary>
        </member>
        <member name="M:PSFramework.Logging.Provider.MessageApplies(PSFramework.Message.LogEntry)">
            <summary>
            Tests whether a log entry applies to the provider
            </summary>
            <param name="Entry">The Entry to validate</param>
            <returns>Whether it applies</returns>
        </member>
        <member name="M:PSFramework.Logging.Provider.MessageApplies(PSFramework.Message.PsfExceptionRecord)">
            <summary>
            Tests whether an error record applies to the provider
            </summary>
            <param name="Record">The error record to test</param>
            <returns>Whether it applies to the provider</returns>
        </member>
        <member name="F:PSFramework.Logging.Provider.BeginEvent">
            <summary>
            Event that is executed once per logging script execution, before logging occurs
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.StartEvent">
            <summary>
            Event that is executed each logging cycle, right before processing items.
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.MessageEvent">
            <summary>
            Event that is executed for each message written
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.ErrorEvent">
            <summary>
            Event that is executed for each error written
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.EndEvent">
            <summary>
            Event that is executed once per logging cycle, after processing all message and error items.
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.FinalEvent">
            <summary>
            Final Event that is executed when stopping the logging script.
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.IsInstalledScript">
            <summary>
            Script that recognizes, whether the provider has been isntalled correctly. Some providers require installation, in order to function properly.
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.InstallationScript">
            <summary>
            Script that installs the provider
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.InstallationParameters">
            <summary>
            Script that generates dynamic parameters for installing the provider.
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.ConfigurationParameters">
            <summary>
            Scriptblock that adds additional parameters as needed to the Set-PSFLoggingProvider function
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.ConfigurationScript">
            <summary>
            The configuration steps taken by the Set-PSFLoggingProvider function
            </summary>
        </member>
        <member name="F:PSFramework.Logging.Provider.Errors">
            <summary>
            List of errors that happened on the logging runspace.
            </summary>
        </member>
        <member name="T:PSFramework.Logging.ProviderHost">
            <summary>
            Provides infrastructure services for the logging provider system
            </summary>
        </member>
        <member name="F:PSFramework.Logging.ProviderHost.Providers">
            <summary>
            Dictionary with all registered logging providers
            </summary>
        </member>
        <member name="M:PSFramework.Logging.ProviderHost.GetEnabled">
            <summary>
            Returns all enabled logging providers
            </summary>
            <returns>All enabled logging providers</returns>
        </member>
        <member name="M:PSFramework.Logging.ProviderHost.GetInitialized">
            <summary>
            Returns all enabled &amp; initialized logging provider
            </summary>
            <returns></returns>
        </member>
        <member name="T:PSFramework.Message.LogEntry">
            <summary>
            An individual entry for the message log
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.Message">
            <summary>
            The message logged
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.Type">
            <summary>
            What kind of entry was this?
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.Timestamp">
            <summary>
            When was the message logged?
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.FunctionName">
            <summary>
            What function wrote the message
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.ModuleName">
            <summary>
            The name of the module of the function that wrote the message
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.Tags">
            <summary>
            The tags applied to the message
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.Level">
            <summary>
            What level was the message?
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.Runspace">
            <summary>
            What runspace was the message written from?
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.ComputerName">
            <summary>
            The computer the message was generated on
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.TargetObject">
            <summary>
            The object that was the focus of this message.
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.File">
            <summary>
            The file from which the message was written.
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.Line">
            <summary>
            The line on which the message was written.
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.CallStack">
            <summary>
            The callstack when the message was written.
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntry.Username">
            <summary>
            The user that did the writing.
            </summary>
        </member>
        <member name="M:PSFramework.Message.LogEntry.#ctor">
            <summary>
            Creates an empty log entry
            </summary>
        </member>
        <member name="M:PSFramework.Message.LogEntry.#ctor(System.String,PSFramework.Message.LogEntryType,System.DateTime,System.String,System.String,System.Collections.Generic.List{System.String},PSFramework.Message.MessageLevel,System.Guid,System.String,System.Object,System.String,System.Int32,System.Collections.Generic.IEnumerable{System.Management.Automation.CallStackFrame},System.String)">
            <summary>
            Creates a filled out log entry
            </summary>
            <param name="Message">The message that was logged</param>
            <param name="Type">The type(s) of message written</param>
            <param name="Timestamp">When was the message logged</param>
            <param name="FunctionName">What function wrote the message</param>
            <param name="ModuleName">Name of the module the function writing this message came from</param>
            <param name="Tags">Tags that were applied to the message</param>
            <param name="Level">What level was the message written at.</param>
            <param name="Runspace">The ID of the runspace that wrote the message.</param>
            <param name="ComputerName">The computer the message was generated on.</param>
            <param name="TargetObject">The object this message was all about.</param>
            <param name="File">The file of the code that wrote the message.</param>
            <param name="Line">The line on which the message was written.</param>
            <param name="CallStack">The callstack that triggered the write.</param>
            <param name="Username">The user responsible for running the code that is writing the message.</param>
        </member>
        <member name="T:PSFramework.Message.LogEntryType">
            <summary>
            The kind of information the logged entry was.
            </summary>
        </member>
        <member name="F:PSFramework.Message.LogEntryType.None">
            <summary>
            This entry wasn't written to any stream </summary> </member> <member name="F:PSFramework.Message.LogEntryType.Information"> <summary> A message that was written to the current host equivalent, if available also to the information stream </summary> </member> <member name="F:PSFramework.Message.LogEntryType.Verbose"> <summary> A message that was written to the verbose stream </summary> </member> <member name="F:PSFramework.Message.LogEntryType.Debug"> <summary> A message that was written to the Debug stream </summary> </member> <member name="F:PSFramework.Message.LogEntryType.Warning"> <summary> A message written to the warning stream </summary> </member> <member name="T:PSFramework.Message.LogHost"> <summary> Provides static information storage for logging related settings, as well as housing the logging queues. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxErrorCount"> <summary> The maximum numbers of error records maintained in-memory. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxMessageCount"> <summary> The maximum number of messages that can be maintained in the in-memory message queue </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxMessagefileBytes"> <summary> The maximum size of a given logfile. When reaching this limit, the file will be abandoned and a new log created. Set to 0 to not limit the size. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxMessagefileCount"> <summary> The maximum number of logfiles maintained at a time. Exceeding this number will cause the oldest to be culled. Set to 0 to disable the limit. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxErrorFileBytes"> <summary> The maximum size all error files combined may have. When this number is exceeded, the oldest entry is culled. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxTotalFolderSize"> <summary> This is the upper limit of length all items in the log folder may have combined across all processes. </summary> </member> <member name="F:PSFramework.Message.LogHost.LoggingPath"> <summary> Path to where the logfiles live. </summary> </member> <member name="F:PSFramework.Message.LogHost.MaxLogFileAge"> <summary> Any logfile older than this will automatically be cleansed </summary> </member> <member name="F:PSFramework.Message.LogHost.MessageLogFileEnabled"> <summary> Governs, whether a log file for the system messages is written </summary> </member> <member name="F:PSFramework.Message.LogHost.MessageLogEnabled"> <summary> Governs, whether a log of recent messages is kept in memory </summary> </member> <member name="F:PSFramework.Message.LogHost.ErrorLogFileEnabled"> <summary> Governs, whether log files for errors are written </summary> </member> <member name="F:PSFramework.Message.LogHost.ErrorLogEnabled"> <summary> Governs, whether a log of recent errors is kept in memory </summary> </member> <member name="F:PSFramework.Message.LogHost.OutQueueError"> <summary> The outbound queue for errors. These will be processed and written to xml </summary> </member> <member name="F:PSFramework.Message.LogHost.OutQueueLog"> <summary> The outbound queue for logs. These will be processed and written to logfile </summary> </member> <member name="M:PSFramework.Message.LogHost.GetErrors"> <summary> Retrieves a copy of the Error stack </summary> <returns>All errors thrown by functions using the message or flowcontrol system</returns> </member> <member name="M:PSFramework.Message.LogHost.GetLog"> <summary> Retrieves a copy of the message log </summary> <returns>All messages logged this session.</returns> </member> <member name="M:PSFramework.Message.LogHost.WriteErrorEntry(System.Management.Automation.ErrorRecord[],System.String,System.String,System.Collections.Generic.List{System.String},System.DateTime,System.String,System.Guid,System.String)"> <summary> Write an error record to the log </summary> <param name="Record">The actual error record as powershell wrote it</param> <param name="FunctionName">The name of the function writing the error</param> <param name="ModuleName">The name of the module the function writing the error came from</param> <param name="Tags">The tags that were assigned to the error event</param> <param name="Timestamp">When was the error written</param> <param name="Message">What message was passed to the user</param> <param name="Runspace">The runspace the message was written from</param> <param name="ComputerName">The computer the error was written on</param> </member> <member name="M:PSFramework.Message.LogHost.WriteLogEntry(System.String,PSFramework.Message.LogEntryType,System.DateTime,System.String,System.String,System.Collections.Generic.List{System.String},PSFramework.Message.MessageLevel,System.Guid,System.String,System.String,System.Int32,System.Collections.Generic.IEnumerable{System.Management.Automation.CallStackFrame},System.String,System.Object)"> <summary> Write a new entry to the log </summary> <param name="Message">The message to log</param> <param name="Type">The type of the message logged</param> <param name="Timestamp">When was the message generated</param> <param name="FunctionName">What function wrote the message</param> <param name="ModuleName">What module did the function writing this message come from?</param> <param name="Tags">The tags that were applied to the message</param> <param name="Level">At what level was the function written</param> <param name="Runspace">The runspace the message is coming from</param> <param name="ComputerName">The computer the message was generated on</param> <param name="File">The file from which the message was written</param> <param name="Line">The line on which the message was written</param> <param name="TargetObject">The object associated with a given message.</param> <param name="CallStack">The callstack at the moment the message was written.</param> <param name="Username">The name of the user under which the code being executed</param> <returns>The entry that is being written</returns> </member> <member name="T:PSFramework.Message.MessageEventSubscription"> <summary> Condition and logic to be executed on message events </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription.Name"> <summary> Name of the event subscription, must be unique. </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription.ScriptBlock"> <summary> Scriptblock to execute if the condition is met </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._MessageFilter"> <summary> The internally stored filter value for Message </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.MessageFilter"> <summary> The value the Message is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.MessageFilterSet"> <summary> Whether filtering by Message was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._ModuleNameFilter"> <summary> The internally stored filter value for ModuleName </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.ModuleNameFilter"> <summary> The value the ModuleName is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.ModuleNameFilterSet"> <summary> Whether filtering by ModuleName was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._FunctionNameFilter"> <summary> The internally stored filter value for FunctionName </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.FunctionNameFilter"> <summary> The value the FunctionName is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.FunctionNameFilterSet"> <summary> Whether filtering by FunctionName was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._TargetFilter"> <summary> The internally stored filter value for Target </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.TargetFilter"> <summary> The value the Target is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.TargetFilterSet"> <summary> Whether filtering by Target was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._LevelFilter"> <summary> The internally stored filter value for Level </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.LevelFilter"> <summary> The value the Level is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.LevelFilterSet"> <summary> Whether filtering by Level was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._TagFilter"> <summary> The internally stored filter value for Tag </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.TagFilter"> <summary> The value the Tag is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.TagFilterSet"> <summary> Whether filtering by Tag was enabled </summary> </member> <member name="F:PSFramework.Message.MessageEventSubscription._RunspaceFilter"> <summary> The internally stored filter value for Runspace </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.RunspaceFilter"> <summary> The value the Runspace is filtered by </summary> </member> <member name="P:PSFramework.Message.MessageEventSubscription.RunspaceFilterSet"> <summary> Whether filtering by Runspace was enabled </summary> </member> <member name="M:PSFramework.Message.MessageEventSubscription.Applies(PSFramework.Message.LogEntry)"> <summary> Checks, whether a given entry matches the filter defined in this subscription </summary> <param name="Entry">The entry to validate</param> <returns>Whether the subscription should react to this entry</returns> </member> <member name="T:PSFramework.Message.MessageHost"> <summary> Provides static resources to the messaging subsystem </summary> </member> <member name="F:PSFramework.Message.MessageHost.MaximumInformation"> <summary> The maximum message level to still display to the user directly. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MaximumVerbose"> <summary> The maxium message level where verbose information is still written. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MaximumDebug"> <summary> The maximum message level where debug information is still written. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MinimumInformation"> <summary> The minimum required message level for messages that will be shown to the user. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MinimumVerbose"> <summary> The minimum required message level where verbose information is written. </summary> </member> <member name="F:PSFramework.Message.MessageHost.MinimumDebug"> <summary> The minimum required message level where debug information is written. </summary> </member> <member name="F:PSFramework.Message.MessageHost.InfoColor"> <summary> The color stuff gets written to the console in </summary> </member> <member name="F:PSFramework.Message.MessageHost.InfoColorEmphasis"> <summary> The color important stuff gets written to the console in </summary> </member> <member name="F:PSFramework.Message.MessageHost.InfoColorSubtle"> <summary> The color background stuff gets written to the console in </summary> </member> <member name="F:PSFramework.Message.MessageHost.DeveloperColor"> <summary> The color stuff gets written to the console in, when developer mode is enabled and the message would not have been written after all </summary> </member> <member name="F:PSFramework.Message.MessageHost.DeveloperMode"> <summary> Enables the developer mode. In this all messages are written to the console, in order to make it easier to troubleshoot issues. </summary> </member> <member name="F:PSFramework.Message.MessageHost.NestedLevelDecrement"> <summary> Message levels can decrease by nested level. This causes messages to have an increasingly reduced level as the size of the callstack increases. </summary> </member> <member name="F:PSFramework.Message.MessageHost.DisableVerbosity"> <summary> Globally override all verbosity </summary> </member> <member name="F:PSFramework.Message.MessageHost.EnableMessageTimestamp"> <summary> Include message timestamps in verbose message output </summary> </member> <member name="F:PSFramework.Message.MessageHost.EnableMessageDisplayCommand"> <summary> Include the message display command in the verbose message output </summary> </member> <member name="F:PSFramework.Message.MessageHost.EnableMessageBreadcrumbs"> <summary> Include the entire callstack in the verbose message output </summary> </member> <member name="F:PSFramework.Message.MessageHost.TransformErrorQueueSize"> <summary> The size of the transform error queue. When adding more than this, the oldest entry will be discarded </summary> </member> <member name="F:PSFramework.Message.MessageHost.ExceptionTransforms"> <summary> Provides the option to transform exceptions based on the original exception type </summary> </member> <member name="F:PSFramework.Message.MessageHost.TargetTransforms"> <summary> Provides the option to transform target objects based on type. This is sometimes important when working with live state objects that should not be serialized. </summary> </member> <member name="F:PSFramework.Message.MessageHost.TransformErrors"> <summary> The list of transformation errors that occured. </summary> </member> <member name="M:PSFramework.Message.MessageHost.GetTransformErrors"> <summary> Returns the current queue of failed transformations </summary> <returns>The list of transformations that failed</returns> </member> <member name="M:PSFramework.Message.MessageHost.WriteTransformError(System.Management.Automation.ErrorRecord,System.String,System.String,System.Object,PSFramework.Message.TransformType,System.Guid)"> <summary> Writes a new transform error </summary> <param name="Record">The record of what went wrong</param> <param name="FunctionName">The name of the function writing the transformed message</param> <param name="ModuleName">The module the function writing the transformed message is part of</param> <param name="Object">The object that should have been transformed</param> <param name="Type">The type of transform that was attempted</param> <param name="Runspace">The runspace it all happened on</param> </member> <member name="F:PSFramework.Message.MessageHost.ExceptionTransformList"> <summary> List of custom transforms for exceptions </summary> </member> <member name="F:PSFramework.Message.MessageHost.TargetTransformlist"> <summary> List of custom transforms for targets </summary> </member> <member name="F:PSFramework.Message.MessageHost.MessageLevelModifiers"> <summary> List of all modifiers that apply to message levels </summary> </member> <member name="F:PSFramework.Message.MessageHost.Events"> <summary> List of events that subscribe to messages being written </summary> </member> <member name="T:PSFramework.Message.MessageLevel"> <summary> The various levels of verbosity available. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Critical"> <summary> Very important message, should be shown to the user as a high priority </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Important"> <summary> Important message, the user should read this </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Output"> <summary> Important message, the user should read this </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Host"> <summary> Important message, the user should read this </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Significant"> <summary> Message relevant to the user. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.VeryVerbose"> <summary> Not important to the regular user, still of some interest to the curious </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Verbose"> <summary> Background process information, in case the user wants some detailed information on what is currently happening. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.SomewhatVerbose"> <summary> A footnote in current processing, rarely of interest to the user </summary> </member> <member name="F:PSFramework.Message.MessageLevel.System"> <summary> A message of some interest from an internal system persepctive, but largely irrelevant to the user. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Debug"> <summary> Something only of interest to a debugger </summary> </member> <member name="F:PSFramework.Message.MessageLevel.InternalComment"> <summary> This message barely made the cut from being culled. Of purely development internal interest, and even there is 'interest' a strong word for it. </summary> </member> <member name="F:PSFramework.Message.MessageLevel.Warning"> <summary> This message is a warning, sure sign something went badly wrong </summary> </member> <member name="T:PSFramework.Message.MessageLevelModifier"> <summary> A modification to a given message's level
            </summary>
        </member>
        <member name="F:PSFramework.Message.MessageLevelModifier.Name">
            <summary>
            Name of the modifier. Prevents duplication in a multi-runspace scenario.
            </summary>
        </member>
        <member name="F:PSFramework.Message.MessageLevelModifier.Modifier">
            <summary>
            The amount to modify the level by
            </summary>
        </member>
        <member name="F:PSFramework.Message.MessageLevelModifier.IncludeFunctionName">
            <summary>
            Apply modifier only to messages from this function.
            </summary>
        </member>
        <member name="F:PSFramework.Message.MessageLevelModifier.ExcludeFunctionName">
            <summary>
            Apply modifier not when the message is written by this function.
            </summary>
        </member>
        <member name="F:PSFramework.Message.MessageLevelModifier.IncludeModuleName">
            <summary>
            Apply modifier only to messages from this module
            </summary>
        </member>
        <member name="F:PSFramework.Message.MessageLevelModifier.ExcludeModuleName">
            <summary>
            Do not apply modifier to messages from this module
            </summary>
        </member>
        <member name="F:PSFramework.Message.MessageLevelModifier.IncludeTags">
            <summary>
            Only apply this modifier to a message that includes at least one of these tags
            </summary>
        </member>
        <member name="F:PSFramework.Message.MessageLevelModifier.ExcludeTags">
            <summary>
            Do not apply this modifier to a message that includes any of the following tags
            </summary>
        </member>
        <member name="M:PSFramework.Message.MessageLevelModifier.AppliesTo(System.String,System.String,System.Collections.Generic.List{System.String})">
            <summary>
            Tests, whether a message a message should be modified by this modiier
            </summary>
            <param name="FunctionName">The name of the function writing the message</param>
            <param name="ModuleName">The name of the module, the function writing this message comes from</param>
            <param name="Tags">The tags of the message written</param>
            <returns>Whether the message applies</returns>
        </member>
        <member name="T:PSFramework.Message.PsfException">
            <summary>
            Wrapper class that can emulate any exception for purpose of serialization without blowing up the storage space consumed
            </summary>
        </member>
        <member name="M:PSFramework.Message.PsfException.GetException">
            <summary>
            Returns the original exception object that we interpreted. This is on purpose not a property, as we want to avoid messing with serialization size.
            </summary>
            <returns>The original exception that got thrown</returns>
        </member>
        <member name="F:PSFramework.Message.PsfException.Message">
            <summary>
            The actual Exception Message
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.Source">
            <summary>
            The original source of the Exception
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.StackTrace">
            <summary>
            Where on the callstack did the exception occur?
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.TargetSite">
            <summary>
            What was the target site on the code that caused it. This property has been altered to avoid export issues, if a string representation is not sufficient, access the original exception using GetException()
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.HResult">
            <summary>
            The HResult of the exception. Useful in debugging native code errors.
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.HelpLink">
            <summary>
            Link to a proper help article.
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.Data">
            <summary>
            Additional data that has been appended
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.InnerException">
            <summary>
            The inner exception in a chain of exceptions.
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.ExceptionTypeName">
            <summary>
            The full namespace name of the exception that has been wrapped.
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.ExceptionData">
            <summary>
            Contains additional properties other exceptions might contain.
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.CategoryInfo">
            <summary>
            The category of the error
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.ErrorDetails">
            <summary>
            The details on the error
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.FullyQualifiedErrorId">
            <summary>
            The specific error identity, used to identify the target
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.InvocationInfo">
            <summary>
            The details of how this was called.
            </summary>
        </member>
        <member name="F:PSFramework.Message.PsfException.ScriptStackTrace">
            <summary>
            The script's stacktrace </summary> </member> <member name="F:PSFramework.Message.PsfException.TargetObject"> <summary> The object being processed </summary> </member> <member name="F:PSFramework.Message.PsfException.FunctionName"> <summary> The name of the function throwing the error </summary> </member> <member name="F:PSFramework.Message.PsfException.Timestamp"> <summary> When was the error thrown </summary> </member> <member name="F:PSFramework.Message.PsfException.Runspace"> <summary> The runspace the error occured on. </summary> </member> <member name="F:PSFramework.Message.PsfException.ComputerName"> <summary> The computer the error occured on. </summary> </member> <member name="M:PSFramework.Message.PsfException.#ctor"> <summary> Creates an empty exception object. Mostly for serialization support </summary> </member> <member name="M:PSFramework.Message.PsfException.#ctor(System.Exception)"> <summary> Creates an exception based on an original exception object </summary> <param name="Except">The exception to wrap around</param> </member> <member name="M:PSFramework.Message.PsfException.#ctor(System.Management.Automation.ErrorRecord)"> <summary> Creates a rich information exception object based on a full error record as recorded by PowerShell </summary> <param name="Record">The error record to copy from</param> </member> <member name="M:PSFramework.Message.PsfException.#ctor(System.Exception,System.String,System.DateTime,System.String,System.Guid,System.String)"> <summary> Creates a new exception object with rich meta information from the PowerShell runtime. </summary> <param name="Except">The exception thrown</param> <param name="FunctionName">The name of the function in which the error occured</param> <param name="Timestamp">When did the error occur</param> <param name="Message">The message to add to the exception</param> <param name="Runspace">The ID of the runspace from which the exception was thrown. Useful in multi-runspace scenarios.</param> <param name="ComputerName">The computer the error occured on.</param> </member> <member name="M:PSFramework.Message.PsfException.#ctor(System.Management.Automation.ErrorRecord,System.String,System.DateTime,System.String,System.Guid,System.String)"> <summary> Creates a new exception object with rich meta information from the PowerShell runtime. </summary> <param name="Record">The error record written</param> <param name="FunctionName">The name of the function in which the error occured</param> <param name="Timestamp">When did the error occur</param> <param name="Message">The message to add to the exception</param> <param name="Runspace">The ID of the runspace from which the exception was thrown. Useful in multi-runspace scenarios.</param> <param name="ComputerName">The computer the error occured on.</param> </member> <member name="M:PSFramework.Message.PsfException.ToString"> <summary> Returns a string representation of the exception. </summary> <returns></returns> </member> <member name="T:PSFramework.Message.PsfExceptionRecord"> <summary> Carrier class, designed to hold an arbitrary number of exceptions. Used for exporting to XML in nice per-incident packages. </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Runspace"> <summary> Runspace where shit happened. </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.ComputerName"> <summary> The computer name the exception was written on </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Timestamp"> <summary> When did things go bad? </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.FunctionName"> <summary> Name of the function, where fail happened. </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.ModuleName"> <summary> The module of the function where fail happened </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Tags"> <summary> The tags that were applied to the failure </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Message"> <summary> The message the poor user was shown. </summary> </member> <member name="P:PSFramework.Message.PsfExceptionRecord.ExceptionType"> <summary> Displays the name of the exception, the make scanning exceptions easier. </summary> </member> <member name="P:PSFramework.Message.PsfExceptionRecord.TargetObject"> <summary> The target object of the first exception in the list, if any </summary> </member> <member name="F:PSFramework.Message.PsfExceptionRecord.Exceptions"> <summary> List of Exceptions that are part of the incident (usually - but not always - only one). </summary> </member> <member name="M:PSFramework.Message.PsfExceptionRecord.#ctor"> <summary> Creates an empty container. Ideal for the homeworker who loves doing it all himself. </summary> </member> <member name="M:PSFramework.Message.PsfExceptionRecord.#ctor(PSFramework.Message.PsfException)"> <summary> Creates a container filled with the first exception. </summary> <param name="Exception"></param> </member> <member name="M:PSFramework.Message.PsfExceptionRecord.#ctor(System.Guid,System.String,System.DateTime,System.String,System.String,System.Collections.Generic.List{System.String},System.String)"> <summary> Creates a container filled with the meta information but untouched by exceptions </summary> <param name="Runspace">The runspace where it all happened</param> <param name="ComputerName">The computer the error was recorded</param> <param name="Timestamp">When did it happen?</param> <param name="FunctionName">Where did it happen?</param> <param name="ModuleName">The name of the module where fail happened</param> <param name="Tags">The tags that were assigned to the failure</param> <param name="Message">What did the witness have to say?</param> </member> <member name="T:PSFramework.Message.TransformCondition"> <summary> A condition, under which the object shall be transaformed </summary> </member> <member name="F:PSFramework.Message.TransformCondition.TypeName"> <summary> Name of the type. All similar types (as determined by the '-like' operator) will be transformed. </summary> </member> <member name="F:PSFramework.Message.TransformCondition.ModuleName"> <summary> The name of the module to consider, using the -Like operator </summary> </member> <member name="F:PSFramework.Message.TransformCondition.FunctionName"> <summary> The name of the function name to consider, using the -Like operator </summary> </member> <member name="F:PSFramework.Message.TransformCondition.ScriptBlock"> <summary> The scriptblock that performs the transformation </summary> </member> <member name="F:PSFramework.Message.TransformCondition.Type"> <summary> What kind of transformation is being performed? </summary> </member> <member name="M:PSFramework.Message.TransformCondition.#ctor(System.String,System.String,System.String,System.Management.Automation.ScriptBlock,PSFramework.Message.TransformType)"> <summary> Initializes a transform condition </summary> <param name="TypeName">Only objects of similar name will be transformed</param> <param name="ModuleName">Only objects coming from similar modules will be considered</param> <param name="FunctionName">Only objects coming from similar functions will be considered</param> <param name="ScriptBlock">The scriptblock used for the transformation</param> <param name="Type">What kind of transformation this is</param> </member> <member name="T:PSFramework.Message.TransformError"> <summary> An error occured during a message transformation </summary> </member> <member name="F:PSFramework.Message.TransformError.Record"> <summary> The error record of what went wrong </summary> </member> <member name="F:PSFramework.Message.TransformError.FunctionName"> <summary> The name of the function writing the message that failed to transform </summary> </member> <member name="F:PSFramework.Message.TransformError.ModuleName"> <summary> The name of the module the command writing the message came from </summary> </member> <member name="F:PSFramework.Message.TransformError.Timestamp"> <summary> When did it all happen? </summary> </member> <member name="F:PSFramework.Message.TransformError.Object"> <summary> The object that was supposed to be transformed </summary> </member> <member name="F:PSFramework.Message.TransformError.Type"> <summary> The kind of transform that failed </summary> </member> <member name="F:PSFramework.Message.TransformError.Runspace"> <summary> The runspace it all happened on </summary> </member> <member name="M:PSFramework.Message.TransformError.#ctor(System.Management.Automation.ErrorRecord,System.String,System.String,System.Object,PSFramework.Message.TransformType,System.Guid)"> <summary> Creates a new transform error </summary> <param name="Record">The record of what went wrong</param> <param name="FunctionName">The name of the function writing the transformed message</param> <param name="ModuleName">The module the function writing the transformed message is part of</param> <param name="Object">The object that should have been transformed</param> <param name="Type">The type of transform that was attempted</param> <param name="Runspace">The runspace it all happened on</param> </member> <member name="T:PSFramework.Message.TransformList"> <summary> List engine, managing the lists for a message transformation type </summary> </member> <member name="M:PSFramework.Message.TransformList.GetAll"> <summary> Returns all entries in the list. </summary> <returns>The list of transforms contained within</returns> </member> <member name="M:PSFramework.Message.TransformList.IsListed(PSFramework.Message.TransformCondition)"> <summary> Returns whether the actual object is part of the list </summary> <param name="Condition">The object to test for list membership</param> <returns>Whether the object is listed</returns> </member> <member name="M:PSFramework.Message.TransformList.IsContained(PSFramework.Message.TransformCondition)"> <summary> Returns whether a condition with equal conditions already exists </summary> <param name="Condition">The condition to test</param> <returns>Whether the referenced condition is already listed</returns> </member> <member name="M:PSFramework.Message.TransformList.Add(PSFramework.Message.TransformCondition)"> <summary> Adds a condition to the list, if there is no equivalent condition present. </summary> <param name="Condition">The condition to add</param> </member> <member name="M:PSFramework.Message.TransformList.Remove(PSFramework.Message.TransformCondition)"> <summary> Removes a condition from the lsit of conditional transforms </summary> <param name="Condition">The condition to remove</param> </member> <member name="M:PSFramework.Message.TransformList.Get(System.String,System.String,System.String)"> <summary> Returns the first transform whose filter is similar enough to work out. </summary> <param name="TypeName">The name of the type to check for a transform</param> <param name="ModuleName">The module of the command that wrote the message with the transformable object</param> <param name="Functionname">The command that wrote the message with the transformable object</param> <returns>Either a transform or null, if no fitting transform was found</returns> </member> <member name="T:PSFramework.Message.TransformType"> <summary> The messaging system provides these kinds of transformations for input. </summary> </member> <member name="F:PSFramework.Message.TransformType.Target"> <summary> A target transform can transform the target object specified. Used for live-state objects that should not be serialized on a second thread. </summary> </member> <member name="F:PSFramework.Message.TransformType.Exception"> <summary> An exception transform allows automatic transformation of exceptions. Primarily used to unwrap exceptions from an API that wraps all exceptions. </summary> </member> <member name="T:PSFramework.Parameter.ComputerParameter"> <summary> Parameter class that converts various input into a unified input representation </summary> </member> <member name="P:PSFramework.Parameter.ComputerParameter.ComputerName"> <summary> The resolved computername </summary> </member> <member name="P:PSFramework.Parameter.ComputerParameter.IsLocalhost"> <summary> Whether the computername is actually localhost or one of its equivalents </summary> </member> <member name="F:PSFramework.Parameter.ComputerParameter.Type"> <summary> What kind of object was passed. This makes it easier to detect and reuse specific kinds of live object in circumstances where that is desirable. </summary> </member> <member name="M:PSFramework.Parameter.ComputerParameter.op_Implicit(PSFramework.Parameter.ComputerParameter)~System.String"> <summary> Implicitly converts the parameter class to string </summary> <param name="Parameter">The parameter to convert</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.ToString"> <summary> Overrides the default ToString() method </summary> <returns></returns> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.String)"> <summary> Generates a Computer Parameter object from string </summary> <param name="ComputerName">The name to use as input</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Net.IPAddress)"> <summary> Creates a Computer Parameter from an IPAddress </summary> <param name="Address"></param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Management.Automation.Runspaces.PSSession)"> <summary> Creates a Computer Parameter from a PSSession </summary> <param name="Session">The session to use</param> </member> <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(PSFramework.ComputerManagement.PSSessionInfo)"> <summary> Creates a Computer Parameter from a PSSessionInfo object. Shouldn't happen in the wild, but still a legal inmput.
            </summary>
            <param name="SessionInfo">The session information object to interpret</param>
        </member>
        <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(Microsoft.Management.Infrastructure.CimSession)">
            <summary>
            Creates a Computer Parameter from a CimSession
            </summary>
            <param name="Session">The session to create the parameter from</param>
        </member>
        <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Net.NetworkInformation.PingReply)">
            <summary>
            Creates a Computer Parameter from the reply to a ping
            </summary>
            <param name="Ping">The result of a ping</param>
        </member>
        <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Net.IPHostEntry)">
            <summary>
            Creates a Computer Parameter from the result of a dns resolution
            </summary>
            <param name="Entry">The result of a dns resolution</param>
        </member>
        <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Data.SqlClient.SqlConnection)">
            <summary>
            Creates a Computer Parameter from an established SQL Connection
            </summary>
            <param name="Connection">The connection to use</param>
        </member>
        <member name="M:PSFramework.Parameter.ComputerParameter.#ctor(System.Object)">
            <summary>
            Generates a Computer Parameter object from anything
            </summary>
            <param name="InputObject"></param>
        </member>
        <member name="T:PSFramework.Parameter.ComputerParameterInputType">
            <summary>
            The kind of object that was bound to the parameter class
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ComputerParameterInputType.Default">
            <summary>
            The input object is just any non-special kind of input.
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ComputerParameterInputType.PSSession">
            <summary>
            The input object is a PowerShell Session object
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ComputerParameterInputType.SMOServer">
            <summary>
            The input object is a live SMO Server object
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ComputerParameterInputType.CimSession">
            <summary>
            The input object is a live cim session object
            </summary>
        </member>
        <member name="T:PSFramework.Parameter.DateTimeParameter">
            <summary>
            Parameter class for interpreting timespans
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.DateTimeParameter.Value">
            <summary>
            The resolved datetime value
            </summary>
        </member>
        <member name="M:PSFramework.Parameter.DateTimeParameter.ToString">
            <summary>
            The string value of the datetime object contained within.
            </summary>
            <returns>The string value of the datetime object contained within.</returns>
        </member>
        <member name="M:PSFramework.Parameter.DateTimeParameter.op_Implicit(PSFramework.Parameter.DateTimeParameter)~System.DateTime">
            <summary>
            Implicitly converts the parameter to datetime, allowing it to be used on parameters requiring the type
            </summary>
            <param name="Parameter">The parameterclass object to convert</param>
        </member>
        <member name="M:PSFramework.Parameter.DateTimeParameter.op_Implicit(System.DateTime)~PSFramework.Parameter.DateTimeParameter">
            <summary>
            Implicitly converts a datetime to this parameterclass object.
            </summary>
            <param name="Value">The timespan object to convert</param>
        </member>
        <member name="M:PSFramework.Parameter.DateTimeParameter.#ctor(System.DateTime)">
            <summary>
            Creates a DateTimeParameter from a DateTime object (not the hardest challenge)
            </summary>
            <param name="Value">The timespan object to accept</param>
        </member>
        <member name="M:PSFramework.Parameter.DateTimeParameter.#ctor(System.Int32)">
            <summary>
            Creates a DateTimeParameter with a DateTime value in seconds relative to the specifiewd number.
            </summary>
            <param name="Seconds">The seconds to differ from the current time.</param>
        </member>
        <member name="M:PSFramework.Parameter.DateTimeParameter.#ctor(System.String)">
            <summary>
            Creates a TimeSpanParameter from a string object
            </summary>
            <param name="Value">The string to interpret</param>
        </member>
        <member name="M:PSFramework.Parameter.DateTimeParameter.#ctor(System.Object)">
            <summary>
            Creates a TimeSpanParameter from any kind of object it has been taught to understand
            </summary>
            <param name="InputObject">The object to interpret</param>
        </member>
        <member name="M:PSFramework.Parameter.DateTimeParameter.ParseDateTime(System.String)">
            <summary>
            Parses an input string as timespan
            </summary>
            <param name="Value">The string to interpret</param>
            <returns>The interpreted timespan value</returns>
        </member>
        <member name="T:PSFramework.Parameter.ParameterClass">
            <summary>
            Base class of all parameter classes
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ParameterClass.InputObject">
            <summary>
            The original item presented as input
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ParameterClass._PropertyMapping">
            <summary>
            Contains the list of property mappings.
            Types can be registered to it, allowing the parameter class to blindly interpret unknown types
            </summary>
        </member>
        <member name="M:PSFramework.Parameter.ParameterClass.SetTypePropertyMapping(System.String,System.Collections.Generic.List{System.String})">
            <summary>
            Assigns a property mapping for a given type, allowing the parameter class to handle unknown types
            </summary>
            <param name="Name">The name of the type. Use the FullName of the type</param>
            <param name="PropertyName">The property names to register. When parsing input, it will move down this list until a valid property was found</param>
        </member>
        <member name="M:PSFramework.Parameter.ParameterClass.ToString">
            <summary>
            Returns the string representation of the parameter. Should be overridden by inheriting classes.
            </summary>
            <returns>The string representation of the object</returns>
        </member>
        <member name="T:PSFramework.Parameter.ParameterClassAttribute">
            <summary>
            Attribute marking a class
            </summary>
        </member>
        <member name="T:PSFramework.Parameter.ParameterClasses">
            <summary>
            List of available parameter classes
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ParameterClasses.Computer">
            <summary>
            The computer parameter class allows easily targeting a computer
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ParameterClasses.DateTime">
            <summary>
            The datetime parameter class allows for an easy way to specify a datetime
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ParameterClasses.TimeSpan">
            <summary>
            The timespan parameter class allows for an easy way to specify a timespan
            </summary>
        </member>
        <member name="T:PSFramework.Parameter.ParameterContractAttribute">
            <summary>
            The attribute used to define the elements of a ParameterClass contract
            </summary>
        </member>
        <member name="P:PSFramework.Parameter.ParameterContractAttribute.Type">
            <summary>
            Returns the type of the element this attribute is supposed to be attached to.
            </summary>
        </member>
        <member name="P:PSFramework.Parameter.ParameterContractAttribute.Behavior">
            <summary>
            Returns the behavior to expect from the contracted element. This sets the expectations on how this element is likely to act.
            </summary>
        </member>
        <member name="M:PSFramework.Parameter.ParameterContractAttribute.#ctor(PSFramework.Parameter.ParameterContractType,PSFramework.Parameter.ParameterContractBehavior)">
            <summary>
            Ceates a perfectly common parameter contract attribute. For use with all parameter classes' public elements. </summary> <param name="Type"></param> <param name="Behavior"></param> </member> <member name="T:PSFramework.Parameter.ParameterContractBehavior"> <summary> Defines how this element will behave </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.NotContracted"> <summary> This elements is not actually part of the contract. Generally you wouldn't want to add the attribute at all in that case. However, in some places it helps avoiding confusion.
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ParameterContractBehavior.Mandatory">
            <summary>
            This element may never be null and must be considered in all assignments. Even if the element is de facto not nullable, all constructors must assign it.
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ParameterContractBehavior.Optional">
            <summary>
            This element may contain data, but is not required to. In case of a method, it may simply do nothing
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ParameterContractBehavior.Failable">
            <summary>
            This method may throw an error when executing and should always be handled with try/catch. Use this on methods that use external calls.
            </summary>
        </member>
        <member name="F:PSFramework.Parameter.ParameterContractBehavior.Arbiter">
            <summary>
            The content of the thus marked field determines the dependent's state. Generally, only if the arbiter is true, will the dependent elements be mandatory. This behavior may only be assigned to boolean fields. </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.Conditional"> <summary> This behavior can be assigned together with the 'Mandatory' behavior. It means the field is only mandatory if an arbiter field is present and set to true. </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractBehavior.Conversion"> <summary> Converts content. Generally applied only to operators, but some methods may also convert information. </summary> </member> <member name="T:PSFramework.Parameter.ParameterContractType"> <summary> Defines what kind of element is granted the contract </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractType.Field"> <summary> The contracted element is a field containing a value </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractType.Method"> <summary> The contracted element is a method, performing an action </summary> </member> <member name="F:PSFramework.Parameter.ParameterContractType.Operator"> <summary> The contracted element is an operator, facilitating type conversion. Generally into a dedicated object type this parameterclass abstracts. </summary> </member> <member name="T:PSFramework.Parameter.TimeSpanParameter"> <summary> Parameter class for interpreting timespans </summary> </member> <member name="F:PSFramework.Parameter.TimeSpanParameter.Value"> <summary> The resolved timespan value </summary> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.ToString"> <summary> The string value of the timespan object contained within. </summary> <returns>The string value of the timespan object contained within.</returns> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.op_Implicit(PSFramework.Parameter.TimeSpanParameter)~System.TimeSpan"> <summary> Implicitly converts the parameter to timespan, allowing it to be used on parameters requiring the type </summary> <param name="Parameter">The parameterclass object to convert</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.op_Implicit(System.TimeSpan)~PSFramework.Parameter.TimeSpanParameter"> <summary> Implicitly converts a timespan to this parameterclass object. </summary> <param name="Value">The timespan object to convert</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.#ctor(System.TimeSpan)"> <summary> Creates a TimeSpanParameter from a TimeSpan object (not the hardest challenge) </summary> <param name="Value">The timespan object to accept</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.#ctor(System.Int32)"> <summary> Creates a TimeSpanParameter from integer, assuming it to mean seconds </summary> <param name="Seconds">The seconds to run</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.#ctor(System.String)"> <summary> Creates a TimeSpanParameter from a string object </summary> <param name="Value">The string to interpret</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.#ctor(System.Object)"> <summary> Creates a TimeSpanParameter from any kind of object it has been taught to understand </summary> <param name="InputObject">The object to interpret</param> </member> <member name="M:PSFramework.Parameter.TimeSpanParameter.ParseTimeSpan(System.String)"> <summary> Parses an input string as timespan </summary> <param name="Value">The string to interpret</param> <returns>The interpreted timespan value</returns> </member> <member name="T:PSFramework.PSFCore.PSFCoreHost"> <summary> Class containing static settings and values used to globally handle things </summary> </member> <member name="F:PSFramework.PSFCore.PSFCoreHost.Unattended"> <summary> Whether the current console is in unattended mode </summary> </member> <member name="T:PSFramework.PSFCore.PsfInternalAttribute"> <summary> Attribute designating something as reserved as PSFramework-internal. Changes to any component marked thus is not considered a breaking change. </summary> </member> <member name="F:PSFramework.PSFCore.PsfInternalAttribute.Description"> <summary> Allows specifying a description or comments along with the attribute. </summary> </member> <member name="T:PSFramework.ResultCache.ResultCache"> <summary> The class containing all things related to the result cache functionality. </summary> </member> <member name="P:PSFramework.ResultCache.ResultCache.Result"> <summary> The actually cached result </summary> </member> <member name="F:PSFramework.ResultCache.ResultCache.Function"> <summary> The function that wrote the cache. </summary> </member> <member name="P:PSFramework.ResultCache.ResultCache.Timestamp"> <summary> Returns, when the cache was last set </summary> </member> <member name="M:PSFramework.ResultCache.ResultCache.Clear"> <summary> Clears all cache properties to null </summary> </member> <member name="T:PSFramework.Runspace.RunspaceContainer"> <summary> Class that contains the logic necessary to manage a unique runspace </summary> </member> <member name="F:PSFramework.Runspace.RunspaceContainer.Name"> <summary> The name of the runspace. </summary> </member> <member name="P:PSFramework.Runspace.RunspaceContainer.RunspaceGuid"> <summary> The Guid of the running Runspace </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.SetScript(System.Management.Automation.ScriptBlock)"> <summary> Sets the script to execute in the runspace. Will NOT take immediate effect. Only after restarting the runspace will it be used. </summary> <param name="Script">The scriptblock to execute</param> </member> <member name="P:PSFramework.Runspace.RunspaceContainer.State"> <summary> The state the runspace currently is in. </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.Start"> <summary> Starts the Runspace. </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.SetName(System.Management.Automation.Runspaces.Runspace)"> <summary> Sets the name on a runspace. This WILL FAIL for PowerShell v3! </summary> <param name="Runspace">The runspace to be named</param> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.Stop"> <summary> Gracefully stops the Runspace </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.Kill"> <summary> Very ungracefully kills the runspace. Use only in the most dire emergency. </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.SignalStopped"> <summary> Signals the registered runspace has stopped execution </summary> </member> <member name="M:PSFramework.Runspace.RunspaceContainer.#ctor(System.String,System.Management.Automation.ScriptBlock)"> <summary> Creates a new runspace container with the basic information needed </summary> <param name="Name">The name of the Runspace</param> <param name="Script">The code using the runspace logic</param> </member> <member name="T:PSFramework.Runspace.RunspaceHost"> <summary> Provides hosting for all registered runspaces </summary> </member> <member name="F:PSFramework.Runspace.RunspaceHost.StopTimeoutSeconds"> <summary> The number of seconds before a Stop command is interrupted and instead the runspace is gracelessly shut down. </summary> </member> <member name="F:PSFramework.Runspace.RunspaceHost.Runspaces"> <summary> The dictionary containing the definitive list of unique Runspace </summary> </member> <member name="T:PSFramework.Runspace.PsfRunspaceState"> <summary> Contains the state a managed, unique runspace can be in. </summary> </member> <member name="F:PSFramework.Runspace.PsfRunspaceState.Running"> <summary> The runspace is up and running </summary> </member> <member name="F:PSFramework.Runspace.PsfRunspaceState.Stopping"> <summary> The runspace has received the stop order, but has not yet obeyed it </summary> </member> <member name="F:PSFramework.Runspace.PsfRunspaceState.Stopped"> <summary> The runspace has followed its order to stop and is currently disabled </summary> </member> <member name="T:PSFramework.Serialization.SerializationTypeConverter"> <summary> Typeconverter that does the heavy lifting of maintaining type integrity across process borders. </summary> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.CanConvertFrom(System.Object,System.Type)"> <summary> Whether the source can be converted to its destination </summary> <param name="sourceValue">The value to convert</param> <param name="destinationType">The type to convert to</param> <returns>Whether this action is possible</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.ConvertFrom(System.Object,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Converts an object </summary> <param name="sourceValue">The data to convert</param> <param name="destinationType">The type to convert to</param> <param name="formatProvider">This will be ignored, but must be present</param> <param name="ignoreCase">This will be ignored, but must be present</param> <returns>The converted object</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.CanConvertTo(System.Object,System.Type)"> <summary> Whether the input object can be converted to the Destination type </summary> <param name="sourceValue">Input value</param> <param name="destinationType">The type to convert to</param> <returns></returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.ConvertTo(System.Object,System.Type,System.IFormatProvider,System.Boolean)"> <summary> Converts an object </summary> <param name="sourceValue">The data to convert</param> <param name="destinationType">The type to convert to</param> <param name="formatProvider">This will be ignored, but must be present</param> <param name="ignoreCase">This will be ignored, but must be present</param> <returns>The converted object</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.RegisterAssemblyResolver"> <summary> Registers an assembly resolving event </summary> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.CanSerialize(System.Object)"> <summary> Whether an object can be serialized </summary> <param name="obj">The object to test</param> <returns>Whether the object can be serialized</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.CanSerialize(System.Type)"> <summary> Whether a type can be serialized </summary> <param name="type">The type to test</param> <returns>Whether the specified type can be serialized</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.TypeIsSerializable(System.Type)"> <summary> The validation check on whether a type is serializable </summary> <param name="type">The type to test</param> <returns>Returns whether that type can be serialized</returns> </member> <member name="M:PSFramework.Serialization.SerializationTypeConverter.GetSerializationData(System.Management.Automation.PSObject)"> <summary> Used to obtain the information to write </summary> <param name="psObject">The object to dissect</param> <returns>A memory stream.</returns> </member> <member name="T:PSFramework.TabExpansion.ScriptContainer"> <summary> Regular container to store scripts in, that are used in TEPP </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.Name"> <summary> The name of the scriptblock </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.ScriptBlock"> <summary> The scriptblock doing the logic </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.LastExecution"> <summary> The last time the scriptblock was called. Must be updated by the scriptblock itself </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.LastDuration"> <summary> The time it took to run the last time </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.InnerScriptBlock"> <summary> Scriptblock for users using simple-TEPP acceleration </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.ErrorRecords"> <summary> THe errors that occured during scriptblock execution. </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.LastResult"> <summary> The values the last search returned </summary> </member> <member name="F:PSFramework.TabExpansion.ScriptContainer.LastResultsValidity"> <summary> How long are previous values valid, before a new execution becomes necessary. </summary> </member> <member name="P:PSFramework.TabExpansion.ScriptContainer.ShouldExecute"> <summary> Returns whether a new refresh of tab completion should be executed. </summary> </member> <member name="M:PSFramework.TabExpansion.ScriptContainer.Invoke"> <summary> Returns the correct results, either by </summary> <returns></returns> </member> <member name="T:PSFramework.TabExpansion.TabExpansionHost"> <summary> Class that handles the static fields supporting the ÜSFramework TabExpansion implementation </summary> </member> <member name="F:PSFramework.TabExpansion.TabExpansionHost.Scripts"> <summary> Field containing the scripts that were registered. </summary> </member> <member name="F:PSFramework.TabExpansion.TabExpansionHost.Cache"> <summary> The cache used by scripts utilizing TabExpansionPlusPlus for PSFramework </summary> </member> <member name="T:PSFramework.TabExpansion.TeppScriptMode"> <summary> Whether the user wants to use simple tepp, full tepp or auto-detect </summary> </member> <member name="F:PSFramework.TabExpansion.TeppScriptMode.Simple"> <summary> Simple mode. The scriptblock provided by the user is expected to provide a list of strings. All the rest is processed by the system </summary> </member> <member name="F:PSFramework.TabExpansion.TeppScriptMode.Full"> <summary> In full mode, the user is expected to provide the full TEPP scriptblock. </summary> </member> <member name="F:PSFramework.TabExpansion.TeppScriptMode.Auto"> <summary> In Auto-Detect mode, the system detects, whether the user intended to provide a simple mode or full mode script. This is determined by whether the scriptblock contains a parameter block or not. </summary> </member> <member name="T:PSFramework.TaskEngine.Priority"> <summary> How high the priority of the task. Higher priority tasks take precedence over low priority tasks. </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.Trivial"> <summary> This task is completely trivial and can be done whenever there is some spare time for it </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.Low"> <summary> The task is not very significant, but should be dealt with at some point </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.Medium"> <summary> Average priority task </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.High"> <summary> An important task that will take precedence over most other tasks </summary> </member> <member name="F:PSFramework.TaskEngine.Priority.Critical"> <summary> A task so critical, that it should be considered to move it to synchronous execution instead. </summary> </member> <member name="T:PSFramework.TaskEngine.PsfTask"> <summary> An individual task assigned to the maintenance engine </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Name"> <summary> The name of the task to execute. No duplciates are possible. </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Description"> <summary> A description of what the task is/should be doing </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Once"> <summary> Whether the task should be done once only </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Enabled"> <summary> Whether the task is enabled. Only enabled tasks will be executed </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Interval"> <summary> The interval at which the task should be performed </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Delay"> <summary> If the task need not be performed right away, it can be delayed, in order to prioritize more important initialization tasks </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Registered"> <summary> When was the task first registered. Duplicate registration calls will not increment this value. </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.LastExecution"> <summary> When was the task last executed. </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.Priority"> <summary> How important is this task? </summary> </member> <member name="F:PSFramework.TaskEngine.PsfTask.ScriptBlock"> <summary> The task code to execute </summary> </member> <member name="P:PSFramework.TaskEngine.PsfTask.IsDue"> <summary> Whether the task is due and should be executed </summary> </member> <member name="P:PSFramework.TaskEngine.PsfTask.Pending"> <summary> Returns, whether there are any actions still pending. The Task Engine runspace will terminate if there are no pending tasks left. </summary> </member> <member name="T:PSFramework.TaskEngine.TaskHost"> <summary> Host class providing access to resources needed to schedule and execute tasks in the background </summary> </member> <member name="F:PSFramework.TaskEngine.TaskHost.Tasks"> <summary> The register of available tasks. </summary> </member> <member name="F:PSFramework.TaskEngine.TaskHost.Cache"> <summary> Cache where modules can store cached data provided by tasks </summary> </member> <member name="P:PSFramework.TaskEngine.TaskHost.HasDueTasks"> <summary> Whether there are any due tasks </summary> </member> <member name="P:PSFramework.TaskEngine.TaskHost.HasPendingTasks"> <summary> Whether there are any tasks that still have an action pending </summary> </member> <member name="M:PSFramework.TaskEngine.TaskHost.GetNextTask(System.String[])"> <summary> Returns the next task to perform. Returns null when there are no more tasks to perform </summary> <param name="Exclusions">List of tasks not to return, even if they are ready to execute again. This avoids one misconfigured task starving all lower priority tasks</param> <returns>The next task to perform.</returns> </member> <member name="T:PSFramework.Utility.DynamicContentObject"> <summary> Class that contains a value that can be updated from another runspace </summary> </member> <member name="F:PSFramework.Utility.DynamicContentObject.Values"> <summary> The full dictionary of dynamic objects </summary> </member> <member name="M:PSFramework.Utility.DynamicContentObject.Set(System.String,System.Object)"> <summary> Sets the value of a dynamic content object, creating a new one if needed </summary> <param name="Name">The name of the object</param> <param name="Value">The value to set</param> </member> <member name="M:PSFramework.Utility.DynamicContentObject.Get(System.String)"> <summary> Returns the Dynamic Content Object under the specified name </summary> <param name="Name">The name of the object to return</param> <returns>The Dynamic Content Object selected</returns> </member> <member name="F:PSFramework.Utility.DynamicContentObject.Value"> <summary> The value stored in this object </summary> </member> <member name="F:PSFramework.Utility.DynamicContentObject.Name"> <summary> The name of the object </summary> </member> <member name="M:PSFramework.Utility.DynamicContentObject.ToString"> <summary> General string representation of the value </summary> <returns>The string representation of the value</returns> </member> <member name="M:PSFramework.Utility.DynamicContentObject.#ctor(System.String,System.Object)"> <summary> Creates a named value object that can be updated in the background </summary> <param name="Name">The name of the item</param> <param name="Value">The value of the item</param> </member> <member name="T:PSFramework.Utility.LimitedConcurrentQueue`1"> <summary> A wrapper around a queue with a limited size. Excess items will be discarded </summary> </member> <member name="P:PSFramework.Utility.LimitedConcurrentQueue`1.Size"> <summary> The maximum length of the limited queue </summary> </member> <member name="M:PSFramework.Utility.LimitedConcurrentQueue`1.Enqueue(`0)"> <summary> Enqueues an object to the collection </summary> <param name="Item">The object to enqueue</param> </member> <member name="M:PSFramework.Utility.LimitedConcurrentQueue`1.TryAdd(`0)"> <summary> Adds an item to the collection </summary> <param name="Item">The item to add</param> <returns>Whether adding the item succeeded</returns> </member> <member name="M:PSFramework.Utility.LimitedConcurrentQueue`1.#ctor"> <summary> Creates a new, empty collection limited to a defaukt nax size of 10 </summary> </member> <member name="M:PSFramework.Utility.LimitedConcurrentQueue`1.#ctor(System.Int32)"> <summary> Creates a new, empty collection limited to the specified size </summary> <param name="Size">The maximum size</param> </member> <member name="T:PSFramework.Utility.RegexHelper"> <summary> Static class that holds useful regex patterns, ready for use </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.HostName"> <summary> Pattern that checks for a valid hostname </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.HostNameEx"> <summary> Pattern that checks for valid hostnames within a larger text </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.IPv4"> <summary> Pattern that checks for a valid IPv4 address </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.IPv4Ex"> <summary> Pattern that checks for valid IPv4 addresses within a larger text </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.IPv6"> <summary> Will match a valid IPv6 address </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.IPv6Ex"> <summary> Will match any IPv6 address within a larger text </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.ComputerTarget"> <summary> Will match any string that in its entirety represents a valid target for dns- or ip-based targeting. Combination of HostName, IPv4 and IPv6 </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.Guid"> <summary> Will match a valid Guid </summary> </member> <member name="F:PSFramework.Utility.RegexHelper.GuidEx"> <summary> Will match any number of valid Guids in a larger text </summary> </member> <member name="T:PSFramework.Utility.UtilityHost"> <summary> Contains static resources of various kinds. Primarily for internal consumption. </summary> </member> <member name="F:PSFramework.Utility.UtilityHost.PrimaryRunspace"> <summary> The ID for the primary (or front end) Runspace. Used for stuff that should only happen on the user-runspace. </summary> </member> <member name="M:PSFramework.Utility.UtilityHost.IsLocalhost(System.String)"> <summary> Tests whether a given string is the local host. Does NOT use DNS resolution, DNS aliases will NOT be recognized! </summary> <param name="Name">The name to test for being local host</param> <returns>Whether the name is localhost</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.IsValidComputerTarget(System.String)"> <summary> Tests whether a given string is a valid target for targeting as a computer. Will first convert from idn name. </summary> </member> <member name="M:PSFramework.Utility.UtilityHost.IsLike(System.String,System.String,System.Boolean)"> <summary> Implement's VB's Like operator logic. </summary> </member> <member name="M:PSFramework.Utility.UtilityHost.CharListToSet(System.String)"> <summary> Converts a string of characters to a HashSet of characters. If the string contains character ranges, such as A-Z, all characters in the range are also added to the returned set of characters. </summary> <param name="charList">Character list string</param> </member> <member name="M:PSFramework.Utility.UtilityHost.CompressString(System.String)"> <summary> Compress string using default zip algorithms </summary> <param name="String">The string to compress</param> <returns>Returns a compressed string.</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.ExpandString(System.String)"> <summary> Expand a string using default zig algorithms </summary> <param name="CompressedString">The compressed string to expand</param> <returns>Returns an expanded string.</returns> </member> <member name="M:PSFramework.Utility.UtilityHost.GetExecutionContextFromTLS"> <summary> Returns the execution context for the current runspace based on the current thread. </summary> <returns>The current execution context</returns> </member> <member name="T:PSFramework.Validation.PsfValidatePatternAttribute"> <summary> Validates that each parameter argument matches the RegexPattern </summary> </member> <member name="P:PSFramework.Validation.PsfValidatePatternAttribute.RegexPattern"> <summary> Gets the Regex pattern to be used in the validation </summary> </member> <member name="P:PSFramework.Validation.PsfValidatePatternAttribute.Options"> <summary> Gets or sets the Regex options to be used in the validation </summary> </member> <member name="P:PSFramework.Validation.PsfValidatePatternAttribute.ErrorMessage"> <summary> Gets or sets the custom error message pattern that is displayed to the user. The text representation of the object being validated and the validating regex is passed as the first and second formatting parameters to the ErrorMessage formatting pattern. <example> [ValidatePattern("\s+", ErrorMessage="The text '{0}' did not pass validation of regex '{1}'")]
             </example>
             </summary>
        </member>
        <member name="M:PSFramework.Validation.PsfValidatePatternAttribute.ValidateElement(System.Object)">
            <summary>
            Validates that each parameter argument matches the RegexPattern
            </summary>
            <param name="element">object to validate</param>
            <exception cref="T:System.Management.Automation.ValidationMetadataException">if <paramref name="element"/> is not a string
             that matches the pattern
             and for invalid arguments</exception>
        </member>
        <member name="M:PSFramework.Validation.PsfValidatePatternAttribute.#ctor(System.String)">
            <summary>
            Initializes a new instance of the PsfValidatePatternAttribute class
            </summary>
            <param name="regexPattern">Pattern string to match</param>
            <exception cref="T:System.ArgumentException">for invalid arguments</exception>
        </member>
        <member name="T:PSFramework.Validation.PsfValidateScriptAttribute">
            <summary>
            Class for validating against a script block.
            </summary>
        </member>
        <member name="P:PSFramework.Validation.PsfValidateScriptAttribute.ErrorMessage">
             <summary>
             Gets or sets the custom error message that is displayed to the user.
             
             The item being validated and the validating scriptblock is passed as the first and second
             formatting argument.
             
             <example>
             [ValidateScript("$_ % 2", ErrorMessage = "The item '
{0}' did not pass validation of script '{1}'")]
             </example>
             </summary>
        </member>
        <member name="P:PSFramework.Validation.PsfValidateScriptAttribute.ScriptBlock">
            <summary>
            Gets the scriptblock to be used in the validation
            </summary>
        </member>
        <member name="M:PSFramework.Validation.PsfValidateScriptAttribute.ValidateElement(System.Object)">
            <summary>
            Validates that each parameter argument matches the scriptblock
            </summary>
            <param name="element">object to validate</param>
            <exception cref="T:System.Management.Automation.ValidationMetadataException">if <paramref name="element"/> is invalid</exception>
        </member>
        <member name="M:PSFramework.Validation.PsfValidateScriptAttribute.#ctor(System.Management.Automation.ScriptBlock)">
            <summary>
            Initializes a new instance of the ValidateScriptBlockAttribute class
            </summary>
            <param name="ScriptBlock">Scriptblock to match</param>
            <exception cref="T:System.ArgumentException">for invalid arguments</exception>
        </member>
        <member name="T:PSFramework.Validation.PsfValidateSetAttribute">
            <summary>
            Class for validating against a set of legal values. Set can be dynamically calculated.
            </summary>
        </member>
        <member name="F:PSFramework.Validation.PsfValidateSetAttribute.ScriptBlock">
            <summary>
            Gets the scriptblock to be used in the validation
            </summary>
        </member>
        <member name="F:PSFramework.Validation.PsfValidateSetAttribute.Values">
            <summary>
            Gets a list of string values to be used in the validation
            </summary>
        </member>
        <member name="F:PSFramework.Validation.PsfValidateSetAttribute.TabCompletion">
            <summary>
            Name of the Tab Completion scriptblock to use for validate set.
            </summary>
        </member>
        <member name="F:PSFramework.Validation.PsfValidateSetAttribute.ErrorMessage">
            <summary>
            Custom error message to display
            </summary>
        </member>
        <member name="M:PSFramework.Validation.PsfValidateSetAttribute.ValidateElement(System.Object)">
            <summary>
            Validates that each parameter argument matches the set of legal values
            </summary>
            <param name="element">object to validate</param>
            <exception cref="T:System.Management.Automation.ValidationMetadataException">if <paramref name="element"/> is invalid</exception>
        </member>
        <member name="M:PSFramework.Validation.PsfValidateSetAttribute.#ctor">
            <summary>
            Empty constructor for other attributes
            </summary>
        </member>
        <member name="M:PSFramework.Validation.PsfValidateSetAttribute.GetValues">
            <summary>
            Returns the values provided by the options specified.
            </summary>
            <returns>The legal values you may provide.</returns>
        </member>
    </members>
</doc>