<doc>
	<legacy_id></legacy_id>
	<name>urlProgress</name>
	<type>message</type>

	<syntax>
		<example>urlProgress <i>url,</i> <i>status</i>, [<i>message</i>, [<i>bytesTotal</i>]]</example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Sent when updates on ongoing url requests are communicated.</summary>

	<examples>
<example><p>on urlProgress pUrl, pStatus</p><p>   if pStatus is &quot;downloaded&quot; then</p><p>      answer &quot;Finished downloading&quot; with &quot;Okay&quot;</p><p>   end if</p><p>end urlProgress</p></example>
<example><p>on urlProgress pUrl, pStatus, pMessage</p><p>   if pStatus is &quot;error&quot; then</p><p>      answer &quot;Encountered Error:&quot; &amp;&amp; pMessage with &quot;Okay&quot;</p><p>   end if</p><p>end urlProgress</p></example>
	</examples>

	<history>
		<introduced version="4.6.1">Added.</introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		
	</history>

	<objects>
	</objects>

	<platforms>
		<ios/>
		<android/>
	</platforms>

	<classes>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
	</classification>

	<references>
		<command tag="put">put Command</command>
		<command tag="post">post Command</command>
		<command tag="load">load Command</command>
	</references>

	<description>
	<overview>Sent when updates on ongoing url requests are communicated. This message is periodically sent to the object whose script initiated the operation.</overview>

		<parameters>
  <parameter>
    <name>url</name>
    <description>The name of the url for which a message is being sent.</description>
  </parameter>
  <parameter>
    <name>status</name>
    <description>The type of update message being sent. One of:</description>
    <options title="">
      <option>
        <item>contacted</item>
        <description>The server has been contacted.</description>
      </option>
      <option>
        <item>requested</item>
        <description>A request was made to the URL.</description>
      </option>
      <option>
        <item>loading</item>
        <description>Data is being downloaded.</description>
      </option>
      <option>
        <item>uploading</item>
        <description>Data is being uploaded to the server.</description>
      </option>
      <option>
        <item>downloaded</item>
        <description>Data has finished downloading.</description>
      </option>
      <option>
        <item>uploaded</item>
        <description>Data has finished uploading.</description>
      </option>
      <option>
        <item>error</item>
        <description>An error occurred.</description>
      </option>
    </options>
  </parameter>
  <parameter>
    <name>message</name>
    <description>A message sent with some of the status parameters. One of:</description>
    <options title="">
      <option>
        <item>bytesReceived</item>
        <description>Sent when the status parameter is either 'loading' or 'uploading'.</description>
      </option>
      <option>
        <item>erroMessage</item>
        <description>Sent when the status parameter is 'error'.</description>
      </option>
    </options>
  </parameter>
  <parameter>
    <name>bytesTotal</name>
    <description>Is empty if the web server does not send the total data size.</description>
  </parameter>
		</parameters>

	<value></value>
	<comments></comments>
	</description>
</doc>