Recommendations and Documents

Recommendations

RecommendationRequestBody

Class responsible for creating a recommendation request.

Declared In:
com.synerise.sdk.content.model.recommendation.RecommendationRequestBody

Declaration:

public final class RecommendationRequestBody implements Serializable

class RecommendationRequestBody:Serializable

Properties:

Initializers:

There are no initializers.

Methods:

Setter for productId

public RecommendationRequestBody setProductId(String productId)

Setter for itemsIds

public RecommendationRequestBody setItemsIds(ArrayList<String> itemsIds)

RecommendationResponse

Class responsible for receiving recommendations.

Declared In:
com.synerise.sdk.content.model.recommendation.RecommendationResponse

Declaration:

public class RecommendationResponse

class RecommendationResponse

Properties:

Initializers:

There are no initializers.

Methods:

This method retrieves a recommendation schema.

public String getSchema()

This method retrieves the value of the slug parameter.

public String getSlug()

This method retrieves the value of the UUID parameter.

public String getUuid()

This method retrieves a list of recommendations.

public List<Recommendation> getRecommendationsV2()

This method retrieves the value of the campaignHash parameter.

public String getCampaignHash()

This method retrieves the value of the campaignId parameter.

public String getCampaignId()

Recommendation

Class model for a recommendation.

Declared In:
com.synerise.sdk.content.model.recommendation.Recommendation

Declaration:

public class Recommendation extends BaseModel

class Recommendation : BaseModel

Properties:

Initializers:
There are no initializers.

Methods:
There are only getters and setters for the above properties.

RecommendationAttribute

Class model for custom attributes.

Declared In:
com.synerise.sdk.content.model.recommendation.RecommendationAtribute

Declaration:

public class RecommendationAtribute

class RecommendationAtribute

Properties:

Initializers:

There are no initializers.

Methods:

There are only getters and setters for the above properties.

Documents

DocumentApiQuery

Class responsible for creating a query to the Documents API.

Declared In:
com.synerise.sdk.content.model.DocumentApiQuery

Declaration:

public class DocumentApiQuery

class DocumentApiQuery

Properties:

Properties used only if the document includes a recommendation insert:

Initializers:

There is a constructor.

public DocumentApiQuery(String feedSlug)

Methods:

Setter for feedSlug

public void setFeedSlug(String feedSlug)

Setter for additionalFilters

public DocumentApiQuery setAdditionalFilters(String additionalFilters)

Setter for itemsExcluded

public DocumentApiQuery setItemsExcluded(ArrayList<String> itemsExcluded)

Setter for filtersJoiner

public DocumentApiQuery setFiltersJoiner(FiltersJoinerRule filtersJoiner)

Setter for additionalElasticFilters

public DocumentApiQuery setAdditionalElasticFilters(String additionalElasticFilters)

Setter for elasticFiltersJoiner

public DocumentApiQuery setElasticFiltersJoiner(FiltersJoinerRule elasticFiltersJoiner)

Setter for displayAttributes

public DocumentApiQuery setDisplayAttributes(ArrayList<String> displayAttribute)

Setter for includeContextItems

public DocumentApiQuery setIncludeContextItems(Boolean includeContextItems)

Setter for itemsIds

public DocumentApiQuery setItemsIds(ArrayList<String> itemsIds)

Setter for productId

public DocumentApiQuery setProductId(String productId)

Document

Declared In:
com.synerise.sdk.content.model.document

Declaration:

public class Document

class Document

Properties:

Initializers:
There are no initializers.

Methods:
There are only getters for the above properties.

Removed symbols

DocumentsApiQuery

The object to set parameters easily for fetching documents from API.

Class responsible for creating a query to the Documents API.

Declared In:
com.synerise.sdk.content.model.DocumentsApiQuery

Declaration:

public class DocumentsApiQuery

class DocumentsApiQuery

Properties:

Initializers:

There are no initializers.

Methods:

This method sets query parameters.

public void setDocumentQueryParameters(DocumentsApiQueryType type, String typeValue)

This method sets a document version.

public void setVersion(String version)

DocumentsApiQueryType

This enum contains values for the Documents API query type.

Declared In:
com.synerise.sdk.content.model.DocumentsApiQueryType

Declaration:

public enum DocumentsApiQueryType

public enum DocumentsApiQueryType

Values:

Methods:

Get by path type.

public static DocumentsApiQueryType getByPathType(String type)