public class DeviceDataControl
extends Object
Constructor and Description |
---|
DeviceDataControl() |
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.
|
public void startLocationMonitor(boolean enableHighAccuracy, int updateInterval, String locationListener)
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 locationListenerpublic void startLocationMonitor(boolean enableHighAccuracy, int timeout, int updateInterval, String locationListener)
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
positionupdateInterval
- - 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 locationListenerpublic Contact createContact(Contact aContact)
aContact
- - a previously-constructed Contact objectpublic Contact updateContact(Contact aContact)
aContact
- - the modified Contact object to persist in the device's address
book.public void removeContact(Contact aContact)
aContact
- - the Contact object to removepublic Contact[] findContacts(String contactFields, String filter, boolean multiple)
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 stringpublic void sendSMS(String to, String body)
to
- - recipient list (comma-separated)body
- - text of messagepublic void sendEmail(String to, String cc, String subject, String body, String bcc, String attachments, String mimeTypes)
to
- - recipient list (comma-separated)cc
- - carbon copy recipient list (comma-separated)subject
- - subject linebody
- - text of e-mailbcc
- - 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.public String getPicture(int quality, int destinationType, int sourceType, boolean allowEdit, int encodingType, int targetWidth, int targetHeight)
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 albumallowEdit
- - Allow simple editing of image before selectionencodingType
- - Choose the encoding of the returned image file.
0 = ENCODING_TYPE_JPEG = JPEG image
1 = ENCODING_TYPE_PNG = PNG imagetargetWidth
- - Width in pixels to scale image. Must be used with targetHeight.
Aspect ratio is maintainedtargetHeight
- - Height in pixels to scale image. Must be used with targetWidth.
Aspect ratio is maintainedpublic void displayFile(String fileURL, String headerText)
public String addLocalNotification(String title, String alert, java.util.Date fireDate, String repeat, int badge, String sound, String vibration, String jsonPayload)
title
- - notification titlealert
- - notification alertfireDate
- - fire date of notificationrepeat
- - 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 setsound
- - 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 jsonpublic String cancelLocalNotification(String notificationId)
notificationId
- - id of notification to be cancelled