|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
com.genesyslab.platform.contacts.protocol.contactserver.requests.RequestIdentifyContact
public final class RequestIdentifyContact
This request is intended for identifying a Contact based on user data values.
If one or more Contact is found, the Contact identifiers are returned in EventIdentifyContact.
If no matching Contact is found, then a new Contact may be created.
Required parameters:
Name | Description |
---|---|
setTenantId(java.lang.Integer) |
The unique tenant ID. |
Name | Description |
---|---|
EventIdentifyContact |
This event returns a list of one or more Contact IDs based on user data values specified in the related RequestIdentifyContact request. Use this event to check the number of matching contacts, the specific ID(s), or to see if a new contact was created successfully. |
EventError |
Indicates that the request encountered an error. |
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Fields inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage |
---|
REF_ID_KEY |
Constructor Summary | |
---|---|
RequestIdentifyContact()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static RequestIdentifyContact |
create()
|
com.genesyslab.platform.commons.protocol.runtime.DataSupport |
createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
|
boolean |
equals(java.lang.Object obj)
|
java.util.Map |
getCompounds()
|
java.lang.Boolean |
getCreateContact()
This string specifies whether to get a creation strategy from the Media configuration. |
java.util.List |
getCustomPackagers()
|
java.util.Date |
getDatePattern()
A string to specify the date pattern format. |
java.lang.String |
getMediaType()
UCS uses this parameter to apply the contact identification strategy based on your configuration settings. |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
KeyValueCollection |
getOtherFields()
|
java.lang.Boolean |
getReturnUnique()
This parameter specifies behavior if more than 1 contact is found. |
java.lang.String |
getSubscriberId()
The subscriber (i.e. line of business) within the tenant to which the contact belongs to. |
java.lang.Integer |
getTenantId()
|
java.lang.Boolean |
getUpdateUserData()
|
int |
hashCode()
|
void |
setCreateContact(java.lang.Boolean value)
This string specifies whether to get a creation strategy from the Media configuration. |
void |
setDatePattern(java.util.Date value)
A string to specify the date pattern format. |
void |
setMediaType(java.lang.String value)
UCS uses this parameter to apply the contact identification strategy based on your configuration settings. |
void |
setOtherFields(KeyValueCollection value)
|
void |
setReturnUnique(java.lang.Boolean value)
This parameter specifies behavior if more than 1 contact is found. |
void |
setSubscriberId(java.lang.String value)
The subscriber (i.e. line of business) within the tenant to which the contact belongs to. |
void |
setTenantId(java.lang.Integer value)
|
void |
setUpdateUserData(java.lang.Boolean value)
|
Methods inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage |
---|
getEndpoint, getLazyParser, getMessageAttribute, getProtocolId, getReferenceId, getRequestorInfo, retreiveReference, setEndpoint, setProtocolId, setReferenceId, setReferenceId, setRequestorInfo, toString, toString, toString, toString, updateReference |
Methods inherited from class com.genesyslab.platform.commons.protocol.Message |
---|
cloneMessage, getProtocolDescription, messageId, messageName, setProtocolDescription |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolDescriptionSupport |
---|
getProtocolDescription |
Field Detail |
---|
public static final int ID
public static final java.lang.String NAME
Constructor Detail |
---|
public RequestIdentifyContact()
Method Detail |
---|
public static RequestIdentifyContact create()
public java.lang.Boolean getReturnUnique()
public void setReturnUnique(java.lang.Boolean value)
public java.lang.Boolean getUpdateUserData()
public void setUpdateUserData(java.lang.Boolean value)
public java.util.Date getDatePattern()
public void setDatePattern(java.util.Date value)
public java.lang.Boolean getCreateContact()
public void setCreateContact(java.lang.Boolean value)
public java.lang.Integer getTenantId()
public void setTenantId(java.lang.Integer value)
public java.lang.String getSubscriberId()
public void setSubscriberId(java.lang.String value)
public java.lang.String getMediaType()
public void setMediaType(java.lang.String value)
public KeyValueCollection getOtherFields()
public void setOtherFields(KeyValueCollection value)
public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |