Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentView

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentView

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentView
extends Object
implements Serializable

KnowledgeDocumentView

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KnowledgeDocumentView.QueryTypeEnum	The type of the query that surfaced the document.
static enum	KnowledgeDocumentView.SurfacingMethodEnum	The method how knowledge was surfaced.

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentView()
KnowledgeDocumentView(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeDocumentView	application(KnowledgeSearchClientApplication application)	The client application from which the document was viewed.
KnowledgeDocumentView	conversationContext(KnowledgeConversationContext conversationContext)	Conversation context information if the document was viewed in the context of a conversation.
KnowledgeDocumentView	documentVariationId(String documentVariationId)	The variation of the viewed document.
KnowledgeDocumentView	documentVersionId(String documentVersionId)	The version of the viewed document.
boolean	equals(Object o)
KnowledgeSearchClientApplication	getApplication()
KnowledgeConversationContext	getConversationContext()
String	getDocumentVariationId()
String	getDocumentVersionId()
KnowledgeDocumentView.QueryTypeEnum	getQueryType()
String	getSearchId()
String	getSessionId()
KnowledgeDocumentView.SurfacingMethodEnum	getSurfacingMethod()
int	hashCode()
KnowledgeDocumentView	queryType(KnowledgeDocumentView.QueryTypeEnum queryType)	The type of the query that surfaced the document.
KnowledgeDocumentView	searchId(String searchId)	The search that surfaced the viewed document.
KnowledgeDocumentView	sessionId(String sessionId)	The unique identifier of the knowledge session in which the document was viewed.
void	setApplication(KnowledgeSearchClientApplication application)
void	setConversationContext(KnowledgeConversationContext conversationContext)
void	setDocumentVariationId(String documentVariationId)
void	setDocumentVersionId(String documentVersionId)
void	setQueryType(KnowledgeDocumentView.QueryTypeEnum queryType)
void	setSearchId(String searchId)
void	setSessionId(String sessionId)
void	setSurfacingMethod(KnowledgeDocumentView.SurfacingMethodEnum surfacingMethod)
KnowledgeDocumentView	surfacingMethod(KnowledgeDocumentView.SurfacingMethodEnum surfacingMethod)	The method how knowledge was surfaced.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

KnowledgeDocumentView

public KnowledgeDocumentView()

KnowledgeDocumentView

public KnowledgeDocumentView(Boolean initWithEmptyList)

Method Details

documentVariationId

public KnowledgeDocumentView documentVariationId(String documentVariationId)

The variation of the viewed document.

getDocumentVariationId

public String getDocumentVariationId()

setDocumentVariationId

public void setDocumentVariationId(String documentVariationId)

documentVersionId

public KnowledgeDocumentView documentVersionId(String documentVersionId)

The version of the viewed document.

getDocumentVersionId

public String getDocumentVersionId()

setDocumentVersionId

public void setDocumentVersionId(String documentVersionId)

searchId

public KnowledgeDocumentView searchId(String searchId)

The search that surfaced the viewed document.

getSearchId

public String getSearchId()

setSearchId

public void setSearchId(String searchId)

queryType

public KnowledgeDocumentView queryType(KnowledgeDocumentView.QueryTypeEnum queryType)

The type of the query that surfaced the document.

getQueryType

public KnowledgeDocumentView.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeDocumentView.QueryTypeEnum queryType)

surfacingMethod

public KnowledgeDocumentView surfacingMethod(KnowledgeDocumentView.SurfacingMethodEnum surfacingMethod)

The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.

getSurfacingMethod

public KnowledgeDocumentView.SurfacingMethodEnum getSurfacingMethod()

setSurfacingMethod

public void setSurfacingMethod(KnowledgeDocumentView.SurfacingMethodEnum surfacingMethod)

application

public KnowledgeDocumentView application(KnowledgeSearchClientApplication application)

The client application from which the document was viewed.

getApplication

public KnowledgeSearchClientApplication getApplication()

setApplication

public void setApplication(KnowledgeSearchClientApplication application)

sessionId

public KnowledgeDocumentView sessionId(String sessionId)

The unique identifier of the knowledge session in which the document was viewed.

getSessionId

public String getSessionId()

setSessionId

public void setSessionId(String sessionId)

conversationContext

public KnowledgeDocumentView conversationContext(KnowledgeConversationContext conversationContext)

Conversation context information if the document was viewed in the context of a conversation.

getConversationContext

public KnowledgeConversationContext getConversationContext()

setConversationContext

public void setConversationContext(KnowledgeConversationContext conversationContext)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object