com.ringcentral.definitions.ForwardingInfo Maven / Gradle / Ivy
package com.ringcentral.definitions;
/**
* Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded
*/
public class ForwardingInfo {
/**
* Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers
*/
public Boolean notifyMySoftPhones;
/**
* 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'
*/
public Boolean notifyAdminSoftPhones;
/**
* Number of rings before forwarding starts
* Format: int32
*/
public Long softPhonesRingCount;
/**
* 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
*/
public Boolean softPhonesAlwaysRing;
/**
* 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
*/
public String ringingMode;
/**
* Information on a call forwarding rule
*/
public ForwardingRuleInfo[] rules;
/**
* 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`
*/
public Boolean softPhonesPositionTop;
/**
* Deprecated parameter. Specifies if mobile timeout is activated for the rule
*/
public Boolean mobileTimeout;
public ForwardingInfo notifyMySoftPhones(Boolean notifyMySoftPhones) {
this.notifyMySoftPhones = notifyMySoftPhones;
return this;
}
public ForwardingInfo notifyAdminSoftPhones(Boolean notifyAdminSoftPhones) {
this.notifyAdminSoftPhones = notifyAdminSoftPhones;
return this;
}
public ForwardingInfo softPhonesRingCount(Long softPhonesRingCount) {
this.softPhonesRingCount = softPhonesRingCount;
return this;
}
public ForwardingInfo softPhonesAlwaysRing(Boolean softPhonesAlwaysRing) {
this.softPhonesAlwaysRing = softPhonesAlwaysRing;
return this;
}
public ForwardingInfo ringingMode(String ringingMode) {
this.ringingMode = ringingMode;
return this;
}
public ForwardingInfo rules(ForwardingRuleInfo[] rules) {
this.rules = rules;
return this;
}
public ForwardingInfo softPhonesPositionTop(Boolean softPhonesPositionTop) {
this.softPhonesPositionTop = softPhonesPositionTop;
return this;
}
public ForwardingInfo mobileTimeout(Boolean mobileTimeout) {
this.mobileTimeout = mobileTimeout;
return this;
}
}