net.rim.blackberry.api.mail
Class PDAPContactAttachmentPart

java.lang.Object
  extended by net.rim.blackberry.api.mail.BodyPart
      extended by net.rim.blackberry.api.mail.PDAPContactAttachmentPart
All Implemented Interfaces:
Part

public class PDAPContactAttachmentPart
extends BodyPart

Provides functionality for address card attachment parts

This class makes use of the Contact class provided by the PIM API.

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

Nested Class Summary
 
Nested classes/interfaces inherited from class net.rim.blackberry.api.mail.BodyPart
BodyPart.ContentType
 
Field Summary
 
Fields inherited from class net.rim.blackberry.api.mail.BodyPart
CONTENT_TYPE, CRLF, EMPTY, SEPARATOR
 
Fields inherited from interface net.rim.blackberry.api.mail.Part
ATTACHMENT, INLINE
 
Constructor Summary
Category: Signed PDAPContactAttachmentPart(Multipart parent)
          Creates a new, empty ContactAttachmentPart instance.
Category: Signed PDAPContactAttachmentPart(Multipart parent, Contact contact)
          Creates a new ContactAttachmentPart instance for provided contact.
 
Method Summary
Category: Signed  Object getContent()
          Retrieves the content in this contact attachment part.
Category: Signed  InputStream getInputStream()
          Retrieves this contact in serial form in an input stream
Category: Signed  int getSize()
          Retrieves the size of this attachment part's contained content.
Category: Signed  void setContent(Object content)
          Sets the content for this contact attachment part.
Category: Signed  void writeTo(OutputStream out)
          Writes the contact information out to provided output stream.
 
Methods inherited from class net.rim.blackberry.api.mail.BodyPart
addHeader, getAllHeaders, getContentType, getHeader, getParent, hasMore, isMimeType, moreRequestSent, removeHeader, setContentType, setHeader
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

PDAPContactAttachmentPart

public PDAPContactAttachmentPart(Multipart parent)
Creates a new, empty ContactAttachmentPart instance.

Parameters:
parent - The multi-part to contain this new object.
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

PDAPContactAttachmentPart

public PDAPContactAttachmentPart(Multipart parent,
                                 Contact contact)
Creates a new ContactAttachmentPart instance for provided contact.

Parameters:
parent - The multi-part to contain this new object.
contact - The contact for which to create this address card attachment.
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

setContent

public void setContent(Object content)
Sets the content for this contact attachment part.

Specified by:
setContent in interface Part
Parameters:
content - Must be an instance of a class that implements the javax.microedition.pim.Contact interface; all other types are ignored.
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

writeTo

public void writeTo(OutputStream out)
             throws IOException
Writes the contact information out to provided output stream.

This method writes out this attachment part's contained content as a VCard, preceded by two CRLF pairs.

Specified by:
writeTo in interface Part
Parameters:
out - Output stream to receive the data.
Throws:
IOException - If an input/output exception occurs.
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 6.0.0

getContent

public Object getContent()
Retrieves the content in this contact attachment part.

Specified by:
getContent in interface Part
Returns:
Contact instance in this attachment part, or null if no content 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 6.0.0

getSize

public int getSize()
Retrieves the size of this attachment part's contained content.

Specified by:
getSize in interface Part
Returns:
Size of the contained content (VCard) in this attachment parts in bytes.
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 6.0.0

getInputStream

public InputStream getInputStream()
Retrieves this contact in serial form in an input stream

Specified by:
getInputStream in interface Part
Returns:
Input stream containing the contact in a serial format (typically vcard).
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 6.0.0





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.