com.mypurecloud.sdk.model.Conversation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of platform-client Show documentation
Show all versions of platform-client Show documentation
The official Java SDK for the PureCloud Platform API SDK
The newest version!
package com.mypurecloud.sdk.model;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import com.mypurecloud.sdk.model.Participant;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.io.Serializable;
/**
* Conversation
*/
public class Conversation implements Serializable {
private String id = null;
private String name = null;
private Date startTime = null;
private Date endTime = null;
private String address = null;
private List participants = new ArrayList();
private List conversationIds = new ArrayList();
private Integer maxParticipants = null;
/**
* On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.
*/
public enum RecordingStateEnum {
OUTDATEDSDKVERSION("OutdatedSdkVersion"),
ACTIVE("ACTIVE"),
PAUSED("PAUSED"),
NONE("NONE");
private String value;
RecordingStateEnum(String value) {
this.value = value;
}
@JsonCreator
public static RecordingStateEnum fromString(String key) {
if (key == null) return null;
for (RecordingStateEnum value : RecordingStateEnum.values()) {
if (key.equalsIgnoreCase(value.toString())) {
return value;
}
}
return RecordingStateEnum.values()[0];
}
@Override
@JsonValue
public String toString() {
return String.valueOf(value);
}
}
private RecordingStateEnum recordingState = null;
/**
* The conversation's state. Values can be: 'disconnected'
*/
public enum StateEnum {
OUTDATEDSDKVERSION("OutdatedSdkVersion"),
ALERTING("alerting"),
DIALING("dialing"),
CONTACTING("contacting"),
OFFERING("offering"),
CONNECTED("connected"),
DISCONNECTED("disconnected"),
TERMINATED("terminated"),
CONVERTING("converting"),
UPLOADING("uploading"),
TRANSMITTING("transmitting"),
NONE("none");
private String value;
StateEnum(String value) {
this.value = value;
}
@JsonCreator
public static StateEnum fromString(String key) {
if (key == null) return null;
for (StateEnum value : StateEnum.values()) {
if (key.equalsIgnoreCase(value.toString())) {
return value;
}
}
return StateEnum.values()[0];
}
@Override
@JsonValue
public String toString() {
return String.valueOf(value);
}
}
private StateEnum state = null;
private String selfUri = null;
@ApiModelProperty(example = "null", value = "The globally unique identifier for the object.")
@JsonProperty("id")
public String getId() {
return id;
}
/**
**/
public Conversation name(String name) {
this.name = name;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("name")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
/**
* The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
**/
public Conversation startTime(Date startTime) {
this.startTime = startTime;
return this;
}
@ApiModelProperty(example = "null", required = true, value = "The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ")
@JsonProperty("startTime")
public Date getStartTime() {
return startTime;
}
public void setStartTime(Date startTime) {
this.startTime = startTime;
}
/**
* The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
**/
public Conversation endTime(Date endTime) {
this.endTime = endTime;
return this;
}
@ApiModelProperty(example = "null", value = "The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ")
@JsonProperty("endTime")
public Date getEndTime() {
return endTime;
}
public void setEndTime(Date endTime) {
this.endTime = endTime;
}
/**
* The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound.
**/
public Conversation address(String address) {
this.address = address;
return this;
}
@ApiModelProperty(example = "null", value = "The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound.")
@JsonProperty("address")
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
/**
* The list of all participants in the conversation.
**/
public Conversation participants(List participants) {
this.participants = participants;
return this;
}
@ApiModelProperty(example = "null", required = true, value = "The list of all participants in the conversation.")
@JsonProperty("participants")
public List getParticipants() {
return participants;
}
public void setParticipants(List participants) {
this.participants = participants;
}
/**
* A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.
**/
public Conversation conversationIds(List conversationIds) {
this.conversationIds = conversationIds;
return this;
}
@ApiModelProperty(example = "null", value = "A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.")
@JsonProperty("conversationIds")
public List getConversationIds() {
return conversationIds;
}
public void setConversationIds(List conversationIds) {
this.conversationIds = conversationIds;
}
/**
* If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.
**/
public Conversation maxParticipants(Integer maxParticipants) {
this.maxParticipants = maxParticipants;
return this;
}
@ApiModelProperty(example = "null", value = "If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.")
@JsonProperty("maxParticipants")
public Integer getMaxParticipants() {
return maxParticipants;
}
public void setMaxParticipants(Integer maxParticipants) {
this.maxParticipants = maxParticipants;
}
/**
* On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.
**/
public Conversation recordingState(RecordingStateEnum recordingState) {
this.recordingState = recordingState;
return this;
}
@ApiModelProperty(example = "null", value = "On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.")
@JsonProperty("recordingState")
public RecordingStateEnum getRecordingState() {
return recordingState;
}
public void setRecordingState(RecordingStateEnum recordingState) {
this.recordingState = recordingState;
}
/**
* The conversation's state. Values can be: 'disconnected'
**/
public Conversation state(StateEnum state) {
this.state = state;
return this;
}
@ApiModelProperty(example = "null", value = "The conversation's state. Values can be: 'disconnected'")
@JsonProperty("state")
public StateEnum getState() {
return state;
}
public void setState(StateEnum state) {
this.state = state;
}
@ApiModelProperty(example = "null", value = "The URI for this object")
@JsonProperty("selfUri")
public String getSelfUri() {
return selfUri;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Conversation conversation = (Conversation) o;
return Objects.equals(this.id, conversation.id) &&
Objects.equals(this.name, conversation.name) &&
Objects.equals(this.startTime, conversation.startTime) &&
Objects.equals(this.endTime, conversation.endTime) &&
Objects.equals(this.address, conversation.address) &&
Objects.equals(this.participants, conversation.participants) &&
Objects.equals(this.conversationIds, conversation.conversationIds) &&
Objects.equals(this.maxParticipants, conversation.maxParticipants) &&
Objects.equals(this.recordingState, conversation.recordingState) &&
Objects.equals(this.state, conversation.state) &&
Objects.equals(this.selfUri, conversation.selfUri);
}
@Override
public int hashCode() {
return Objects.hash(id, name, startTime, endTime, address, participants, conversationIds, maxParticipants, recordingState, state, selfUri);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Conversation {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" startTime: ").append(toIndentedString(startTime)).append("\n");
sb.append(" endTime: ").append(toIndentedString(endTime)).append("\n");
sb.append(" address: ").append(toIndentedString(address)).append("\n");
sb.append(" participants: ").append(toIndentedString(participants)).append("\n");
sb.append(" conversationIds: ").append(toIndentedString(conversationIds)).append("\n");
sb.append(" maxParticipants: ").append(toIndentedString(maxParticipants)).append("\n");
sb.append(" recordingState: ").append(toIndentedString(recordingState)).append("\n");
sb.append(" state: ").append(toIndentedString(state)).append("\n");
sb.append(" selfUri: ").append(toIndentedString(selfUri)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}