com.bt.sdk.capabilities.session.thirdpartycall
Class ThirdPartyCall

java.lang.Object
  extended by com.bt.sdk.capabilities.session.thirdpartycall.ThirdPartyCall

public class ThirdPartyCall
extends java.lang.Object

A databag containing information about a ThirdPartyCall placed. @see SessionThirdPartyCallManager makeCall() method.


Constructor Summary
ThirdPartyCall()
          Default Constructor
ThirdPartyCall(java.lang.String callingParty, java.lang.String calledParty)
          Creates a new ThirdPartyCall object.
ThirdPartyCall(java.lang.String callingParty, java.lang.String calledParty, int dialTimeoutSec)
          Creates a new ThirdPartyCall object.
 
Method Summary
 int getAnnouncementType()
           
 java.lang.String getCalledParty()
           
 java.lang.String getCallId()
           
 com.bt.sdk.capabilities.session.thirdpartycall.CallInformation getCallInformation()
           
 java.lang.String getCallingParty()
           
 int getDialTimeoutSec()
           
 void setAnnouncementType(int newValue)
           
 void setCalledParty(java.lang.String newValue)
           
 void setCallId(java.lang.String newValue)
           
 void setCallInformation(com.bt.sdk.capabilities.session.thirdpartycall.CallInformation newValue)
           
 void setCallingParty(java.lang.String newValue)
           
 void setDialTimeoutSec(int newValue)
           
 void updateCallStatus()
          Updates the status of the call from the service.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ThirdPartyCall

public ThirdPartyCall()
Default Constructor


ThirdPartyCall

public ThirdPartyCall(java.lang.String callingParty,
                      java.lang.String calledParty,
                      int dialTimeoutSec)
Creates a new ThirdPartyCall object.

Parameters:
callingParty - The string URI of the calling party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
calledParty - The string URI of the called party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
dialTimeoutSec - Time (in seconds) to wait for caller or callee to answer. The default is 0 for no timeout.

ThirdPartyCall

public ThirdPartyCall(java.lang.String callingParty,
                      java.lang.String calledParty)
Creates a new ThirdPartyCall object.

Parameters:
callingParty - The string URI of the calling party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
calledParty - The string URI of the called party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'
Method Detail

getCallId

public java.lang.String getCallId()
Returns:
callId The call identifier.

setCallId

public void setCallId(java.lang.String newValue)
Parameters:
callId - The call identifier.

getCallingParty

public java.lang.String getCallingParty()
Returns:
callingParty The string URI of the calling party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'

setCallingParty

public void setCallingParty(java.lang.String newValue)
Parameters:
callingParty - The string URI of the calling party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'

getCalledParty

public java.lang.String getCalledParty()
Returns:
calledParty The string URI of the called party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'

setCalledParty

public void setCalledParty(java.lang.String newValue)
Parameters:
calledParty - The string URI of the called party's endpoint. At the time of release, uris should start with 'tel:' or 'sip:', but are subject to change. Eg: 'tel:447700900123', 'sip:user@domain.com'

getCallInformation

public com.bt.sdk.capabilities.session.thirdpartycall.CallInformation getCallInformation()
Returns:
callInformation A databag with accessors for the call statistics such as duration, start time, call status, and termination cause.

setCallInformation

public void setCallInformation(com.bt.sdk.capabilities.session.thirdpartycall.CallInformation newValue)
Parameters:
callInformation - A databag with accessors for the call statistics such as duration, start time, call status, and termination cause.

getDialTimeoutSec

public int getDialTimeoutSec()
Returns:
dialTimeoutSec Time (in seconds) to wait for caller or callee to answer. The default is 0 for no timeout.

setDialTimeoutSec

public void setDialTimeoutSec(int newValue)
Parameters:
dialTimeoutSec - Time (in seconds) to wait for caller or callee to answer. The default is 0 for no timeout.

getAnnouncementType

public int getAnnouncementType()
Returns:
announcementType Value indicating the type of announcement played on joining a conference. See the sdk portal for information on these values.

setAnnouncementType

public void setAnnouncementType(int newValue)
Parameters:
announcementType - Value indicating the type of announcement played on joining a conference. See the sdk portal for information on these values.

updateCallStatus

public void updateCallStatus()
Updates the status of the call from the service.