-
Notifications
You must be signed in to change notification settings - Fork 4
/
Permissions+BasePermission.xml
157 lines (157 loc) · 9.78 KB
/
Permissions+BasePermission.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
<Type Name="Permissions+BasePermission" FullName="Microsoft.Maui.ApplicationModel.Permissions+BasePermission">
<TypeSignature Language="C#" Value="public abstract class Permissions.BasePermission" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi abstract beforefieldinit Permissions/BasePermission extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Maui.ApplicationModel.Permissions.BasePermission" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Permissions.BasePermission" />
<TypeSignature Language="C++ CLI" Value="public: ref class Permissions::BasePermission abstract" />
<TypeSignature Language="F#" Value="type Permissions.BasePermission = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents the abstract base class for all permissions.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BasePermission ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.Permissions.BasePermission.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 BasePermission();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Maui.ApplicationModel.Permissions.BasePermission" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CheckStatusAsync">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus> CheckStatusAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<valuetype Microsoft.Maui.ApplicationModel.PermissionStatus> CheckStatusAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.Permissions.BasePermission.CheckStatusAsync" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function CheckStatusAsync () As Task(Of PermissionStatus)" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract System::Threading::Tasks::Task<Microsoft::Maui::ApplicationModel::PermissionStatus> ^ CheckStatusAsync();" />
<MemberSignature Language="F#" Value="abstract member CheckStatusAsync : unit -> System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus>" Usage="basePermission.CheckStatusAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Retrieves the current status of this permission.
</summary>
<returns>A <see cref="T:Microsoft.Maui.ApplicationModel.PermissionStatus" /> value indicating the current status of this 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="EnsureDeclared">
<MemberSignature Language="C#" Value="public abstract void EnsureDeclared ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void EnsureDeclared() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.Permissions.BasePermission.EnsureDeclared" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Sub EnsureDeclared ()" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract void EnsureDeclared();" />
<MemberSignature Language="F#" Value="abstract member EnsureDeclared : unit -> unit" Usage="basePermission.EnsureDeclared " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Ensures that a required entry matching this permission is found in the application manifest file.
</summary>
<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">
<MemberSignature Language="C#" Value="public abstract System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus> RequestAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<valuetype Microsoft.Maui.ApplicationModel.PermissionStatus> RequestAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.Permissions.BasePermission.RequestAsync" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function RequestAsync () As Task(Of PermissionStatus)" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract System::Threading::Tasks::Task<Microsoft::Maui::ApplicationModel::PermissionStatus> ^ RequestAsync();" />
<MemberSignature Language="F#" Value="abstract member RequestAsync : unit -> System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus>" Usage="basePermission.RequestAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.PermissionStatus></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Requests this 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">
<MemberSignature Language="C#" Value="public abstract bool ShouldShowRationale ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ShouldShowRationale() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.Permissions.BasePermission.ShouldShowRationale" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function ShouldShowRationale () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract bool ShouldShowRationale();" />
<MemberSignature Language="F#" Value="abstract member ShouldShowRationale : unit -> bool" Usage="basePermission.ShouldShowRationale " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Determines if an educational UI should be displayed explaining to the user how this permission will be used in the application.
</summary>
<returns>
<see langword="true" /> if the user has denied or disabled this 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>