com.aol.acc
Class AccIm

java.lang.Object
  extended by com.aol.acc.AccBase
      extended by com.aol.acc.AccIm

public class AccIm
extends AccBase

The IAccIm interface represents an instant message.
By default IAccIms are of the text/x-aolrtf MIME type, and pass their
data unchanged to/from the application. IAccIm also supports the
ability to convert the content to/from other MIME types, using
the GetConvertedText and ConvertToMimeType calls.
Supported types include the default text/x-aolrtf, and:
application/xhtml+xml
application/x-aol-xhtml-div+xml
text/plain
Applications that want to handle text/x-aolrtf directly do not need
to concern themselves with these APIs, but it is strongly recommended
that applications use application/xhtml+xml instead.
This allows use of standard compose/render controls, and also ensures
that the data received by the renderer is sanitized and well-formed.
IAccIm will also accept text/html as an input format, to support compose
controls that cannot generate XHTML.


Method Summary
 void convertToMimeType(java.lang.String type)
          Converts the message in-place to a different MIME type.

 int getActualContentFlags()
          Flags that describe content of the IM.
 int getAllowedContentFlags()
          Ignored when IM sent as standard IM.
 boolean getAllowImages()
          DEPRECATED.
 AccBartItem getBigIcon()
          Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF
 AccBartItem getBuddyIcon()
          The buddy icon associated with the IM.
 boolean getContainsImages()
          DEPRECATED.
 java.lang.String getConvertedText(java.lang.String type)
          Gets the message text, converted to a specific MIME type.

 java.lang.String getCookie()
          The unique id for this IM
 AccResult getDisposition()
          Use ACC_E_PLUGIN_ABORTED_ACTION or ACC_E_PLUGIN_CONSUMED_ACTION, as appropriate
 int getFlags()
          The flags for the IM, from AccImFlags
 AccBartItem getFlashWallpaper()
          The flash wallpaper associated with the IM.
 boolean getLocal()
          Whether this IM is to be appended as a "status message" in local IM session history instead of being sent over the wire.
 java.lang.String getMimeType()
          The MIME type of the IM being sent, i.e.
 int getSegmentCharsRemaining()
          The number of characters remaining in this IM before another SMS segment is required
 int getSegments()
          The number of SMS segments required for this IM
 java.lang.String getSerializedText()
          A private, serialized representation of the IAccIm.
 AccBartItem getSound()
          The sound associated with the IM.
 AccStream getStream(java.lang.String id)
          Gets a copy of a stream object on this IM for reading.
This is how embedded data can be retrieved from an IM.

 int getStreamCount()
          The current number of embedded streams.
 java.lang.String getSubject()
          The subject (used for away message label)
 AccBartItem getSuperIcon()
          The super buddy icon associated with the IM.
 AccBartItem getSuperIconTrigger()
          The super buddy icon trigger associated with the IM.
 java.lang.String getText()
          Gets the message text,
in the format specified by AccImProp_MimeType.

 java.util.Date getTimestamp()
          The timestamp of the IM
 boolean getVerified()
          Whether the IM has a verified digital signature
 AccBartItem getWallpaper()
          The wallpaper associated with the IM.
 void setAllowedContentFlags(int AllowedContentFlags)
          Ignored when IM sent as standard IM.
 void setAllowImages(boolean AllowImages)
          DEPRECATED.
 void setBigIcon(AccBartItem BigIcon)
          Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF
 void setBuddyIcon(AccBartItem BuddyIcon)
          The buddy icon associated with the IM.
 void setDisposition(AccResult Disposition)
          Use ACC_E_PLUGIN_ABORTED_ACTION or ACC_E_PLUGIN_CONSUMED_ACTION, as appropriate
 void setFlags(int Flags)
          The flags for the IM, from AccImFlags
 void setFlashWallpaper(AccBartItem FlashWallpaper)
          The flash wallpaper associated with the IM.
 void setLocal(boolean Local)
          Whether this IM is to be appended as a "status message" in local IM session history instead of being sent over the wire.
 void setMimeType(java.lang.String MimeType)
          The MIME type of the IM being sent, i.e.
 void setSerializedText(java.lang.String SerializedText)
          A private, serialized representation of the IAccIm.
 void setSound(AccBartItem Sound)
          The sound associated with the IM.
 void setStream(java.lang.String id, AccStream stream)
          Sets a stream object on this IM.
