public class Reference
extends java.lang.Object
implements java.io.Serializable
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
| Constructor and Description |
|---|
Reference() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getType()
The type of the reference.
|
java.lang.String |
getValue()
A valid value for the reference.
|
int |
hashCode() |
void |
setType(ReferenceType type)
The type of the reference.
|
void |
setType(java.lang.String type)
The type of the reference.
|
void |
setValue(java.lang.String value)
A valid value for the reference.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
Reference |
withType(ReferenceType type)
The type of the reference.
|
Reference |
withType(java.lang.String type)
The type of the reference.
|
Reference |
withValue(java.lang.String value)
A valid value for the reference.
|
public java.lang.String getValue()
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Constraints:
Length: 0 - 4096
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
public void setValue(java.lang.String value)
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Constraints:
Length: 0 - 4096
value - A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
public Reference withValue(java.lang.String value)
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 4096
value - A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
public java.lang.String getType()
The type of the reference. DATE must be of type Epoch
timestamp.
Constraints:
Allowed Values: URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
The type of the reference. DATE must be of type
Epoch timestamp.
ReferenceTypepublic void setType(java.lang.String type)
The type of the reference. DATE must be of type Epoch
timestamp.
Constraints:
Allowed Values: URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
type -
The type of the reference. DATE must be of type
Epoch timestamp.
ReferenceTypepublic Reference withType(java.lang.String type)
The type of the reference. DATE must be of type Epoch
timestamp.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
type -
The type of the reference. DATE must be of type
Epoch timestamp.
ReferenceTypepublic void setType(ReferenceType type)
The type of the reference. DATE must be of type Epoch
timestamp.
Constraints:
Allowed Values: URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
type -
The type of the reference. DATE must be of type
Epoch timestamp.
ReferenceTypepublic Reference withType(ReferenceType type)
The type of the reference. DATE must be of type Epoch
timestamp.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
type -
The type of the reference. DATE must be of type
Epoch timestamp.
ReferenceTypepublic java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object