oracle.adf.model.datacontrols.device

Class DeviceDataControl

Object

oracle.adf.model.datacontrols.device.DeviceDataControl

public class DeviceDataControl
extends Object

Master device data control class. Services such as Device Properties, Geolocation, and Camera are encapsulated in this class. This is also used directly by JDeveloper to expose these services at design time in the DataControl palette.

Constructor Summary

Constructors

Constructor and Description
DeviceDataControl()

Method Summary

Modifier and Type	Method and Description
String	addLocalNotification(String title, String alert, java.util.Date fireDate, String repeat, int badge, String sound, String vibration, String jsonPayload) Schedule a local notification
String	cancelLocalNotification(String notificationId) Cancel a local notification
Contact	createContact(Contact aContact) Save a previously-created Contact to the device's address book.
void	displayFile(String fileURL, String headerText)
Contact[]	findContacts(String contactFields, String filter, boolean multiple) Enables retrieval of one or more Contact objects matching the specified criteria.
String	getPicture(int quality, int destinationType, int sourceType, boolean allowEdit, int encodingType, int targetWidth, int targetHeight) Provides access to the device's default camera application, which enables taking a picture or retrieving a previously-saved image See PhoneGap documentation for more details: http://docs.phonegap.com/en/1.0.0/phonegap_camera_camera.md.html#camera.getPicture
void	removeContact(Contact aContact) Remove a contact from the address book See PhoneGap documentation for more details: http://docs.phonegap.com/en/1.0.0/phonegap_contacts_contacts.md.html#Contacts
void	sendEmail(String to, String cc, String subject, String body, String bcc, String attachments, String mimeTypes) Display the operating system's default UI for sending an e-mail, and optionally pre-populate certain fields.
void	sendSMS(String to, String body) Display the operating system's default UI for sending a text message, and optionally pre-populate certain fields
void	startLocationMonitor(boolean enableHighAccuracy, int timeout, int updateInterval, String locationListener) Register a callback to receive regular updates on the device's position
void	startLocationMonitor(boolean enableHighAccuracy, int updateInterval, String locationListener) Register a callback to receive regular updates on the device's position
Contact	updateContact(Contact aContact) Update an existing Contact object.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceDataControl

public DeviceDataControl()

Method Detail

startLocationMonitor

public void startLocationMonitor(boolean enableHighAccuracy,
                                 int updateInterval,
                                 String locationListener)

Register a callback to receive regular updates on the device's position

Parameters:

enableHighAccuracy - - provides a hint that the application would like to receive the best possible results (boolean)

updateInterval - - defines how often to retrieve the position in milliseconds.

locationListener - - The name of a bean method that will be invoked in response to a location update, e.g. "MyBean.myMethod". Do not use EL syntax, unless you truly want the result of evaluating that expression to become the name of the locationListener

startLocationMonitor

public void startLocationMonitor(boolean enableHighAccuracy,
                                 int timeout,
                                 int updateInterval,
                                 String locationListener)

Register a callback to receive regular updates on the device's position

Parameters:

enableHighAccuracy - - provides a hint that the application would like to receive the best possible results (boolean)

timeout - - time out (in ms) after which we will give up trying to update position

updateInterval - - defines how often to retrieve the position in milliseconds.

locationListener - - The name of a bean method that will be invoked in response to a location update, e.g. "MyBean.myMethod". Do not use EL syntax, unless you truly want the result of evaluating that expression to become the name of the locationListener

createContact

public Contact createContact(Contact aContact)

Save a previously-created Contact to the device's address book. Note that you can create a Contact by simply instantiating one and setting its properties, but in order to persist it, you must call createContact. See PhoneGap documentation for more details: http://docs.phonegap.com/en/1.0.0/phonegap_contacts_contacts.md.html#Contacts

Parameters:

aContact - - a previously-constructed Contact object

Returns:

a Contact object. Note that you should always use the returned Contact object in subsequent operations, because this object will have the requisite primary key

updateContact

public Contact updateContact(Contact aContact)

Update an existing Contact object. Note that you can modify a Contact via its various properties and methods, but in order to persist the changes, you must call updateContact See PhoneGap documentation for more details: http://docs.phonegap.com/en/1.0.0/phonegap_contacts_contacts.md.html#Contacts

Parameters:

aContact - - the modified Contact object to persist in the device's address book.

Returns:

- the modified Contact object

removeContact

public void removeContact(Contact aContact)

Remove a contact from the address book See PhoneGap documentation for more details: http://docs.phonegap.com/en/1.0.0/phonegap_contacts_contacts.md.html#Contacts

