-
Notifications
You must be signed in to change notification settings - Fork 6
/
IPreferences.xml
225 lines (225 loc) · 11.2 KB
/
IPreferences.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
<Type Name="IPreferences" FullName="Microsoft.Maui.Storage.IPreferences">
<TypeSignature Language="C#" Value="public interface IPreferences" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IPreferences" />
<TypeSignature Language="DocId" Value="T:Microsoft.Maui.Storage.IPreferences" />
<TypeSignature Language="VB.NET" Value="Public Interface IPreferences" />
<TypeSignature Language="C++ CLI" Value="public interface class IPreferences" />
<TypeSignature Language="F#" Value="type IPreferences = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
The Preferences API helps to store application preferences in a key/value store.
</summary>
<remarks>
<para>Each platform uses the platform-provided APIs for storing application/user preferences:</para>
<list type="bullet">
<item>
<description>iOS: NSUserDefaults</description>
</item>
<item>
<description>Android: SharedPreferences</description>
</item>
<item>
<description>Windows: ApplicationDataContainer</description>
</item>
</list>
</remarks>
</Docs>
<Members>
<Member MemberName="Clear">
<MemberSignature Language="C#" Value="public void Clear (string? sharedName = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Clear(string sharedName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Storage.IPreferences.Clear(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Clear (Optional sharedName As String = Nothing)" />
<MemberSignature Language="F#" Value="abstract member Clear : string -> unit" Usage="iPreferences.Clear sharedName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sharedName" Type="System.String" />
</Parameters>
<Docs>
<param name="sharedName">Shared container name.</param>
<summary>
Clears all keys and values.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContainsKey">
<MemberSignature Language="C#" Value="public bool ContainsKey (string key, string? sharedName = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ContainsKey(string key, string sharedName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Storage.IPreferences.ContainsKey(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function ContainsKey (key As String, Optional sharedName As String = Nothing) As Boolean" />
<MemberSignature Language="F#" Value="abstract member ContainsKey : string * string -> bool" Usage="iPreferences.ContainsKey (key, sharedName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="sharedName" Type="System.String">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="key">The key to check.</param>
<param name="sharedName">Shared container name.</param>
<summary>
Checks for the existence of a given key.
</summary>
<returns>
<see langword="true" /> if the key exists in the preferences, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Get<T>">
<MemberSignature Language="C#" Value="public T Get<T> (string key, T defaultValue, string? sharedName = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !!T Get<T>(string key, !!T defaultValue, string sharedName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Storage.IPreferences.Get``1(System.String,``0,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function Get(Of T) (key As String, defaultValue As T, Optional sharedName As String = Nothing) As T" />
<MemberSignature Language="F#" Value="abstract member Get : string * 'T * string -> 'T" Usage="iPreferences.Get (key, defaultValue, sharedName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="defaultValue" Type="T" />
<Parameter Name="sharedName" Type="System.String">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">The type of the object stored for this preference.</typeparam>
<param name="key">The key to retrieve the value for.</param>
<param name="defaultValue">The default value to return when no existing value for <paramref name="key" /> exists.</param>
<param name="sharedName">Shared container name.</param>
<summary>
Gets the value for a given key, or the default specified if the key does not exist.
</summary>
<returns>Value for the given key, or the value in <paramref name="defaultValue" /> if it does not exist.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="public void Remove (string key, string? sharedName = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Remove(string key, string sharedName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Storage.IPreferences.Remove(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Remove (key As String, Optional sharedName As String = Nothing)" />
<MemberSignature Language="F#" Value="abstract member Remove : string * string -> unit" Usage="iPreferences.Remove (key, sharedName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="sharedName" Type="System.String">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="key">The key to remove.</param>
<param name="sharedName">Shared container name.</param>
<summary>
Removes a key and its associated value if it exists.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Set<T>">
<MemberSignature Language="C#" Value="public void Set<T> (string key, T value, string? sharedName = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Set<T>(string key, !!T value, string sharedName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Storage.IPreferences.Set``1(System.String,``0,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Set(Of T) (key As String, value As T, Optional sharedName As String = Nothing)" />
<MemberSignature Language="F#" Value="abstract member Set : string * 'T * string -> unit" Usage="iPreferences.Set (key, value, sharedName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="value" Type="T" />
<Parameter Name="sharedName" Type="System.String">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">Type of the object that is stored in this preference.</typeparam>
<param name="key">The key to set the value for.</param>
<param name="value">Value to set.</param>
<param name="sharedName">Shared container name.</param>
<summary>
Sets a value for a given key.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>