Content

Generate document

This method generates the document that is defined for the provided slug. Inserts are processed.

Declared In:
lib/main/modules/ContentModule.js

Related To:
Document

Class:
ContentModule

Declaration:

public generateDocument(slug: string, onSuccess: (document: Document) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Example:

Synerise.Content.generateDocument('slugName', function(document) {
	//success
}, function(error) {
	//failure
})

Generate document with query parameters

This method generates the document that is defined for the parameters provided in the query object.

Declared In:
lib/main/modules/ContentModule.js

Related To:
DocumentApiQuery
Document

Class:
ContentModule

Declaration:

public generateDocumentWithApiQuery(apiQuery: DocumentApiQuery, onSuccess: (document: Document) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Example:

let apiQuery = new DocumentApiQuery('SLUG');
documentApiQuery.productId = "PRODUCT_ID";

Synerise.Content.generateDocumentWithApiQuery(apiQuery, function(document) {
	//success
}, function(error) {
	//failure
})

Get recommendations (v2)

This method generates recommendations that are defined for the options provided.

Declared In:
lib/main/modules/ContentModule.js

Related To:
RecommendationOptions

Class:
ContentModule

Declaration:

public getRecommendationsV2(options: RecommendationOptions, onSuccess: (recommendationResponse: RecommendationResponse) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Example:

let recommendationOptions = new RecommendationOptions()
recommendationOptions.productID = 'productID'
recommendationOptions.slug = 'slugName'
Synerise.Content.getRecommendationsV2(recommendationOptions, function(recommendationResponse) {
      //success
},function(error) {
      //failure
});

Generate screen View

This method generates a customer’s highest-priority screen view campaign from the feed with the provided feed slug.

Declared In:
lib/main/modules/ContentModule.js

Related To:
ScreenView

Class:
ContentModule

Declaration:

public generateScreenView(feedSlug: string, onSuccess: (screenView: ScreenView) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Generate screen view with query parameters

This method generates customer’s highest-priority screen view campaign that is defined for parameters provided in the query object.

Declared In:
lib/main/modules/ContentModule.js

Related To:
ScreenViewApiQuery ScreenView

Class:
ContentModule

Declaration:

public generateScreenViewWithApiQuery(apiQuery: ScreenViewApiQuery, onSuccess: (screenView: ScreenView) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Example:

let apiQuery = new ScreenViewApiQuery("FEED_SLUG", "PRODUCT_ID");

Synerise.Content.generateScreenViewWithApiQuery(apiQuery, function(screenView) {
	//success
},function(error) {
	//failure
})

Deprecated methods

Get document

This method generates the document that is defined for the provided slug.

Declared In:
lib/main/modules/ContentModule.js

Class:
ContentModule

Declaration:

public getDocument(slug: string, onSuccess: (document: Object) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Example:

Synerise.Content.getDocument('slugName', function(document) {
	//success
}, function(error) {
	//failure
})

Get documents

This method generates documents that are defined for parameters provided in the query object.

Declared In:
lib/main/modules/ContentModule.js

Related To:
DocumentsApiQuery

Class:
ContentModule

Declaration:

public getDocuments(apiQuery: DocumentsApiQuery, onSuccess: (documents: Array<Object>) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Example:

let documentsApiQuery = new DocumentsApiQuery(DocumentsApiQueryType.SCHEMA, 'type', '1.0.0')
Synerise.Content.getDocuments(documentsApiQuery, function(documents) {
     //success
}, function(error) {
     //failure
 })

Get recommendations

This method generates recommendations that are defined for the options provided.

Declared In:
lib/main/modules/ContentModule.js

Related To:
RecommendationOptions

Class:
ContentModule

Declaration:

public getRecommendations(options: RecommendationOptions, onSuccess: (recommendationResponse: RecommendationResponse) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.

Example:

let recommendationOptions = new RecommendationOptions()
recommendationOptions.productID = 'productID'
recommendationOptions.slug = 'slugName'
Synerise.Content.getRecommendations(recommendationOptions, function(recommendationResponse) {
      //success
},function(error) {
      //failure
});

Get screen View

This method generates the customer’s highest-priority screen view campaign.

Declared In:
lib/main/modules/ContentModule.js

Related To:
ScreenViewResponse

Class:
ContentModule

Declaration:

public getScreenView(onSuccess: (screenViewResponse: ScreenViewResponse) => void, onError: (error: Error) => void)

Parameters:

Return Value:
No value is returned.