com.aol.acc
Class AccImSession

java.lang.Object
  com.aol.acc.AccBase
      com.aol.acc.AccSecondarySession
          com.aol.acc.AccImSession

public class AccImSession
extends AccSecondarySession

IAccImSession is used for controlling (D)IM/Chat conversations,
for sending messages, and for typing indication.

setInputState

public void setInputState(AccImInputState state)
                   throws AccException

Set the current text input state.

Throws:

AccException

sendIm

public void sendIm(AccIm im)
            throws AccException

Send an IM to the other attendee(s) in the session.
If your app supports "sender-pays" SMS, call SegmentIm first.

Throws:

AccException

segmentIm

public void segmentIm(AccIm im)
               throws AccException

It may be necessary to segment the IM (e.g. for "sender-pays" SMS).
After calling SegmentIm(), you can examine AccImProp_Segments and
AccImProp_SegmentCharsRemaining to inform the user how much sending
this IM will cost them. Do not call this method if you do not plan
to display this info to the user, or else the user may not be aware
he/she is being charged for sending messages. Note that if
segmentation is necessary, your message will result in an error if
you did not call this method.

Throws:

AccException

proposeChange

public void proposeChange(AccImSessionType sessionType)
                   throws AccException

Propose a session type transition to the other attendees in this
session. Note that not all session types support transition at
this time.

Throws:

AccException

stopRecv

public void stopRecv()
              throws AccException

Stop receiving embedded data in the current IM.

Throws:

AccException

stopSend

public void stopSend()
              throws AccException

Stop sending embedded data in the current IM.

Throws:

AccException

getSessionType

public AccImSessionType getSessionType()
                                throws AccException

The type of session (e.g. DIM, Chat)

Throws:

AccException

getSessionTypeProposed

public AccImSessionType getSessionTypeProposed()
                                        throws AccException

The new proposed session type

Throws:

AccException

getChatExchange

public int getChatExchange()
                    throws AccException

If a chat room session, the exchange value of the chat room (see AccImExchange)

Throws:

AccException

getChatRoomName

public java.lang.String getChatRoomName()
                                 throws AccException

If a chat room session, the chat room name

Throws:

AccException

getChatRoomFullyQualifiedName

public java.lang.String getChatRoomFullyQualifiedName()
                                               throws AccException

If a chat room session, the chat room name with path, if any

Throws:

AccException

getChatInstance

public int getChatInstance()
                    throws AccException

If a chat room session, the particular instance of a given chat room

Throws:

AccException

getCanStop

public boolean getCanStop()
                   throws AccException

Whether embedded data sent in this session can be stopped cleanly

Throws:

AccException

getOutgoingPersonality

public java.lang.String getOutgoingPersonality()
                                        throws AccException

The outgoing personality name to be used for the session

Throws:

AccException

setOutgoingPersonality

public void setOutgoingPersonality(java.lang.String OutgoingPersonality)
                            throws AccException

The outgoing personality name to be used for the session

Throws:

AccException

getMaxImLength

public long getMaxImLength()
                    throws AccException

Maximum length of IM content, including embedded data and hidden markup

Throws:

AccException

getMaxVisibleImLength

public int getMaxVisibleImLength()
                          throws AccException

Maximum length of IM text, excluding markup

Throws:

AccException

getRateState

public AccRateState getRateState()
                          throws AccException

The rate limit state of a session

Throws:

AccException

getPromoteCentralized

public boolean getPromoteCentralized()
                              throws AccException

DEPRECATED

Throws:

AccException

setPromoteCentralized

public void setPromoteCentralized(boolean PromoteCentralized)
                           throws AccException

DEPRECATED

Throws:

AccException

getLocalWantsRtim

public boolean getLocalWantsRtim()
                          throws AccException

Whether local user wants to receive Real-Time IMs (over Direct IM)

Throws:

AccException

setLocalWantsRtim

public void setLocalWantsRtim(boolean LocalWantsRtim)
                       throws AccException

Whether local user wants to receive Real-Time IMs (over Direct IM)

Throws:

AccException

getRemoteWantsRtim

public boolean getRemoteWantsRtim()
                           throws AccException

Whether remote user wants to receive Real-Time IMs (over Direct IM)

Throws:

AccException

getQueuedImCount

public int getQueuedImCount()
                     throws AccException

Number of incoming IMs in queue during AccSecondarySessionState_ReceivedProposal

Throws:

AccException