Package com.ringcentral.definitions

Class ForwardCallPartyResponse

java.lang.Object

com.ringcentral.definitions.ForwardCallPartyResponse

public class ForwardCallPartyResponse
extends Object

Information on a party of a call session

Field Summary

Fields

Modifier and Type	Field	Description
String	conferenceRole	A party's role in the conference scenarios.
String	direction	Direction of a call Enum: Inbound, Outbound
PartyInfo	from
String	id	Internal identifier of a party
Boolean	muted	Specifies if a call participant is muted or not.
OwnerInfo	owner
ParkInfo	park
RecordingInfo[]	recordings	Active recordings list
String	ringMeRole	A party's role in 'Ring Me'/'RingOut' scenarios.
String	ringOutRole	A party's role in 'Ring Me'/'RingOut' scenarios.
Boolean	standAlone	If `true` then the party is not connected to a session voice conference, `false` means the party is connected to other parties in a session
CallStatusInfo	status
PartyInfo	to

Constructor Summary

Constructors

Constructor	Description
ForwardCallPartyResponse()

Method Summary

Modifier and Type	Method	Description
ForwardCallPartyResponse	conferenceRole(String conferenceRole)
ForwardCallPartyResponse	direction(String direction)
ForwardCallPartyResponse	from(PartyInfo from)
ForwardCallPartyResponse	id(String id)
ForwardCallPartyResponse	muted(Boolean muted)
ForwardCallPartyResponse	owner(OwnerInfo owner)
ForwardCallPartyResponse	park(ParkInfo park)
ForwardCallPartyResponse	recordings(RecordingInfo[] recordings)
ForwardCallPartyResponse	ringMeRole(String ringMeRole)
ForwardCallPartyResponse	ringOutRole(String ringOutRole)
ForwardCallPartyResponse	standAlone(Boolean standAlone)
ForwardCallPartyResponse	status(CallStatusInfo status)
ForwardCallPartyResponse	to(PartyInfo to)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

public String id

Internal identifier of a party

status

public CallStatusInfo status

muted

public Boolean muted

Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces

standAlone

public Boolean standAlone

If `true` then the party is not connected to a session voice conference, `false` means the party is connected to other parties in a session

park

public ParkInfo park

from

public PartyInfo from

to

public PartyInfo to

owner

public OwnerInfo owner

direction

public String direction

Direction of a call Enum: Inbound, Outbound

conferenceRole

public String conferenceRole

A party's role in the conference scenarios. For calls of 'Conference' type only Enum: Host, Participant

ringOutRole

public String ringOutRole

A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only Enum: Initiator, Target

ringMeRole

public String ringMeRole

A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only Enum: Initiator, Target

recordings

public RecordingInfo[] recordings

Active recordings list

Constructor Details

ForwardCallPartyResponse

public ForwardCallPartyResponse()

Method Details

id

public ForwardCallPartyResponse id(String id)

status

public ForwardCallPartyResponse status(CallStatusInfo status)

muted

public ForwardCallPartyResponse muted(Boolean muted)

standAlone

public ForwardCallPartyResponse standAlone(Boolean standAlone)

park

public ForwardCallPartyResponse park(ParkInfo park)

from

public ForwardCallPartyResponse from(PartyInfo from)

to

public ForwardCallPartyResponse to(PartyInfo to)

owner

public ForwardCallPartyResponse owner(OwnerInfo owner)

direction

public ForwardCallPartyResponse direction(String direction)

conferenceRole

public ForwardCallPartyResponse conferenceRole(String conferenceRole)

ringOutRole

public ForwardCallPartyResponse ringOutRole(String ringOutRole)

ringMeRole

public ForwardCallPartyResponse ringMeRole(String ringMeRole)

recordings

public ForwardCallPartyResponse recordings(RecordingInfo[] recordings)