Parameters:

aContact - - the Contact object to remove

findContacts

public Contact[] findContacts(String contactFields,
                              String filter,
                              boolean multiple)

Enables retrieval of one or more Contact objects matching the specified criteria. See PhoneGap documentation for more details: http://docs.phonegap.com/en/1.0.0/phonegap_contacts_contacts.md.html#Contacts

Parameters:

contactFields - - comma-delimited list of field names to match on, e.g. "name,address"

filter - - search criteria. Note that the search criteria is matched against all fields specified in contactFields, so if you specify "John", a Contact object will be matched if any of the fields specified in contactFields (e.g. name OR address OR phonenumber) contains the filter string

Returns:

an array of Contact objects. Note that each Contact object will ONLY contain the fields you specified in the contactFields parameter; all others will be empty/null.

sendSMS

public void sendSMS(String to,
                    String body)

Display the operating system's default UI for sending a text message, and optionally pre-populate certain fields

Parameters:

to - - recipient list (comma-separated)

body - - text of message

sendEmail

public void sendEmail(String to,
                      String cc,
                      String subject,
                      String body,
                      String bcc,
                      String attachments,
                      String mimeTypes)

Display the operating system's default UI for sending an e-mail, and optionally pre-populate certain fields.

Parameters:

to - - recipient list (comma-separated)

cc - - carbon copy recipient list (comma-separated)

subject - - subject line

body - - text of e-mail

bcc - - blind carbon copy recipient list (comma-separated)

attachments - - list of files to attach (comma-separated). Must be specified as absolute filenames; use AdfmfJavaUtilities.getDirectoryPathRoot() to help determine absolute filename.

mimeTypes - - list of MIME types, specified in the same order as the list of attachments. Specify null to let the system automatically determine MIME types for all attachments, or leave blanks in the comma-separated list to indicate the system should determine the MIME type only for those selected attachments. Example: attachments = "www/foo.txt,www/bar.png", mimetypes = "text/plain," means the first attachment is of type text/plain, but the system should automatically determine the MIME type for the second one.

getPicture

public String getPicture(int quality,
                         int destinationType,
                         int sourceType,
                         boolean allowEdit,
                         int encodingType,
                         int targetWidth,
                         int targetHeight)

Provides access to the device's default camera application, which enables taking a picture or retrieving a previously-saved image See PhoneGap documentation for more details: http://docs.phonegap.com/en/1.0.0/phonegap_camera_camera.md.html#camera.getPicture

Parameters:

quality - - Quality of saved image. Range is [0, 100]

destinationType - - Choose the format of the return value. 0 = DESTINATIONTYPE_DATA_URL = Return image as base64 encoded string 1 = DESTINATIONTYPE_FILE_URI = Return image as a filename URI, like "file:///absolute/path/to/image.png" DESTINATIONTYPE_FILE_URI is recommended to avoid exhausting device resources.

sourceType - - Where should the picture come from? 0 = SOURCETYPE_PHOTOLIBRARY = Device's photo library 1 = SOURCETYPE_CAMERA = Take a picture with the device's camera 2 = SOURCETYPE_SAVEDPHOTOALBUM = Device's saved photo album

allowEdit - - Allow simple editing of image before selection

encodingType - - Choose the encoding of the returned image file. 0 = ENCODING_TYPE_JPEG = JPEG image 1 = ENCODING_TYPE_PNG = PNG image

targetWidth - - Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained

targetHeight - - Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained

Returns:

a String representing either base64 image data or a file URI, depending on the value of destinationType

displayFile

public void displayFile(String fileURL,
                        String headerText)

addLocalNotification

public String addLocalNotification(String title,
                                   String alert,
                                   java.util.Date fireDate,
                                   String repeat,
                                   int badge,
                                   String sound,
                                   String vibration,
                                   String jsonPayload)

Schedule a local notification

Parameters:

title - - notification title

alert - - notification alert

fireDate - - fire date of notification

repeat - - defines the repeatability of notification - 'minutely','hourly','daily','weekly','monthly,'yearly'. notification fires just once if not set.

badge - - application ison will be badged with this number when set

sound - - default system notification sound will play when set to "SYSTEM_DEFAULT"

vibration - - default vibration will occur when notification occurs when set to "SYSTEM_DEFAULT"

jsonPayload - - custom payload to send with notification as a stringified json

Returns:

notification id

cancelLocalNotification

public String cancelLocalNotification(String notificationId)

Cancel a local notification

Parameters:

notificationId - - id of notification to be cancelled

Returns:

id of cancelled notification