SHOW Signed

net.rim.blackberry.api.mail
Class ContactAttachmentPart

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

All Implemented Interfaces:

Part

public class ContactAttachmentPart

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 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

Inner classes inherited from class net.rim.blackberry.api.mail.BodyPart

BodyPart.ContentType

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

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

Method Summary

	Object	getContent() Retrieves the content in this contact attachment part.
	InputStream	getInputStream() Retrieves this contact in serial form in an input stream
	int	getSize() Retrieves the size of this attachment part's contained content.
	void	setContent(Object content) Sets the content for this contact attachment part.
	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

ContactAttachmentPart

public ContactAttachmentPart(Multipart parent)

Creates a new, empty ContactAttachmentPart instance.

Parameters:

parent - The multi-part to contain this new object.

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.

ContactAttachmentPart

public ContactAttachmentPart(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.

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.

Method Detail

getInputStream

public InputStream getInputStream()

Retrieves this contact in serial form in an input stream

Returns:

Input stream containing the contact in a serial format (typically vcard).

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.

setContent

public void setContent(Object content)

Sets the content for this contact attachment part.

Parameters:

content - Contact instance; all other types are ignored.

Since:

JDE 4.0.2

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.

getContent

public Object getContent()

Retrieves the content in this contact attachment part.

Returns:

Contact instance in this attachment part, or null if no content exists. Should be an instance of Contact or treatable as such.

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.

getSize

public int getSize()

Retrieves the size of this attachment part's contained content.

Returns:

Size of the contained content (VCard) in this attachment parts in bytes.

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.

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.

Overrides:

writeTo in class BodyPart

Parameters:

out - Output stream to receive the data.

Throws:

IOException - If an input/output exception occurs.

Since:

JDE 4.0.2

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.