<doc>
	<legacy_id></legacy_id>
	<name>mobilePurchaseState</name>
	<type>function</type>

	<syntax>
		<example>mobilePurchaseState(<i>purchaseID</i>)</example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Returns the status of an active purchase.</summary>

	<examples>
<example>put mobilePurchaseState(tPurchaseID) into tPurchaseState</example>
<example><p>if mobilePurchaseState(tPurchaseID) is &quot;initialized&quot; then</p><p>   updateProperties</p><p>end if</p></example>
	</examples>

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

	<objects>
	</objects>

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

	<classes>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
	</classification>

	<references>
		<function tag="mobileCanMakePurchase">mobileCanMakePurchase Function</function>
		<function tag="mobilePurchases">mobilePurchases Function</function>
		<function tag="mobilePurchaseError">mobilePurchaseError Function</function>
		<function tag="mobilePurchaseGet">mobilePurchaseGet Function</function>
		<command tag="mobileEnablePurchaseUpdates">mobileEnablePurchaseUpdates Command</command>
		<command tag="mobileDisablePurchaseUpdates">mobileDisablePurchaseUpdates Command</command>
		<command tag="mobileRestorePurchases">mobileRestorePurchases Command</command>
		<command tag="mobilePurchaseCreate">mobilePurchaseCreate Command</command>
		<command tag="mobilePurchaseSet">mobilePurchaseSet Command</command>
		<command tag="mobilePurchaseSendRequest">mobilePurchaseSendRequest Command</command>
		<command tag="mobilePurchaseConfirmDelivery">mobilePurchaseConfirmDelivery Command</command>
		<command tag="mobilePurchaseVerify">mobilePurchaseVerify Command</command>
		<message tag="purchaseStateUpdate">purchaseStateUpdate Message</message>
	</references>

	<description>
	<overview>Use the <b>mobilePurchaseState</b> function to retrieve the status of a purchase.</overview>

		<parameters>
<parameter>
    <name>purchaseID</name>
    <description>a numeric purchase identifier</description>
  </parameter>		</parameters>

	<value>Returns one of the following<p>   * initialized - the purchase request has been created but not sent. In this state additional properties such as the item quantity can be set.</p><p>   * sendingRequest - the purchase request is being sent to the store/marketplace.</p><p>   * paymentReceived - the requested item has been paid for. The item should now be delivered to the user and confirmed cia the <command tag="mobilePurchaseConfirmDelivery">mobilePurchaseConfirmDelivery</command> command.</p><p>   * complete - the purchase has now been paid for and delivered.</p><p>   * restored - the purchase has been restored after a call to <command tag="mobileRestorePurchases">mobileRestorePurchases</command>. The purchase should now be delivered to the user and confirmed via the <command tag="mobilePurchaseConfirmDelivery">mobilePurchaseConfirmDelivery</command> command.</p><p>   * cancelled - the purchase was cancelled by the user before payment was received.</p><p>   * error - An error occurred during the payment request. More detailed information is available from the <function tag="mobilePurchaseError">mobilePurchaseError</function> function.</p></value>
	<comments>The <b>mobilePurchaseState</b> function returns a string describing the current state of the purchase defined by <i>purchaseID. </i></comments>
	</description>
</doc>