dd92f5bc1b9e2277b15a548975e990b1946647fd
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.AspNetCore.Components.Authorization</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState">\r
8             <summary>\r
9             Provides information about the currently authenticated user, if any.\r
10             </summary>\r
11         </member>\r
12         <member name="M:Microsoft.AspNetCore.Components.Authorization.AuthenticationState.#ctor(System.Security.Claims.ClaimsPrincipal)">\r
13             <summary>\r
14             Constructs an instance of <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/>.\r
15             </summary>\r
16             <param name="user">A <see cref="T:System.Security.Claims.ClaimsPrincipal"/> representing the user.</param>\r
17         </member>\r
18         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthenticationState.User">\r
19             <summary>\r
20             Gets a <see cref="T:System.Security.Claims.ClaimsPrincipal"/> that describes the current user.\r
21             </summary>\r
22         </member>\r
23         <member name="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider">\r
24             <summary>\r
25             Provides information about the authentication state of the current user.\r
26             </summary>\r
27         </member>\r
28         <member name="M:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider.GetAuthenticationStateAsync">\r
29             <summary>\r
30             Asynchronously gets an <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/> that describes the current user.\r
31             </summary>\r
32             <returns>A task that, when resolved, gives an <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/> instance that describes the current user.</returns>\r
33         </member>\r
34         <member name="E:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider.AuthenticationStateChanged">\r
35             <summary>\r
36             An event that provides notification when the <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/>\r
37             has changed. For example, this event may be raised if a user logs in or out.\r
38             </summary>\r
39         </member>\r
40         <member name="M:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider.NotifyAuthenticationStateChanged(System.Threading.Tasks.Task{Microsoft.AspNetCore.Components.Authorization.AuthenticationState})">\r
41             <summary>\r
42             Raises the <see cref="E:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider.AuthenticationStateChanged"/> event.\r
43             </summary>\r
44             <param name="task">A <see cref="T:System.Threading.Tasks.Task"/> that supplies the updated <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/>.</param>\r
45         </member>\r
46         <member name="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateChangedHandler">\r
47             <summary>\r
48             A handler for the <see cref="E:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider.AuthenticationStateChanged"/> event.\r
49             </summary>\r
50             <param name="task">A <see cref="T:System.Threading.Tasks.Task"/> that supplies the updated <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/>.</param>\r
51         </member>\r
52         <member name="T:Microsoft.AspNetCore.Components.Authorization.AuthorizeRouteView">\r
53              <summary>\r
54              Combines the behaviors of <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthorizeView"/> and <see cref="T:Microsoft.AspNetCore.Components.RouteView"/>,\r
55              so that it displays the page matching the specified route but only if the user\r
56              is authorized to see it.\r
57             \r
58              Additionally, this component supplies a cascading parameter of type <see cref="T:System.Threading.Tasks.Task`1"/>,\r
59              which makes the user's current authentication state available to descendants.\r
60              </summary>\r
61         </member>\r
62         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeRouteView.NotAuthorized">\r
63             <summary>\r
64             The content that will be displayed if the user is not authorized.\r
65             </summary>\r
66         </member>\r
67         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeRouteView.Authorizing">\r
68             <summary>\r
69             The content that will be displayed while asynchronous authorization is in progress.\r
70             </summary>\r
71         </member>\r
72         <member name="M:Microsoft.AspNetCore.Components.Authorization.AuthorizeRouteView.Render(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder)">\r
73             <inheritdoc />\r
74         </member>\r
75         <member name="T:Microsoft.AspNetCore.Components.Authorization.AuthorizeView">\r
76             <summary>\r
77             Displays differing content depending on the user's authorization status.\r
78             </summary>\r
79         </member>\r
80         <member name="M:Microsoft.AspNetCore.Components.Authorization.AuthorizeView.#ctor">\r
81             <summary>\r
82             Constructs an instance of <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthorizeView"/>.\r
83             </summary>\r
84         </member>\r
85         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeView.Policy">\r
86             <summary>\r
87             The policy name that determines whether the content can be displayed.\r
88             </summary>\r
89         </member>\r
90         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeView.Roles">\r
91             <summary>\r
92             A comma delimited list of roles that are allowed to display the content.\r
93             </summary>\r
94         </member>\r
95         <member name="M:Microsoft.AspNetCore.Components.Authorization.AuthorizeView.GetAuthorizeData">\r
96             <summary>\r
97             Gets the data used for authorization.\r
98             </summary>\r
99         </member>\r
100         <member name="T:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore">\r
101             <summary>\r
102             A base class for components that display differing content depending on the user's authorization status.\r
103             </summary>\r
104         </member>\r
105         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore.ChildContent">\r
106             <summary>\r
107             The content that will be displayed if the user is authorized.\r
108             </summary>\r
109         </member>\r
110         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore.NotAuthorized">\r
111             <summary>\r
112             The content that will be displayed if the user is not authorized.\r
113             </summary>\r
114         </member>\r
115         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore.Authorized">\r
116             <summary>\r
117             The content that will be displayed if the user is authorized.\r
118             If you specify a value for this parameter, do not also specify a value for <see cref="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore.ChildContent"/>.\r
119             </summary>\r
120         </member>\r
121         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore.Authorizing">\r
122             <summary>\r
123             The content that will be displayed while asynchronous authorization is in progress.\r
124             </summary>\r
125         </member>\r
126         <member name="P:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore.Resource">\r
127             <summary>\r
128             The resource to which access is being controlled.\r
129             </summary>\r
130         </member>\r
131         <member name="M:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore.BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder)">\r
132             <inheritdoc />\r
133         </member>\r
134         <member name="M:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore.OnParametersSetAsync">\r
135             <inheritdoc />\r
136         </member>\r
137         <member name="M:Microsoft.AspNetCore.Components.Authorization.AuthorizeViewCore.GetAuthorizeData">\r
138             <summary>\r
139             Gets the data required to apply authorization rules.\r
140             </summary>\r
141         </member>\r
142         <member name="T:Microsoft.AspNetCore.Components.Authorization.IHostEnvironmentAuthenticationStateProvider">\r
143             <summary>\r
144             An interface implemented by <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider"/> classes that can receive authentication\r
145             state information from the host environment.\r
146             </summary>\r
147         </member>\r
148         <member name="M:Microsoft.AspNetCore.Components.Authorization.IHostEnvironmentAuthenticationStateProvider.SetAuthenticationState(System.Threading.Tasks.Task{Microsoft.AspNetCore.Components.Authorization.AuthenticationState})">\r
149             <summary>\r
150             Supplies updated authentication state data to the <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider"/>.\r
151             </summary>\r
152             <param name="authenticationStateTask">A task that resolves with the updated <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/>.</param>\r
153         </member>\r
154         <member name="P:Microsoft.AspNetCore.Components.Authorization.CascadingAuthenticationState.ChildContent">\r
155             <summary>\r
156             The content to which the authentication state should be provided.\r
157             </summary>\r
158         </member>\r
159     </members>\r
160 </doc>\r