Package com.ringcentral.definitions

Class ForwardingInfo

java.lang.Object

com.ringcentral.definitions.ForwardingInfo

public class ForwardingInfo
extends Object

Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	mobileTimeout	Deprecated parameter.
Boolean	notifyAdminSoftPhones	Deprecated parameter.
Boolean	notifyMySoftPhones	Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers
String	ringingMode	Specifies the order in which the forwarding numbers ring.
ForwardingRuleInfo[]	rules	Information on a call forwarding rule
Boolean	softPhonesAlwaysRing	Specifies that desktop and mobile applications of the user will ring till the end of their forwarding list.
Boolean	softPhonesPositionTop	Specifies if desktop and mobile applications of the user are notified before (true) or after (false) forwarding the incoming call to desk phones and forwarding numbers.
Long	softPhonesRingCount	Number of rings before forwarding starts Format: int32

Constructor Summary

Constructors

Constructor	Description
ForwardingInfo()

Method Summary

Modifier and Type	Method	Description
ForwardingInfo	mobileTimeout(Boolean mobileTimeout)
ForwardingInfo	notifyAdminSoftPhones(Boolean notifyAdminSoftPhones)
ForwardingInfo	notifyMySoftPhones(Boolean notifyMySoftPhones)
ForwardingInfo	ringingMode(String ringingMode)
ForwardingInfo	rules(ForwardingRuleInfo[] rules)
ForwardingInfo	softPhonesAlwaysRing(Boolean softPhonesAlwaysRing)
ForwardingInfo	softPhonesPositionTop(Boolean softPhonesPositionTop)
ForwardingInfo	softPhonesRingCount(Long softPhonesRingCount)

Methods inherited from class java.lang.Object

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

Field Details

notifyMySoftPhones

public Boolean notifyMySoftPhones

Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers

notifyAdminSoftPhones

public Boolean notifyAdminSoftPhones

Deprecated parameter. Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is `false`

softPhonesRingCount

public Long softPhonesRingCount

Number of rings before forwarding starts Format: int32

softPhonesAlwaysRing

public Boolean softPhonesAlwaysRing

Specifies that desktop and mobile applications of the user will ring till the end of their forwarding list. If set to `true` then `softPhonesRingCount` is ignored Default: true

ringingMode

public String ringingMode

Specifies the order in which the forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time Enum: Sequentially, Simultaneously

rules

public ForwardingRuleInfo[] rules

Information on a call forwarding rule

softPhonesPositionTop

public Boolean softPhonesPositionTop

Specifies if desktop and mobile applications of the user are notified before (true) or after (false) forwarding the incoming call to desk phones and forwarding numbers. Applicable only if `notifyMySoftPhones` parameter is set to `true`

mobileTimeout

public Boolean mobileTimeout

Deprecated parameter. Specifies if mobile timeout is activated for the rule

Constructor Details

ForwardingInfo

public ForwardingInfo()

Method Details

notifyMySoftPhones

public ForwardingInfo notifyMySoftPhones(Boolean notifyMySoftPhones)

notifyAdminSoftPhones

public ForwardingInfo notifyAdminSoftPhones(Boolean notifyAdminSoftPhones)

softPhonesRingCount

public ForwardingInfo softPhonesRingCount(Long softPhonesRingCount)

softPhonesAlwaysRing

public ForwardingInfo softPhonesAlwaysRing(Boolean softPhonesAlwaysRing)

ringingMode

public ForwardingInfo ringingMode(String ringingMode)

rules

public ForwardingInfo rules(ForwardingRuleInfo[] rules)

softPhonesPositionTop

public ForwardingInfo softPhonesPositionTop(Boolean softPhonesPositionTop)

mobileTimeout

public ForwardingInfo mobileTimeout(Boolean mobileTimeout)