|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.blackberry.api.phone.phonelogs.PhoneCallLogID
public final class PhoneCallLogID
Represents the caller ID information associated with a phone call log.
This is the information that displays as the caller in the message list and when a log is opened for viewing.
Constructor Summary | ||
---|---|---|
|
PhoneCallLogID(String number)
Creates a new PhoneCallLogID instance. |
Method Summary | ||
---|---|---|
|
String |
getAddressBookFormattedNumber()
Returns the contact list phone number for this caller ID. |
|
BlackBerryContact |
getContact()
Returns the contact associated with this phone call log. |
|
String |
getName()
Returns the name associated with this caller ID. |
|
String |
getNumber()
Returns the original number for this caller ID. |
|
String |
getType()
Returns the type of the caller ID as stored in the contact list. |
|
void |
setName(String name)
Deprecated. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PhoneCallLogID(String number)
The input phone number acts like the identifier for the object. If the number exists in the contact list, then all the information about the contact is transferred to this object. If not, a blank object is created with the number as the main identification.
number
- Phone number for this caller.Method Detail |
---|
public String getName()
null
if the number specified at creation
has no associated entry in the contact list.public String getNumber()
Use this method to retrieve the original phone number given this
object when it was created. If the caller has an associated entry in the contact list,
this number might be in a different format than the phone number in the contact list.
For example, if this caller ID is created with the raw number
"5550100", and the associated contact from the contact list has the
number "(519) 555-0100", then this method returns the
String
"5550100", while the method
PhoneCallLogID.getAddressBookFormattedNumber()
returns the String
"(519) 555-0100".
null
is provided to this instance of PhoneCallLogID.public BlackBerryContact getContact()
null
if a match is not found or if the call is private,
unknown, an emergency call, a voice mail, or for SIM startup.
SecurityException
- if the device is locked or the contact list is protected, or if the application is not given permissions to read or write a Contact.public String getAddressBookFormattedNumber()
If a phone number in the contact list matches the raw phone number
for this PhoneCallLogID
, the contact list phone number
is returned, otherwise, the raw phone number is returned.
PhoneCallLogID
object was created with a null
raw number,
this method returns an empty String.
SecurityException
- if the device is locked or if the contact lists are protected.public String getType()
If there is a phone number in the contact list that matches
the raw phone number from this PhoneCallLogID
, then the type of the number
(for example, home, work, etc.) is returned. If not, a default type is returned (that is, Phone).
If all else fails, an empty String is returned.
public void setName(String name)
name
- New name for this caller ID.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.