SHOW Signed

net.rim.blackberry.api.invoke
Class MessageArguments

java.lang.Object
  |
  +--net.rim.blackberry.api.invoke.ApplicationArguments
        |
        +--net.rim.blackberry.api.invoke.MessageArguments

public final class MessageArguments
extends ApplicationArguments

Encapsulates arguments to pass to the Message application.

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 4.0.0

Field Summary
 Category: Signed static String ARG_DEFAULT
          Argument to open the message application the default (main message list) view.
 Category: Signed static String ARG_NEW
          Argument to open the message application to compose a new email
 Category: Signed static String ARG_NEW_MMS
          Argument to open the message application to compose a new MMS message
 Category: Signed static String ARG_NEW_PIN
          Argument to open the message application to compose a new PIN message
 Category: Signed static String ARG_NEW_SMS
          Argument to open the message application to compose a new SMS message
 Category: Signed static String ARG_SAVED
          Argument to open the message application in the saved message list.
 Category: Signed static String ARG_SEARCH
          Argument to open the message application in the message search screen.
   
Constructor Summary
 Category: Signed MessageArguments()
          Creates a new MessageArguments instance with default arguments.
 Category: Signed MessageArguments(Folder folder)
          Creates a new MessageArguments instance which takes a Folder as an argument.
 Category: Signed MessageArguments(Message message)
          Creates a new MessageArguments instance which takes a Message as an argument
 Category: Signed MessageArguments(String arg)
          Creates a new MessageArguments instance with provided arguments.
 Category: Signed MessageArguments(String arg, String to, String subject, String body)
          Creates a new MessageArguments instance with provided arguments
 Category: Signed MessageArguments(TextMessage textMessage)
          Creates a new MessageArguments instance which takes a TextMessage as an argument
 
Method Summary
 
Methods inherited from class net.rim.blackberry.api.invoke.ApplicationArguments
getArgs
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ARG_DEFAULT

public static final String ARG_DEFAULT
Argument to open the message application the default (main message list) view.
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.

ARG_NEW

public static final String ARG_NEW
Argument to open the message application to compose a new email
Since:
JDE 4.1.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.

ARG_NEW_MMS

public static final String ARG_NEW_MMS
Argument to open the message application to compose a new MMS message
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.

ARG_NEW_PIN

public static final String ARG_NEW_PIN
Argument to open the message application to compose a new PIN message
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.

ARG_NEW_SMS

public static final String ARG_NEW_SMS
Argument to open the message application to compose a new SMS message
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.

ARG_SAVED

public static final String ARG_SAVED
Argument to open the message application in the saved message list.
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.

ARG_SEARCH

public static final String ARG_SEARCH
Argument to open the message application in the message search screen.
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.
Constructor Detail

MessageArguments

public MessageArguments()
Creates a new MessageArguments instance with default arguments.

The default arguments instruct the Message application to open in the default (main list) view.

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.

MessageArguments

public MessageArguments(Folder folder)
Creates a new MessageArguments instance which takes a Folder as an argument. With the resulting MessageArguments object the message application will be launched to view the specified folder.
Parameters:
folder - The folder you would like to see in the message application.
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.

MessageArguments

public MessageArguments(Message message)
Creates a new MessageArguments instance which takes a Message as an argument
Parameters:
message - A Message object (PIN or email). With the resulting MessageArguments object the message application will be launched with the data in the Message prepopulated in a compose screen, ready to send.
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.

MessageArguments

public MessageArguments(String arg)
Creates a new MessageArguments instance with provided arguments.
Parameters:
arg - Use ARG_DEFAULT for the default message list. Use ARG_SAVED to open the saved message list. Use ARG_SEARCH to open the search message window. Use ARG_NEW to open the email message compose screen. Use ARG_NEW_PIN to open the PIN message compose screen. Use ARG_NEW_SMS to open the SMS message compose screen. Use ARG_NEW_MMS to open the MMS message compose screen.
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.

MessageArguments

public MessageArguments(String arg,
                        String to,
                        String subject,
                        String body)
Creates a new MessageArguments instance with provided arguments
Parameters:
arg - Use ARG_NEW to create a new, simple email message. Use ARG_NEW_PIN to create a new, simple PIN message. Quick MMS and SMS are not supported. Use MessageArguments(String) to create blank MMS and SMS messages, or MessageArguments(javax.wireless.messaging.TextMessage) to create a populated SMS message.
to - The email address for the recipient if ARG_NEW was specified. The PIN address for the recipient if ARG_NEW_PIN was specified.
subject - A subject for the email/PIN
body - The email/PIN body
Since:
JDE 4.1.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.

MessageArguments

public MessageArguments(TextMessage textMessage)
Creates a new MessageArguments instance which takes a TextMessage as an argument
Parameters:
textMessage - A TextMessage object (SMS). With the resulting MessageArguments object the message application will be launched with the data in the TextMessage prepopulated in an SMS compose screen, ready to send.
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.


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.