Memo
The Memo object is used to represent an entry in the MemoPad application.
Supported Platform(s)
- BlackBerry OS 5.0+ |
- Ripple Emulator |
API | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
---|---|---|---|---|---|---|---|
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 ID | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
---|---|---|---|---|---|---|---|
<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
Memo[] | blackberry.pim.Memo.find |
void | remove |
void | save |
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:
|
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. |
Properties
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:40 GMT-0500 (EST)