/
Permissions.xml
132 lines (132 loc) · 9.58 KB
/
Permissions.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
<Type Name="Permissions" FullName="Microsoft.Maui.ApplicationModel.Permissions">
<TypeSignature Language="C#" Value="public static class Permissions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit Permissions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Maui.ApplicationModel.Permissions" />
<TypeSignature Language="VB.NET" Value="Public Class Permissions" />
<TypeSignature Language="C++ CLI" Value="public ref class Permissions abstract sealed" />
<TypeSignature Language="F#" Value="type Permissions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The Permissions API provides the ability to check and request runtime permissions.
</summary>
<remarks />
</Docs>
<Members>
<Member MemberName="CheckStatusAsync<TPermission>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus> CheckStatusAsync<TPermission> () where TPermission : Microsoft.Maui.ApplicationModel.Permissions.BasePermission, new();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<valuetype Microsoft.Maui.ApplicationModel.PermissionStatus> CheckStatusAsync<.ctor (class Microsoft.Maui.ApplicationModel.Permissions/BasePermission) TPermission>() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.Permissions.CheckStatusAsync``1" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CheckStatusAsync(Of TPermission As {Permissions.BasePermissionNew}) () As Task(Of PermissionStatus)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TPermission>
 where TPermission : Microsoft::Maui::ApplicationModel::Permissions::BasePermissiongcnew() static System::Threading::Tasks::Task<Microsoft::Maui::ApplicationModel::PermissionStatus> ^ CheckStatusAsync();" />
<MemberSignature Language="F#" Value="static member CheckStatusAsync : unit -> System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus> (requires 'Permission :> Microsoft.Maui.ApplicationModel.Permissions.BasePermission and 'Permission : (new : unit -> 'Permission))" Usage="Microsoft.Maui.ApplicationModel.Permissions.CheckStatusAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TPermission">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<BaseTypeName>Microsoft.Maui.ApplicationModel.Permissions+BasePermission</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="TPermission">The permission type to check.</typeparam>
<summary>
Retrieves the current status of the permission.
</summary>
<returns>A <see cref="T:Microsoft.Maui.ApplicationModel.PermissionStatus" /> value indicating the current status of the permission.</returns>
<remarks>
Will throw <see cref="T:Microsoft.Maui.ApplicationModel.PermissionException" /> if a required entry was not found in the application manifest.
Not all permissions require a manifest entry.
</remarks>
<exception cref="T:Microsoft.Maui.ApplicationModel.PermissionException">Thrown if a required entry was not found in the application manifest.</exception>
</Docs>
</Member>
<Member MemberName="RequestAsync<TPermission>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus> RequestAsync<TPermission> () where TPermission : Microsoft.Maui.ApplicationModel.Permissions.BasePermission, new();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<valuetype Microsoft.Maui.ApplicationModel.PermissionStatus> RequestAsync<.ctor (class Microsoft.Maui.ApplicationModel.Permissions/BasePermission) TPermission>() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.Permissions.RequestAsync``1" />
<MemberSignature Language="VB.NET" Value="Public Shared Function RequestAsync(Of TPermission As {Permissions.BasePermissionNew}) () As Task(Of PermissionStatus)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TPermission>
 where TPermission : Microsoft::Maui::ApplicationModel::Permissions::BasePermissiongcnew() static System::Threading::Tasks::Task<Microsoft::Maui::ApplicationModel::PermissionStatus> ^ RequestAsync();" />
<MemberSignature Language="F#" Value="static member RequestAsync : unit -> System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus> (requires 'Permission :> Microsoft.Maui.ApplicationModel.Permissions.BasePermission and 'Permission : (new : unit -> 'Permission))" Usage="Microsoft.Maui.ApplicationModel.Permissions.RequestAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TPermission">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<BaseTypeName>Microsoft.Maui.ApplicationModel.Permissions+BasePermission</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="TPermission">The permission type to check.</typeparam>
<summary>
Requests the permission from the user for this application.
</summary>
<returns>A <see cref="T:Microsoft.Maui.ApplicationModel.PermissionStatus" /> value indicating the result of this permission request.</returns>
<remarks>
Will throw <see cref="T:Microsoft.Maui.ApplicationModel.PermissionException" /> if a required entry was not found in the application manifest.
Not all permissions require a manifest entry.
</remarks>
<exception cref="T:Microsoft.Maui.ApplicationModel.PermissionException">Thrown if a required entry was not found in the application manifest.</exception>
</Docs>
</Member>
<Member MemberName="ShouldShowRationale<TPermission>">
<MemberSignature Language="C#" Value="public static bool ShouldShowRationale<TPermission> () where TPermission : Microsoft.Maui.ApplicationModel.Permissions.BasePermission, new();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool ShouldShowRationale<.ctor (class Microsoft.Maui.ApplicationModel.Permissions/BasePermission) TPermission>() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.Permissions.ShouldShowRationale``1" />
<MemberSignature Language="VB.NET" Value="Public Shared Function ShouldShowRationale(Of TPermission As {Permissions.BasePermissionNew}) () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TPermission>
 where TPermission : Microsoft::Maui::ApplicationModel::Permissions::BasePermissiongcnew() static bool ShouldShowRationale();" />
<MemberSignature Language="F#" Value="static member ShouldShowRationale : unit -> bool (requires 'Permission :> Microsoft.Maui.ApplicationModel.Permissions.BasePermission and 'Permission : (new : unit -> 'Permission))" Usage="Microsoft.Maui.ApplicationModel.Permissions.ShouldShowRationale " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TPermission">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<BaseTypeName>Microsoft.Maui.ApplicationModel.Permissions+BasePermission</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="TPermission">The permission type to check.</typeparam>
<summary>
Determines if an educational UI should be displayed explaining to the user how the permission will be used in the application.
</summary>
<returns>
<see langword="true" /> if the user has denied or disabled the permission in the past, else <see langword="false" />.</returns>
<remarks>Only used on Android, other platforms will always return <see langword="false" />.</remarks>
</Docs>
</Member>
</Members>
</Type>