This is how you add embed data to an IM.

 void setSubject(java.lang.String Subject)
          The subject (used for away message label)
 void setSuperIcon(AccBartItem SuperIcon)
          The super buddy icon associated with the IM.
 void setSuperIconTrigger(AccBartItem SuperIconTrigger)
          The super buddy icon trigger associated with the IM.
 void setText(java.lang.String text)
          Sets the text for the message,
in the format specified by AccImProp_MimeType.

 void setWallpaper(AccBartItem Wallpaper)
          The wallpaper associated with the IM.
 
Methods inherited from class com.aol.acc.AccBase
compareHandle, equals
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getText

public java.lang.String getText()
                         throws AccException
Gets the message text,
in the format specified by AccImProp_MimeType.

Throws:
AccException

setText

public void setText(java.lang.String text)
             throws AccException
Sets the text for the message,
in the format specified by AccImProp_MimeType.

Throws:
AccException

getConvertedText

public java.lang.String getConvertedText(java.lang.String type)
                                  throws AccException
Gets the message text, converted to a specific MIME type.

Throws:
AccException

convertToMimeType

public void convertToMimeType(java.lang.String type)
                       throws AccException
Converts the message in-place to a different MIME type.

Throws:
AccException

getStream

public AccStream getStream(java.lang.String id)
                    throws AccException
Gets a copy of a stream object on this IM for reading.
This is how embedded data can be retrieved from an IM.

Throws:
AccException

setStream

public void setStream(java.lang.String id,
                      AccStream stream)
               throws AccException
Sets a stream object on this IM.
This is how you add embed data to an IM.

Throws:
AccException

getMimeType

public java.lang.String getMimeType()
                             throws AccException
The MIME type of the IM being sent, i.e. text/plain or application/xhtml+xml

Throws:
AccException

setMimeType

public void setMimeType(java.lang.String MimeType)
                 throws AccException
The MIME type of the IM being sent, i.e. text/plain or application/xhtml+xml

Throws:
AccException

getFlags

public int getFlags()
             throws AccException
The flags for the IM, from AccImFlags

Throws:
AccException

setFlags

public void setFlags(int Flags)
              throws AccException
The flags for the IM, from AccImFlags

Throws:
AccException

getTimestamp

public java.util.Date getTimestamp()
                            throws AccException
The timestamp of the IM

Throws:
AccException

getVerified

public boolean getVerified()
                    throws AccException
Whether the IM has a verified digital signature

Throws:
AccException

getSegments

public int getSegments()
                throws AccException
The number of SMS segments required for this IM

Throws:
AccException

getSegmentCharsRemaining

public int getSegmentCharsRemaining()
                             throws AccException
The number of characters remaining in this IM before another SMS segment is required

Throws:
AccException

getCookie

public java.lang.String getCookie()
                           throws AccException
The unique id for this IM

Throws:
AccException

getContainsImages

public boolean getContainsImages()
                          throws AccException
DEPRECATED. Use AccImProp_ActualContentFlags.

Throws:
AccException

getAllowImages

public boolean getAllowImages()
                       throws AccException
DEPRECATED. Use AccImProp_AllowedContentFlags.

Throws:
AccException

setAllowImages

public void setAllowImages(boolean AllowImages)
                    throws AccException
DEPRECATED. Use AccImProp_AllowedContentFlags.

Throws:
AccException

getSubject

public java.lang.String getSubject()
                            throws AccException
