<doc>
	<legacy_id></legacy_id>
	<name>mobileCreateLocalNotification</name>
	<type>command</type>

	<syntax>
		<example>mobileCreateLocalNotification <i>alertBody</i>, <i>alertButtonMessage</i>, <i>alertPayload</i>, <i>alertTime</i>, <i>playSound</i> [, <i>badgeValue</i>]</example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Schedules a new Local Notification with the operating system.</summary>

	<examples>
<example>mobileCreateLocalNotification &quot;The Alert Body&quot;, &quot;Show Me&quot;, &quot;It is time to do some Exercise&quot;, the seconds + 10, true, &quot;1&quot;</example>
	</examples>

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

	<objects>
	</objects>

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

	<classes>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
		<category>Networks &amp; Communication</category>
		<category>Standalone Applications</category>
	</classification>

	<references>
		<command tag="mobileCancelLocalNotification">mobileCancelLocalNotification Command</command>
		<command tag="mobileCancelAllLocalNotifications">mobileCancelAllLocalNotifications Command</command>
	</references>

	<description>
	<overview>Use the <b>mobileCreateLocalNotification</b> <glossary tag="command">command</glossary> to schedule a Local Notification with the operating system from within a <object tag="stack">stack on iOS or Android</object>. </overview>

		<parameters>
  <parameter>
    <name>alertBody</name>
    <description>The text that is to be displayed on the notification dialog that is raised when the application is not running.</description>
  </parameter>
  <parameter>
    <name>alertButtonMessage</name>
    <description>The button text on the notification dialog that is to appear on the button that launches the application, when the application is not running.</description>
  </parameter>
  <parameter>
    <name>alertPayload</name>
    <description>A text payload that can be sent with the notification request. This payload is presented to the user via the <message tag="localNotificationReceived">localNotificationReceived</message> message.</description>
  </parameter>
  <parameter>
    <name>alertTime</name>
    <description>The time at which the alert is to be sent to the application. This parameter needs to be set in seconds and is the number of seconds since the UNIX Epoch, at which the notification should be triggered.</description>
  </parameter>
  <parameter>
    <name>playSound</name>
    <description>A boolean to indicate if a sound is to be played when the alert is received.</description>
  </parameter>
  <parameter>
    <name>badgeValue</name>
    <description>The number value to which the badge of the application logo is to be set. 0 hides the badge. &gt;0 displays the value on the badge.</description>
  </parameter>		</parameters>

	<value>The id of the local notification that is created is returned by the <function tag="result">result</function> function.</value>
	<comments>This command schedules Local Notifications with the iOS or Android operating sytem and delivers the <i>alertPayload</i> to the application. The <i>alertPayload</i> is delivered using the <message tag="localNotificationReceived">localNotificationReceived</message> message.</comments>
	</description>
</doc>