de.starface.integration.uci.java.v30.types
Class Call

java.lang.Object
  extended by de.starface.integration.uci.java.v30.types.Call
All Implemented Interfaces:
Serializable

@RpcValueObject
public class Call
extends Object
implements Serializable

This object holds the properties of the call as returned by UciCallEvents.receiveCallState(Call).

See Also:
Serialized Form

Field Summary
protected  String avatarHash
          AvatarHash of Caller
protected  String calledName
          The name of the person being called
protected  String calledNumber
          The phone number that has been called
protected  Boolean caller
          Is caller
protected  String callerName
          The name of the person calling
protected  String callerNumber
          The number of the caller
protected  List<String> channelNames
          The channel name
protected  boolean conferenceAdmin
          The current call is an conference admin
protected  String conferenceRoomId
          The conference room identifikation
protected  Date connectedTimestamp
          The point of time when the call is connected
protected  boolean consultationCall
          Is this call a consultationCall
protected  String doorlineCamUrl
          Doorline Cam of Caller
protected  String doorlineDtmfCode
          Doorline dtm code
protected  Integer doorlineImageProviderId
          Doorline image provider id
protected  long duration
          The time between now and the connected timestamp/timestamp
protected  String forwarderCallerIdName
          Forwarder callerIdName of farwarder
protected  String forwarderCallerIdNumber
          Forwarder callerIdNumber of farwarder
protected  ForwardType forwardType
          Forward type
protected  String groupId
          The id of the group if this call was received by a group (the empty string otherwise)
protected  String id
          The id of the call in form of a UUID as String
protected  String jabberId
          The jabber id
protected  List<String> peerNames
          Name of the device
protected  Boolean recorded
          Is in the current call recording activated
protected  Boolean recorder
          Is in the current call recorded by the user
protected  Boolean recordOwner
          Is the user a monitor owner
protected  String referenceOfConsultation
          The reference of the outher side of consultation
protected  List<String> sipCallIds
          The sip callId
protected  CallState state
          The state of the call
protected  Date timestamp
          The point of time when the call reached the state
 
Constructor Summary
Call()
           
 
Method Summary
 boolean equals(Object obj)
           
 String getAvatarHash()
           
 String getCalledName()
           
 String getCalledNumber()
           
 String getCallerName()
           
 String getCallerNumber()
           
 List<String> getChannelNames()
           
 String getConferenceRoomId()
           
 Date getConnectedTimestamp()
           
 String getDoorlineCamUrl()
           
 String getDoorlineDtmfCode()
           
 Integer getDoorlineImageProviderId()
           
 long getDuration()
           
 String getForwarderCallerIdName()
           
 String getForwarderCallerIdNumber()
           
 ForwardType getForwardType()
           
 String getGroupId()
           
 String getId()
           
 String getJabberId()
           
 List<String> getPeerNames()
           
 String getReferenceOfConsultation()
           
 List<String> getSipCallIds()
           
 CallState getState()
           
 Date getTimestamp()
           
 int hashCode()
           
 Boolean isCaller()
           
 boolean isConferenceAdmin()
           
 boolean isConsultationCall()
           
 boolean isGroupCall()
           
 Boolean isRecorded()
           
 Boolean isRecorder()
           
 Boolean isRecordOwner()
           
 void setAvatarHash(String avatarHash)
           
 void setCalledName(String calledName)
           
 void setCalledNumber(String calledNumber)
           
 void setCaller(Boolean caller)
           
 void setCallerName(String callerName)
           
 void setCallerNumber(String callerNumber)
           
 void setChannelNames(List<String> channelNames)
           
 void setConferenceAdmin(boolean conferenceAdmin)
           
 void setConferenceRoomId(String conferenceRoomId)
           
 void setConnectedTimestamp(Date connectedTimestamp)
           
 void setConsultationCall(boolean consultationCall)
           
 void setDoorlineCamUrl(String doorlineCamUrl)
           
 void setDoorlineDtmfCode(String doorlineDtmfCode)
           
 void setDoorlineImageProviderId(Integer doorlineImageProviderId)
           
 void setDuration(long duration)
           
 void setForwarderCallerIdName(String forwarderCallerIdName)
           
 void setForwarderCallerIdNumber(String forwarderCallerIdNumber)
           
 void setForwardType(ForwardType forwardType)
           
 void setGroupId(String groupId)
           
 void setId(String id)
           
 void setJabberId(String jabberId)
           
 void setPeerNames(List<String> peerNames)
           
 void setRecorded(Boolean recorded)
           
 void setRecorder(Boolean recorder)
           
 void setRecordOwner(Boolean recordOwner)
           
 void setReferenceOfConsultation(String referenceOfConsultation)
           
 void setSipCallIds(List<String> sipCallIds)
           
 void setState(CallState state)
           
 void setTimestamp(Date timestamp)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

id

@RpcValue
protected String id
The id of the call in form of a UUID as String


state

@RpcValue
protected CallState state
The state of the call


timestamp

@RpcValue
protected Date timestamp
The point of time when the call reached the state


calledNumber

@RpcValue
protected String calledNumber
The phone number that has been called


calledName

@RpcValue
protected String calledName
The name of the person being called


callerNumber

@RpcValue
protected String callerNumber
The number of the caller


callerName

@RpcValue
protected String callerName
The name of the person calling


groupId

@RpcValue(minVersion=22)
protected String groupId
The id of the group if this call was received by a group (the empty string otherwise)


peerNames

@RpcValue(minVersion=30)
protected List<String> peerNames
Name of the device


channelNames

@RpcValue(minVersion=30)
protected List<String> channelNames
The channel name


sipCallIds

@RpcValue(minVersion=30)
protected List<String> sipCallIds
The sip callId


caller