The subject (used for away message label)

Throws:
AccException

setSubject

public void setSubject(java.lang.String Subject)
                throws AccException
The subject (used for away message label)

Throws:
AccException

getStreamCount

public int getStreamCount()
                   throws AccException
The current number of embedded streams.

Throws:
AccException

getDisposition

public AccResult getDisposition()
                         throws AccException
Use ACC_E_PLUGIN_ABORTED_ACTION or ACC_E_PLUGIN_CONSUMED_ACTION, as appropriate

Throws:
AccException

setDisposition

public void setDisposition(AccResult Disposition)
                    throws AccException
Use ACC_E_PLUGIN_ABORTED_ACTION or ACC_E_PLUGIN_CONSUMED_ACTION, as appropriate

Throws:
AccException

getSerializedText

public java.lang.String getSerializedText()
                                   throws AccException
A private, serialized representation of the IAccIm.

Throws:
AccException

setSerializedText

public void setSerializedText(java.lang.String SerializedText)
                       throws AccException
A private, serialized representation of the IAccIm.

Throws:
AccException

getLocal

public boolean getLocal()
                 throws AccException
Whether this IM is to be appended as a "status message" in local IM session history instead of being sent over the wire.

Throws:
AccException

setLocal

public void setLocal(boolean Local)
              throws AccException
Whether this IM is to be appended as a "status message" in local IM session history instead of being sent over the wire.

Throws:
AccException

getAllowedContentFlags

public int getAllowedContentFlags()
                           throws AccException
Ignored when IM sent as standard IM.

Throws:
AccException

setAllowedContentFlags

public void setAllowedContentFlags(int AllowedContentFlags)
                            throws AccException
Ignored when IM sent as standard IM.

Throws:
AccException

getActualContentFlags

public int getActualContentFlags()
                          throws AccException
Flags that describe content of the IM.

Throws:
AccException

getBuddyIcon

public AccBartItem getBuddyIcon()
                         throws AccException
The buddy icon associated with the IM.

Throws:
AccException

setBuddyIcon

public void setBuddyIcon(AccBartItem BuddyIcon)
                  throws AccException
The buddy icon associated with the IM.

Throws:
AccException

getSuperIcon

public AccBartItem getSuperIcon()
                         throws AccException
The super buddy icon associated with the IM.

Throws:
AccException

setSuperIcon

public void setSuperIcon(AccBartItem SuperIcon)
                  throws AccException
The super buddy icon associated with the IM.

Throws:
AccException

getSuperIconTrigger

public AccBartItem getSuperIconTrigger()
                                throws AccException
The super buddy icon trigger associated with the IM.

Throws:
AccException

setSuperIconTrigger

public void setSuperIconTrigger(AccBartItem SuperIconTrigger)
                         throws AccException
The super buddy icon trigger associated with the IM.

Throws:
AccException

getBigIcon

public AccBartItem getBigIcon()
                       throws AccException
Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF

Throws:
AccException

setBigIcon

public void setBigIcon(AccBartItem BigIcon)
                throws AccException
Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF

Throws:
AccException

getWallpaper

public AccBartItem getWallpaper()
                         throws AccException
The wallpaper associated with the IM.

Throws:
AccException

setWallpaper

public void setWallpaper(AccBartItem Wallpaper)
                  throws AccException
The wallpaper associated with the IM.

Throws:
AccException

getSound

public AccBartItem getSound()
                     throws AccException
The sound associated with the IM.

Throws:
AccException

setSound

public void setSound(AccBartItem Sound)
              throws AccException
The sound associated with the IM.

Throws:
AccException

getFlashWallpaper

public AccBartItem getFlashWallpaper()
                              throws AccException
The flash wallpaper associated with the IM.

Throws:
AccException

setFlashWallpaper

public void setFlashWallpaper(AccBartItem FlashWallpaper)
                       throws AccException
The flash wallpaper associated with the IM.

Throws:
AccException