Interface ISocialMedia

All Superinterfaces:

IDisposable, IEntity, IInteractionMedia

public interface ISocialMedia
extends IInteractionMedia

Represents a social media.

Method Summary

Modifier and Type	Method	Description
void	addSocialErrorListener(SocialErrorListener listener)	Registers the SocialErrorListener.
void	addSocialListener(SocialListener listener)	Registers the SocialListener.
void	addSocialProgressListener(SocialProgressListener listener)	Registers the SocialProgressListener.
void	blindTransfer(String agentName, String campaignName, String remoteSocialAddress, Attribute[] attributes, int priority, String skillProfileName, SkillInProfile[] skills, int directoryId, int contactProfileId, boolean synchronous)	Makes a blind transfer.
void	clear(boolean synchronous)	Clears the data transaction.
void	endReservation(boolean synchronous)	Ends the reservation.
SocialMediaCanDo	getAllowedOperations()	Allowed social media operations.
boolean	getAutoReplySent()	True if the auto reply was sent.
SocialInteractionData	getData()	Data of the social interaction.
GregorianCalendar	getDateOfArrival()	Date of arrival of the social.
boolean	getDelivered()	Returns true if the social was delivered.
String	getFrom()	Social senders.
boolean	getIsSuspended()	True if the interaction is suspended.
String	getReplyTo()	Reply to address.
byte[]	getSocialDocument()	Gets the social document.
int	getSocialDocumentId()	Identifier of the social document.
SocialInteractionState	getState()	State of the social interaction.
String	getSubject()	Subject of the social.
String	getTo()	Social receivers.
boolean	getWasRecovered()	True if the social was recovered.
void	removeSocialErrorListener(SocialErrorListener listener)	Unregisters the SocialErrorListener.
void	removeSocialListener(SocialListener listener)	Unregisters the SocialListener.
void	removeSocialProgressListener(SocialProgressListener listener)	Unregisters the SocialProgressListener.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Methods inherited from interface IInteractionMedia

answer, getInteractionId, getMediaId, getMediaType, getSession, getStartTime

Method Details

addSocialErrorListener

void addSocialErrorListener(SocialErrorListener listener)

Registers the SocialErrorListener.

Parameters:

listener - Event listener to add.

removeSocialErrorListener

void removeSocialErrorListener(SocialErrorListener listener)

Unregisters the SocialErrorListener.

Parameters:

listener - Event listener to remove.

addSocialListener

void addSocialListener(SocialListener listener)

Registers the SocialListener.

Parameters:

listener - Event listener to add.

removeSocialListener

void removeSocialListener(SocialListener listener)

Unregisters the SocialListener.

Parameters:

listener - Event listener to remove.

addSocialProgressListener

void addSocialProgressListener(SocialProgressListener listener)

Registers the SocialProgressListener.

Parameters:

listener - Event listener to add.

removeSocialProgressListener

void removeSocialProgressListener(SocialProgressListener listener)

Unregisters the SocialProgressListener.

Parameters:

listener - Event listener to remove.

blindTransfer

void blindTransfer(String agentName,
 String campaignName,
 String remoteSocialAddress,
 Attribute[] attributes,
 int priority,
 String skillProfileName,
 SkillInProfile[] skills,
 int directoryId,
 int contactProfileId,
 boolean synchronous)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Makes a blind transfer.

Parameters:

agentName - Name of the agent.

campaignName - Name of the campaign.

remoteSocialAddress - Social address of the remote instance.

attributes - Attributes to send with the transferred social.

priority - Relative priority.

skillProfileName - Name of the skill profile.

skills - Optional agent skills required to handle the social. This parameter will be ignored if the skillProfileName is specified.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

clear

void clear(boolean synchronous)
    throws Exception,
altitude.integrationServer.exceptions.ISException

Clears the data transaction.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

endReservation

void endReservation(boolean synchronous)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Ends the reservation.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAllowedOperations

SocialMediaCanDo getAllowedOperations()
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Allowed social media operations.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAutoReplySent

boolean getAutoReplySent()
                  throws Exception,
altitude.integrationServer.exceptions.ISException

True if the auto reply was sent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getData

SocialInteractionData getData()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Data of the social interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDateOfArrival

GregorianCalendar getDateOfArrival()
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Date of arrival of the social.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDelivered

boolean getDelivered()
              throws Exception,
altitude.integrationServer.exceptions.ISException

Returns true if the social was delivered.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getFrom

String getFrom()
        throws Exception,
altitude.integrationServer.exceptions.ISException

Social senders.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsSuspended

boolean getIsSuspended()
                throws Exception,
altitude.integrationServer.exceptions.ISException

True if the interaction is suspended.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getReplyTo

String getReplyTo()
           throws Exception,
altitude.integrationServer.exceptions.ISException

Reply to address.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSocialDocument

byte[] getSocialDocument()
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the social document.

Returns:

The social document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSocialDocumentId

int getSocialDocumentId()
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the social document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getState

SocialInteractionState getState()
                         throws Exception,
altitude.integrationServer.exceptions.ISException

State of the social interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSubject

String getSubject()
           throws Exception,
altitude.integrationServer.exceptions.ISException

Subject of the social.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTo

String getTo()
      throws Exception,
altitude.integrationServer.exceptions.ISException

Social receivers.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getWasRecovered

boolean getWasRecovered()
                 throws Exception,
altitude.integrationServer.exceptions.ISException

True if the social was recovered.

Throws:

Exception

altitude.integrationServer.exceptions.ISException