aboutsummaryrefslogtreecommitdiff
path: root/VNLib.Plugins.Extensions.Validation/VNLib.Plugins.Extensions.Validation.xml
blob: a5ebbcb1855e7267fb20df958c6d367ac6a1f271 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>VNLib.Plugins.Extensions.Validation</name>
    </assembly>
    <members>
        <member name="T:VNLib.Plugins.Extensions.Validation.ValErrWebMessage">
            <summary>
            Extends the <see cref="T:VNLib.Plugins.WebMessage"/> class with provisions for a collection of validations
            </summary>
        </member>
        <member name="P:VNLib.Plugins.Extensions.Validation.ValErrWebMessage.Errors">
            <summary>
            A collection of error messages to send to clients
            </summary>
        </member>
        <member name="T:VNLib.Plugins.Extensions.Validation.ValidationExtensions">
            <summary>
            Defines extenstion methods for <see cref="T:FluentValidation.IRuleBuilder`2"/>
            </summary>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.GetErrorsAsCollection(FluentValidation.Results.ValidationResult)">
            <summary>
            Gets a collection of Json-serializable validation errors
            </summary>
            <param name="result"></param>
            <returns>A collection of json errors to return to a user</returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.PhoneNumber``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Tests the the property against <see cref="F:VNLib.Plugins.Extensions.Validation.ValidationExtensions.PhoneRegex"/> 
            to determine if the string matches the proper phone number form
            </summary>
            <typeparam name="T"></typeparam>
            <param name="validator"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.EmptyPhoneNumber``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Tests the the property against <see cref="F:VNLib.Plugins.Extensions.Validation.ValidationExtensions.PhoneRegex"/> 
            to determine if the string matches the proper phone number form, or allows emtpy strings
            </summary>
            <typeparam name="T"></typeparam>
            <param name="validator"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.SpecialCharacters``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Checks a string against <see cref="!:Statics.SpecialCharacters"/>.
            If the string is null or empty, it is allowed.
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.IllegalCharacters``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Checks a string against <see cref="!:Statics.IllegalChars"/>.
            If the string is null or empty, it is allowed.
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.Alpha``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Makes sure a field contains at least 1 character a-Z
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.AlphaOnly``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Determines if all characters are only a-Z (allows whitespace)
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.Numeric``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Makes sure a field contains at least 1 numeral
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.NumericOnly``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Determines if all characters are only 0-9 (not whitespace is allowed)
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.AlphaNumeric``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Makes sure the field contains at least 1 alpha numeric character (whitespace included)
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.AlphaNumericOnly``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Determines if all characters are only alpha-numeric (whitespace allowed)
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.Password``1(FluentValidation.IRuleBuilder{``0,System.String})">
            <summary>
            Tests the string against the password regular expression to determine if the 
            value meets the basic password requirements
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <returns></returns>
        </member>
        <member name="M:VNLib.Plugins.Extensions.Validation.ValidationExtensions.Length``1(FluentValidation.IRuleBuilder{``0,System.String},System.Range)">
            <summary>
            Defines a length validator on the current rule builder, but only for string properties.
            Validation will fail if the length of the string is outside of the specified range.
            The range is inclusive
            </summary>
            <typeparam name="T"></typeparam>
            <param name="builder"></param>
            <param name="lengthRange">The length range of the specified string</param>
            <returns></returns>
        </member>
    </members>
</doc>