Difference between revisions of "Application:openUrl"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
 
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[Application]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Opens the given URL (Universal Resource Locator) in the appropriate application. URL can be one of the ''http:'', ''https:'', ''tel:'', or ''mailto:'' schemes.
Opens the given URL (Universal Resource Locator) in the appropriate application. URL can be one of the `http:`, `https:`, `tel:`, or `mailto:` schemes.<br />
+
 
<br />
+
The following example opens a web page in the browser:
The following example opens a web page in the browser:<br />
+
<syntaxhighlight lang="lua">
&lt;pre&gt;&lt;code&gt;<br />
+
application:openUrl("http://www.giderosmobile.com")
application:openUrl("http://www.giderosmobile.com")<br />
+
</syntaxhighlight>
<br />
+
 
&lt;/code&gt;&lt;/pre&gt;<br />
+
 
If `mailto:` scheme is specified, the user&#039;s e-mail client will be used to open a composer window containing the options specified in the URL.<br />
+
If ''mailto:'' scheme is specified, the user's e-mail client will be used to open a composer window containing the options specified in the URL:
For example, the following URL contains a recipient (user@foo.com), a subject (Test), and a message body (Just a test):<br />
+
<syntaxhighlight lang="lua">
&lt;pre&gt;&lt;code&gt;<br />
+
-- the following URL contains a recipient (user@foo.com), a subject (Test), and a message body (Just a test)
application:openUrl(&quot;mailto:user@foo.com?subject=Test&amp;body=Just a test&quot;)<br />
+
application:openUrl("mailto:user@foo.com?subject=Test&body=Just a test")
<br />
+
</syntaxhighlight>
&lt;/code&gt;&lt;/pre&gt;<br />
+
 
Or to call a number:<br />
+
 
&lt;pre&gt;&lt;code&gt;<br />
+
To call a number:
application:openUrl(&quot;tel:555-123-4567&quot;)<br />
+
<syntaxhighlight lang="lua">
<br />
+
application:openUrl("tel:555-123-4567")
&lt;/code&gt;&lt;/pre&gt;<br />
+
</syntaxhighlight>
<source lang="lua">
+
 
Application:openUrl(url)
 
</source>
 
 
=== Parameters ===
 
=== Parameters ===
'''url''': (string) url to open <br/>
+
'''url''': (string) url to open
 +
 
 +
{{Application}}

Latest revision as of 17:56, 12 July 2023

Available since: Gideros 2011.6
Class: Application

Description

Opens the given URL (Universal Resource Locator) in the appropriate application. URL can be one of the http:, https:, tel:, or mailto: schemes.

The following example opens a web page in the browser:

application:openUrl("http://www.giderosmobile.com")


If mailto: scheme is specified, the user's e-mail client will be used to open a composer window containing the options specified in the URL:

-- the following URL contains a recipient (user@foo.com), a subject (Test), and a message body (Just a test)
application:openUrl("mailto:user@foo.com?subject=Test&body=Just a test")


To call a number:

application:openUrl("tel:555-123-4567")

Parameters

url: (string) url to open