SHOW Signed

net.rim.blackberry.api.mail
Class Session

java.lang.Object
  |
  +--net.rim.blackberry.api.mail.Session

public final class Session
extends Object

Provides access to email services, storage, and transport.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 3.6.0
See Also:
Service, Store, Transport

Method Summary
 Category: Signed static void addDefaultSessionListener(DefaultSessionListener dl)
          Registers a listener for Default Session change notification.
 Category: Signed static void addViewListener(ViewListener vl)
          Registers a listener for view notification.
 Category: Signed static Session getDefaultInstance()
          Retrieves this device's default session.
 Category: Signed static Session getDefaultInstance(ServiceConfiguration sc)
          Retrieves default session based on provided service configruation.
 Category: Signed static Session getInstance(ServiceConfiguration sc)
          Retrieves session by provided service configuration.
 Category: Signed  ServiceConfiguration getServiceConfiguration()
          Retrieves the service configuration for this service.
 Category: Signed  Store getStore()
          Retrieves a Store instance to access message storage on this device.
 Category: Signed  Transport getTransport()
          Retrieves a Transport instanace to access the email transport protocol on the handheld.
 Category: Signed static void removeDefaultSessionListener(DefaultSessionListener dl)
          De-registers a default Session listener.
 Category: Signed static void removeViewListener(ViewListener vl)
          De-registers a view notification listener.
 Category: Signed static Session waitForDefaultSession()
          Retrieves this device's default mail service (blocking).
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

addDefaultSessionListener

public static void addDefaultSessionListener(DefaultSessionListener dl)
Registers a listener for Default Session change notification.
Parameters:
d1 - DefaultSessionListener listener to add.
Throws:
NullPointerException - if the listener is null
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

addViewListener

public static void addViewListener(ViewListener vl)
Registers a listener for view notification.
Parameters:
v1 - View listener to add.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDefaultInstance

public static Session getDefaultInstance()
Retrieves this device's default session.

Use this method to retrieve the default session associated with the handheld (typically the enterprise email account).

There is a possible timing issue with startup. If the various service book entries are not yet present on the handheld, this call returns null. This does not always mean that no service is available; it is possible that the service just is not yet registered.

Returns:
The default session instance associated with the handheld, or null if one can't be created (for instance, due to lack of Service Book configuration information on the device).
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDefaultInstance

public static Session getDefaultInstance(ServiceConfiguration sc)
Retrieves default session based on provided service configruation.
Parameters:
sc - Service configuration for which to retrieve the mail service.
Returns:
Session instance associated with the configuration provided, or null if one can't be created (for instance, because the device doesn't contain valid service book information for the named service).
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getInstance

public static Session getInstance(ServiceConfiguration sc)
Retrieves session by provided service configuration.
Parameters:
sc - Service configuration information from which to retrieve service.
Returns:
Session associated with provided service configuration, or null if no such service.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getServiceConfiguration

public ServiceConfiguration getServiceConfiguration()
Retrieves the service configuration for this service.
Returns:
Service configuration for this service.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getStore

public Store getStore()
Retrieves a Store instance to access message storage on this device.
Returns:
Instance of the store.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getTransport

public Transport getTransport()
Retrieves a Transport instanace to access the email transport protocol on the handheld.
Returns:
Transport instance.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

removeDefaultSessionListener

public static void removeDefaultSessionListener(DefaultSessionListener dl)
De-registers a default Session listener.
Parameters:
d1 - DefaultSessionListener to remove. If the specified listener is not registered or if the parameter is null, this method silently returns with no action.
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

removeViewListener

public static void removeViewListener(ViewListener vl)
De-registers a view notification listener.
Parameters:
v1 - View listener to remove.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

waitForDefaultSession

public static Session waitForDefaultSession()
                                     throws NoSuchServiceException
Retrieves this device's default mail service (blocking).

Note: This call blocks indefinitely if no service is available.

Throws:
NoSuchServiceException - If the default service can't be instantiated (usually due to lack of Service Book configuration information on the device).
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2007 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.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.