net.rim.blackberry.api.mail
Class ServiceConfiguration

java.lang.Object
  net.rim.blackberry.api.mail.ServiceConfiguration

public class ServiceConfiguration
extends Object

Encapsulates information used to describe a particular mail service.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Field Summary
	static String	NO_SERVICE_BOOK Names the root folder for folders belonging to a hierarchy without a corresponding service book entry.

Constructor Summary
	ServiceConfiguration() Creates a new ServiceConfiguration instance.
	ServiceConfiguration(String uid, String cid) Creates a new ServiceConfiguration instance with provided unique and content IDs.
	ServiceConfiguration(ServiceRecord sr) Creates a new ServiceConfiguration instance with provided service record.

Method Summary
	boolean	equals(Object o) Determines if another object is identical to this service configuration.
	String	getCID() Retrieves the connection ID (CID) of this service.
	String	getEmailAddress() Retrieves the email address associated with this service.
	String	getName() Retrieves the name of the service record held in this configuration.
	String	getUID() Retrieves the UID for this service.
	int	hashCode() Retrieves this service configuration's IDs as a hash.
	String	toString() Retrieves string representation of this configuration.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_SERVICE_BOOK

public static String NO_SERVICE_BOOK

Names the root folder for folders belonging to a hierarchy without a corresponding service book entry.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Constructor Detail

ServiceConfiguration

public ServiceConfiguration()

Creates a new ServiceConfiguration instance.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

ServiceConfiguration

public ServiceConfiguration(String uid,
                            String cid)
                     throws NoSuchServiceException

Creates a new ServiceConfiguration instance with provided unique and content IDs.

Parameters:

uid - Service UID, as displayed in the Options > Service Book screen.

cid - Service CID, as displayed in the Options > Service Book screen.

Throws:

NoSuchServiceException - If no matching service exists.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

ServiceConfiguration

public ServiceConfiguration(ServiceRecord sr)

Creates a new ServiceConfiguration instance with provided service record.

Parameters:

sr - Service record used to create the new service configuration.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

Method Detail

getUID

public String getUID()

Retrieves the UID for this service. The UID is a string that uniquely identifies a service. The UID is case-insensitive and must be between 1 and 127 bytes in length

Returns:

Service's unique ID (UID) as a string.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getCID

public String getCID()

Retrieves the connection ID (CID) of this service. The CID identifies the connection type of a service. The CID is case-insensitive and must be between 1 and 127 bytes in length See the BlackBerry Application Developer Guide Volume 2: Advanced Topics for more information.

Returns:

Service content ID (CID) as a string.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

equals

public boolean equals(Object o)

Determines if another object is identical to this service configuration.

Overrides:

equals in class Object

Parameters:

o - Object to compare to this service configuration.

Returns:

True if provided object is the same object as this instance, or if provided object is a ServiceConfiguration and contains the same data as this instance; otherwise, false.

See Also:

Boolean.hashCode(), Hashtable

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

hashCode

public int hashCode()

Retrieves this service configuration's IDs as a hash.

Overrides:

hashCode in class Object

Returns:

Hash of this configuration's IDs.

See Also:

Object.equals(java.lang.Object), Hashtable

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getName

public String getName()

Retrieves the name of the service record held in this configuration. This information can be used to later find a service using its Name.

Returns:

Name of then internal service, as described in the Options > Service Book screen.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getEmailAddress

public String getEmailAddress()

Retrieves the email address associated with this service. Queries a service record for the email address the server has assigned to the BlackBerry device. This data is useful if you want to determine the email address that is associated to the email service for a particular BlackBerry device.

Returns:

Email address associated with this service.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

toString

public String toString()

Retrieves string representation of this configuration.

Use this method to retrieve a string of the form:

   ServiceRecordName:UID:CID
 

Overrides:

toString in class Object

Returns:

String representation of this configuration.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0