Package com.intercom.api.resources.articles.requests

Class SearchArticlesRequest.Builder

java.lang.Object

com.intercom.api.resources.articles.requests.SearchArticlesRequest.Builder

Enclosing class:

SearchArticlesRequest

public static final class SearchArticlesRequest.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
SearchArticlesRequest	build()
SearchArticlesRequest.Builder	from(SearchArticlesRequest other)
SearchArticlesRequest.Builder	helpCenterId(java.lang.Integer helpCenterId)
SearchArticlesRequest.Builder	helpCenterId(java.util.Optional<java.lang.Integer> helpCenterId)	The ID of the Help Center to search in.
SearchArticlesRequest.Builder	highlight(java.lang.Boolean highlight)
SearchArticlesRequest.Builder	highlight(java.util.Optional<java.lang.Boolean> highlight)	Return a highlighted version of the matching content within your articles.
SearchArticlesRequest.Builder	phrase(java.lang.String phrase)
SearchArticlesRequest.Builder	phrase(java.util.Optional<java.lang.String> phrase)	The phrase within your articles to search for.
SearchArticlesRequest.Builder	state(java.lang.String state)
SearchArticlesRequest.Builder	state(java.util.Optional<java.lang.String> state)	The state of the Articles returned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public SearchArticlesRequest.Builder from(SearchArticlesRequest other)

phrase

public SearchArticlesRequest.Builder phrase(java.util.Optional<java.lang.String> phrase)

The phrase within your articles to search for.

phrase

public SearchArticlesRequest.Builder phrase(java.lang.String phrase)

state

public SearchArticlesRequest.Builder state(java.util.Optional<java.lang.String> state)

The state of the Articles returned. One of published, draft or all.

state

public SearchArticlesRequest.Builder state(java.lang.String state)

helpCenterId

public SearchArticlesRequest.Builder helpCenterId(java.util.Optional<java.lang.Integer> helpCenterId)

The ID of the Help Center to search in.

helpCenterId

public SearchArticlesRequest.Builder helpCenterId(java.lang.Integer helpCenterId)

highlight

public SearchArticlesRequest.Builder highlight(java.util.Optional<java.lang.Boolean> highlight)

Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.

highlight

public SearchArticlesRequest.Builder highlight(java.lang.Boolean highlight)

build

public SearchArticlesRequest build()