-
Notifications
You must be signed in to change notification settings - Fork 4
/
ILauncher.xml
151 lines (151 loc) · 8.98 KB
/
ILauncher.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
<Type Name="ILauncher" FullName="Microsoft.Maui.ApplicationModel.ILauncher">
<TypeSignature Language="C#" Value="public interface ILauncher" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ILauncher" />
<TypeSignature Language="DocId" Value="T:Microsoft.Maui.ApplicationModel.ILauncher" />
<TypeSignature Language="VB.NET" Value="Public Interface ILauncher" />
<TypeSignature Language="C++ CLI" Value="public interface class ILauncher" />
<TypeSignature Language="F#" Value="type ILauncher = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
The Launcher API enables an application to open a URI by the system.
This is often used when deep linking into another application's custom URI schemes.
</summary>
<remarks>
<para>If you are looking to open the browser to a website then you should refer to the <see cref="T:Microsoft.Maui.ApplicationModel.IBrowser" /> API.</para>
<para>On iOS 9+, you will have to specify the <c>LSApplicationQueriesSchemes</c> key in the <c>info.plist</c> file with URI schemes you want to query from your app.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="CanOpenAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> CanOpenAsync (Uri uri);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> CanOpenAsync(class System.Uri uri) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.ILauncher.CanOpenAsync(System.Uri)" />
<MemberSignature Language="VB.NET" Value="Public Function CanOpenAsync (uri As Uri) As Task(Of Boolean)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task<bool> ^ CanOpenAsync(Uri ^ uri);" />
<MemberSignature Language="F#" Value="abstract member CanOpenAsync : Uri -> System.Threading.Tasks.Task<bool>" Usage="iLauncher.CanOpenAsync uri" />
<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<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.Uri" />
</Parameters>
<Docs>
<param name="uri">URI scheme to query.</param>
<summary>
Queries if the device supports opening the given URI scheme.
</summary>
<returns>
<see langword="true" /> if opening is supported, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.UriFormatException">Thrown when <paramref name="uri" /> is malformed.</exception>
</Docs>
</Member>
<Member MemberName="OpenAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> OpenAsync (Microsoft.Maui.ApplicationModel.OpenFileRequest request);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> OpenAsync(class Microsoft.Maui.ApplicationModel.OpenFileRequest request) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.ILauncher.OpenAsync(Microsoft.Maui.ApplicationModel.OpenFileRequest)" />
<MemberSignature Language="VB.NET" Value="Public Function OpenAsync (request As OpenFileRequest) As Task(Of Boolean)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task<bool> ^ OpenAsync(Microsoft::Maui::ApplicationModel::OpenFileRequest ^ request);" />
<MemberSignature Language="F#" Value="abstract member OpenAsync : Microsoft.Maui.ApplicationModel.OpenFileRequest -> System.Threading.Tasks.Task<bool>" Usage="iLauncher.OpenAsync request" />
<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<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="request" Type="Microsoft.Maui.ApplicationModel.OpenFileRequest" />
</Parameters>
<Docs>
<param name="request">Request that contains information on the file to open.</param>
<summary>
Requests to open a file in an application based on content type.
</summary>
<returns>
<see langword="true" /> if the file was opened, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OpenAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> OpenAsync (Uri uri);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> OpenAsync(class System.Uri uri) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.ILauncher.OpenAsync(System.Uri)" />
<MemberSignature Language="VB.NET" Value="Public Function OpenAsync (uri As Uri) As Task(Of Boolean)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task<bool> ^ OpenAsync(Uri ^ uri);" />
<MemberSignature Language="F#" Value="abstract member OpenAsync : Uri -> System.Threading.Tasks.Task<bool>" Usage="iLauncher.OpenAsync uri" />
<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<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.Uri" />
</Parameters>
<Docs>
<param name="uri">URI to open.</param>
<summary>
Opens the app specified by the URI scheme.
</summary>
<returns>
<see langword="true" /> if the URI was opened, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.UriFormatException">Thrown when <paramref name="uri" /> is malformed.</exception>
</Docs>
</Member>
<Member MemberName="TryOpenAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> TryOpenAsync (Uri uri);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> TryOpenAsync(class System.Uri uri) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.ApplicationModel.ILauncher.TryOpenAsync(System.Uri)" />
<MemberSignature Language="VB.NET" Value="Public Function TryOpenAsync (uri As Uri) As Task(Of Boolean)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task<bool> ^ TryOpenAsync(Uri ^ uri);" />
<MemberSignature Language="F#" Value="abstract member TryOpenAsync : Uri -> System.Threading.Tasks.Task<bool>" Usage="iLauncher.TryOpenAsync uri" />
<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<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.Uri" />
</Parameters>
<Docs>
<param name="uri">URI to try and open.</param>
<summary>
First checks if the provided URI is supported, then opens the app specified by the URI.
</summary>
<returns>
<see langword="true" /> if the URI was opened, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.UriFormatException">Thrown when <paramref name="uri" /> is malformed.</exception>
</Docs>
</Member>
</Members>
</Type>