Package zendesk.support

Class SuggestedArticleSearch.Builder

java.lang.Object

zendesk.support.SuggestedArticleSearch.Builder

Enclosing class:

SuggestedArticleSearch

public static class SuggestedArticleSearch.Builder
extends java.lang.Object

This is a builder class which is used to generate a SuggestedArticleSearch

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SuggestedArticleSearch	build() Builds a HelpCenterSearch object with the specified parameters.
SuggestedArticleSearch.Builder	forLocale(java.util.Locale locale) Specifies the locale to perform the search in.
SuggestedArticleSearch.Builder	withCategoryId(java.lang.Long categoryId) Specifies the category id to restrict the results to.
SuggestedArticleSearch.Builder	withLabelNames(java.lang.String... labelNames) Specifies the label names to restrict the results to.
SuggestedArticleSearch.Builder	withQuery(java.lang.String query) Specifies the free-form query to perform.
SuggestedArticleSearch.Builder	withSectionId(java.lang.Long sectionId) Specifies the section id to restrict the results to.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withQuery

public SuggestedArticleSearch.Builder withQuery(java.lang.String query)

Specifies the free-form query to perform.

Parameters:

query - The free-form query to perform

Returns:

The Builder

forLocale

public SuggestedArticleSearch.Builder forLocale(java.util.Locale locale)

Specifies the locale to perform the search in. Note that this must be a supported locale by your Help Center instance

Parameters:

locale - The locale to search in

Returns:

The Builder

withLabelNames

public SuggestedArticleSearch.Builder withLabelNames(java.lang.String... labelNames)

Specifies the label names to restrict the results to. Note that ALL label names must match for an article to be includes in the search results.

Parameters:

labelNames - The label names to restrict the results to

Returns:

The builder

withCategoryId

public SuggestedArticleSearch.Builder withCategoryId(java.lang.Long categoryId)

Specifies the category id to restrict the results to.

Parameters:

categoryId - The category id to restrict the results to

Returns:

The builder

withSectionId

public SuggestedArticleSearch.Builder withSectionId(java.lang.Long sectionId)

Specifies the section id to restrict the results to.

Parameters:

sectionId - The section id to restrict the results to

Returns:

The builder

build

public SuggestedArticleSearch build()

Builds a HelpCenterSearch object with the specified parameters.

Returns:

the HelpCenterSearch