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

APIOS 5.0OS 6.0OS 7.0PlayBookRipple
blackberry.pim.Memo Y Y Y  Y
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 IDOS 5.0OS 6.0OS 7.0PlayBookRipple
<feature id="blackberry.pim.Memo" /> Y Y Y  Y
<feature id="blackberry.find" /> Y Y Y  Y

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

API Summary


Constructors


Functions


Properties

blackberry.pim.Memo

blackberry.pim.Memo ()

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

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



Code Example(s)

<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>

find

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

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

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



Parameter Type Description
filter blackberry.find.FilterExpression
Optional 		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 String
Optional 		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 Number
Optional 		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 Boolean
Optional 		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.

remove

void remove()

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

This method will remove a memo from the PIM storage.


save

void save()

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

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


Properties:

Property Type Description Supported Platform(s)
categories String The list of categories associated to the memo.
 - BlackBerry OS 5.0+
 - Ripple Emulator
note String The body text of the memo.
 - BlackBerry OS 5.0+
 - Ripple Emulator
title String The title of the memo.
 - BlackBerry OS 5.0+
 - Ripple Emulator
uid Number
readonly 		Contains the unique ID of the object. It is the primary key and would be automatically generated. This field is read-only.
 - BlackBerry OS 5.0+
 - Ripple Emulator
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:18 GMT-0500 (EST)