<doc>
<legacy_id></legacy_id>
<name>mobilePickPhoto</name>
<type>command</type>
<syntax>
<example>mobilePickPhoto <i>source</i> [, <i>maxwidth</i> [, <i>maxheight</i>] ] </example>
</syntax>
<synonyms>
<synonym>iphonePickPhoto</synonym>
</synonyms>
<summary>Displays the iPhone or Android native photo picker.</summary>
<examples>
<example>mobilePickPhoto "library"</example>
<example>mobilePickPhoto "front camera", 250, 250</example>
</examples>
<history>
<introduced version="4.5.2">Added.</introduced>
<deprecated version=""></deprecated>
<removed version=""></removed>
<changed version="4.6.1">4.6.1</changed>
</history>
<objects>
</objects>
<platforms>
<ios/>
<android/>
</platforms>
<classes>
<mobile/>
</classes>
<security>
</security>
<classification>
</classification>
<references>
</references>
<description>
<overview>Use the <b>mobilePickPhoto</b> command to allow the user to select an image.</overview>
<parameters>
<parameter>
<name>source</name>
<description>The source for the image. One of:</description>
<options title="">
<option>
<item>library</item>
<description/>
</option>
<option>
<item>album</item>
<description/>
</option>
<option>
<item>camera</item>
<description/>
</option>
<option>
<item>rear camera</item>
<description>iOS only</description>
</option>
<option>
<item>front camera</item>
<description>iOS only</description>
</option>
</options>
</parameter>
<parameter>
<name>maxwidth</name>
<description>The maximum allowed width of the image.</description>
</parameter>
<parameter>
<name>maxheight</name>
<description>The maximum allowed height of the image.</description>
</parameter> </parameters>
<value></value>
<comments>The <b>mobilePickPhoto</b> displays the iPhone or Android native photo picker, allowing the user to select a photo from the device's photo library, take a photo using the device cameras or select a photo from the device's recent camera roll.<p></p><p>When running on an iPhone or Android, the photo-picker is displayed using the standard iOS fullscreen overlay view. The same happens when running on an iPad and the supported orientations for the app contain any of landscape right, landscape left, portrait upside down. On the contrary, when running on an iPad and the supported orientations for the app contain only portrait, then the photo-picker is displayed using a standard iOS pop-over. In this case, the pop-over is positioned relative to the rect of the target at the time the <b>mobilePickPhoto</b> command was called.</p><p></p><p>If the <i>source</i> type is not available on the target device, the command returns with result source not available. If the user cancels the pick, the command returns with result cancel. Otherwise a new image object is created on the current card of the default stack containing the chosen image.</p><p></p><p>The <i>maxwidth</i> and <i>maxheight</i> parameters are only available on iOS devices and constrain the maximum size of an image. The chosen image is scaled down proportionally to fit within the size specified. If either size specified is 0, then the parameter is ignored.</p><p></p><p></p><p></p><note>The image object is cloned from the <keyword tag="templateImage">templateImage</keyword>, so you can use this to configure settings before calling the picker.</note><p></p><p></p><p></p><note>Android: <b>mobilePickPhoto</b> requires 'Camera' and 'External Storage' permissions. Set these in the standalone application settings pane. Not setting this permission will result in a "could not create temporary image file" error.</note></comments>
</description>
</doc>
0 commit comments