Memo

The Memo object is used to represent an entry in the MemoPad application.


Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
blackberry.pim.Memo Y Y Y      Y
blackberry.pim.Memo.find Y Y Y      Y
remove Y Y Y      Y
save Y Y Y      Y
categories Y Y Y      Y
note Y Y Y      Y
title Y Y Y      Y
uid Y Y Y      Y

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

You must declare the feature element(s) below in your configuration document:

Feature IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<feature id="blackberry.pim.Memo" /> Y Y Y      Y
<feature id="blackberry.find" /> Y Y Y      Y

Permission Elements (PlayBook and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Constructors


Functions


Properties

String categories
String note
String title
Number uid

Constructors

blackberry.pim.Memo ()

The Memo object is an instance object, where if a new instance is desired, it must be created using the new keyword.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator


Code Example:
<script type="text/javascript">
  // Create the Memo 
  var memo = new blackberry.pim.Memo(); 
  memo.title = "Reminder To Self"; 
  memo.note = "Don't forget to get your brakes fixed!!"; 
  memo.save(); 
</script>

Functions

static Memo[] blackberry.pim.Memo.find ([filter : blackberry.find.FilterExpression], [orderBy : String], [maxReturn : Number], [isAscending : Boolean])


This method finds the memo that matches the regular expression provided.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator


Parameters
filter Optionalexpression parameter that defines the search criteria for the find. If no value is provided the method will return all the Memos on the device.
orderBy Optional'orderBy' parameter specifying the field which the results will be sorted by. If 'isAscending' is not supplied or 'isAscending' is true, the sort results will be in an ascending order. If 'isAscending' is false, the sort results will be in a descending order.
maxReturn Optional integer parameter specifying the maximum number of results to return from the find. If not supplied or set to -1, it will return all results found.
isAscending Optional'isAscending' parameter specifying whether the sort order is ascending or descending. If not supplied or set to true, the results sorted by the field specified by 'orderBy' will be in an ascending order. If set to false, the sort results will be in a descending order. If no 'orderBy' value is specified, 'isAscending' is neglected.

void remove ()


This method will remove a memo from the PIM storage.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

void save ()


This method will save the changes made to the memo object.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Properties

String categories


The list of categories associated to the memo.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

String note


The body text of the memo.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

String title


The title of the memo.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

readonly Number uid


Contains the unique ID of the object. It is the primary key and would be automatically generated. This field is read-only.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:08 GMT-0500 (EST)