Interface ISoftPhone

All Superinterfaces:
IDisposable, IEntity
public interface ISoftPhone extends IEntity
Represents a soft phone.

  • Method Details

    • addSoftPhoneAllowedOperationsChangedListener

      void addSoftPhoneAllowedOperationsChangedListener(SoftPhoneAllowedOperationsChangedListener listener)
      Registers the SoftPhoneAllowedOperationsChangedListener.
      Parameters:
      listener - Event listener to add.

    • removeSoftPhoneAllowedOperationsChangedListener

      void removeSoftPhoneAllowedOperationsChangedListener(SoftPhoneAllowedOperationsChangedListener listener)
      Unregisters the SoftPhoneAllowedOperationsChangedListener.
      Parameters:
      listener - Event listener to remove.

    • addSoftPhoneMutedChangedListener

      void addSoftPhoneMutedChangedListener(SoftPhoneMutedChangedListener listener)
      Registers the SoftPhoneMutedChangedListener.
      Parameters:
      listener - Event listener to add.

    • removeSoftPhoneMutedChangedListener

      void removeSoftPhoneMutedChangedListener(SoftPhoneMutedChangedListener listener)
      Unregisters the SoftPhoneMutedChangedListener.
      Parameters:
      listener - Event listener to remove.

    • addSoftPhoneSpeakerVolumeChangedListener

      void addSoftPhoneSpeakerVolumeChangedListener(SoftPhoneSpeakerVolumeChangedListener listener)
      Registers the SoftPhoneSpeakerVolumeChangedListener.
      Parameters:
      listener - Event listener to add.

    • removeSoftPhoneSpeakerVolumeChangedListener

      void removeSoftPhoneSpeakerVolumeChangedListener(SoftPhoneSpeakerVolumeChangedListener listener)
      Unregisters the SoftPhoneSpeakerVolumeChangedListener.
      Parameters:
      listener - Event listener to remove.

    • changeSpeakerVolume

      void changeSpeakerVolume(SoftPhoneSpeakerVolumeChange volumeChange) throws Exception, altitude.integrationServer.exceptions.ISException
      Increments or decrements the speaker volume.
      Parameters:
      volumeChange - Type of volume change.

      Since the value is updated asynchronously, an immediate call to the SpeakerVolume property can return the former value.

      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • forceHangUp

      void forceHangUp() throws Exception, altitude.integrationServer.exceptions.ISException
      Hang up calls during the dialing phase, allowing the agent to react to network messages.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getAgent

      IAgent getAgent() throws Exception, altitude.integrationServer.exceptions.ISException
      The agent associated with the soft phone.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getAllowedOperations

      SoftPhoneCanDo getAllowedOperations() throws Exception, altitude.integrationServer.exceptions.ISException
      Operations that can be performed.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getEnabled

      boolean getEnabled() throws Exception, altitude.integrationServer.exceptions.ISException
      True if the soft phone is enabled.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getMuted

      boolean getMuted() throws Exception, altitude.integrationServer.exceptions.ISException
      If true, the microphone is muted.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getSpeakerVolume

      int getSpeakerVolume() throws Exception, altitude.integrationServer.exceptions.ISException
      Speaker volume as a percentage, with 0 being no sound and 100 being full volume.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • setMuted

      void setMuted(boolean muted) throws Exception, altitude.integrationServer.exceptions.ISException
      Set the microphone to muted or not muted.
      Parameters:
      muted - If true, set the microphone to muted.

      Since the value is updated asynchronously, an immediate call to the Muted property can return the former value.

      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • setSpeakerVolume

      void setSpeakerVolume(int volume) throws Exception, altitude.integrationServer.exceptions.ISException
      Sets the speaker volume as a percentage, with 0 being no sound and 100 being full volume. If the supplied value is outside of the range then the nearest valid value will be used.
      Parameters:
      volume - The value of the volume.

      Since the value is updated asynchronously, an immediate call to the SpeakerVolume property can return the former value.

      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getUrl

      String getUrl() throws Exception
      Gets the URL of the SoftPhone object in the IntegrationServer. The URL can be used to initialize the soft phone standalone component.
      Throws:
      Exception