@RpcValue(minVersion=30)
protected Boolean caller
Is caller


connectedTimestamp

@RpcValue(minVersion=30)
protected Date connectedTimestamp
The point of time when the call is connected


recorded

@RpcValue(minVersion=30)
protected Boolean recorded
Is in the current call recording activated


recorder

@RpcValue(minVersion=30)
protected Boolean recorder
Is in the current call recorded by the user


recordOwner

@RpcValue(minVersion=30)
protected Boolean recordOwner
Is the user a monitor owner


avatarHash

@RpcValue(minVersion=30)
protected String avatarHash
AvatarHash of Caller


doorlineCamUrl

@RpcValue(minVersion=30)
protected String doorlineCamUrl
Doorline Cam of Caller


doorlineDtmfCode

@RpcValue(minVersion=30)
protected String doorlineDtmfCode
Doorline dtm code


doorlineImageProviderId

@RpcValue(minVersion=30)
protected Integer doorlineImageProviderId
Doorline image provider id


forwardType

@RpcValue(minVersion=30)
protected ForwardType forwardType
Forward type


forwarderCallerIdName

@RpcValue(minVersion=30)
protected String forwarderCallerIdName
Forwarder callerIdName of farwarder


forwarderCallerIdNumber

@RpcValue(minVersion=30)
protected String forwarderCallerIdNumber
Forwarder callerIdNumber of farwarder


conferenceRoomId

@RpcValue(minVersion=30)
protected String conferenceRoomId
The conference room identifikation


conferenceAdmin

@RpcValue(minVersion=30)
protected boolean conferenceAdmin
The current call is an conference admin


referenceOfConsultation

@RpcValue(minVersion=30)
protected String referenceOfConsultation
The reference of the outher side of consultation


duration

@RpcValue(minVersion=30)
protected long duration
The time between now and the connected timestamp/timestamp


consultationCall

@RpcValue(minVersion=30)
protected boolean consultationCall
Is this call a consultationCall


jabberId

@RpcValue(minVersion=30)
protected String jabberId
The jabber id

Constructor Detail

Call

public Call()
Method Detail

getConnectedTimestamp

public Date getConnectedTimestamp()

setConnectedTimestamp

public void setConnectedTimestamp(Date connectedTimestamp)

getId

public String getId()

setId

public void setId(String id)

getState

public CallState getState()

setState

public void setState(CallState state)

getTimestamp

public Date getTimestamp()

setTimestamp

public void setTimestamp(Date timestamp)

getCalledNumber

public String getCalledNumber()

setCalledNumber

public void setCalledNumber(String calledNumber)

getCalledName

public String getCalledName()

setCalledName

public void setCalledName(String calledName)

getCallerNumber

public String getCallerNumber()

setCallerNumber

public void setCallerNumber(String callerNumber)

getCallerName

public String getCallerName()

setCallerName

public void setCallerName(String callerName)

getChannelNames

public List<String> getChannelNames()

setChannelNames

public void setChannelNames(List<String> channelNames)

getGroupId

public String getGroupId()

setGroupId

public void setGroupId(String groupId)

getPeerNames

public List<String> getPeerNames()

setPeerNames

public void setPeerNames(List<String> peerNames)

isGroupCall

public boolean isGroupCall()

setRecorder

public void setRecorder(Boolean recorder)

setRecorded

public void setRecorded(Boolean recorded)

setRecordOwner

public void setRecordOwner(Boolean recordOwner)

getAvatarHash

public String getAvatarHash()

setAvatarHash

public void setAvatarHash(String avatarHash)

getDoorlineCamUrl

public String getDoorlineCamUrl()

setDoorlineCamUrl

public void setDoorlineCamUrl(String doorlineCamUrl)

getDoorlineDtmfCode

public String getDoorlineDtmfCode()

setDoorlineDtmfCode

public void setDoorlineDtmfCode(String doorlineDtmfCode)

getDoorlineImageProviderId

public Integer getDoorlineImageProviderId()

setDoorlineImageProviderId

public void setDoorlineImageProviderId(Integer doorlineImageProviderId)

getSipCallIds

public List<String> getSipCallIds()

setSipCallIds

public void setSipCallIds(List<String> sipCallIds)

isCaller

public Boolean isCaller()

setCaller

public void setCaller(Boolean caller)

getForwardType

public ForwardType getForwardType()

setForwardType

public void setForwardType(ForwardType forwardType)

getForwarderCallerIdName

public String getForwarderCallerIdName()

setForwarderCallerIdName

public void setForwarderCallerIdName(String forwarderCallerIdName)

getForwarderCallerIdNumber

public String getForwarderCallerIdNumber()

setForwarderCallerIdNumber

public void setForwarderCallerIdNumber(String forwarderCallerIdNumber)

getConferenceRoomId

public String getConferenceRoomId()

setConferenceRoomId

public void setConferenceRoomId(String conferenceRoomId)

isRecorder

public Boolean isRecorder()

isRecorded

public Boolean isRecorded()

isRecordOwner

public Boolean isRecordOwner()

isConferenceAdmin

public boolean isConferenceAdmin()

setConferenceAdmin

public void setConferenceAdmin(boolean conferenceAdmin)

getDuration

public long getDuration()

setDuration

public void setDuration(long duration)

isConsultationCall

public boolean isConsultationCall()

setConsultationCall

public void setConsultationCall(boolean consultationCall)

getReferenceOfConsultation

public String getReferenceOfConsultation()

setReferenceOfConsultation

public void setReferenceOfConsultation(String referenceOfConsultation)

getJabberId

public String getJabberId()
Returns:
the jabberId

setJabberId

public void setJabberId(String jabberId)
Parameters:
jabberId - the jabberId to set

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2012 STARFACE GmbH. All rights reserved.