Content
Generate Document
This method generates the document that is defined for the provided slug. Inserts are processed.
SCHEMA_SERVICE_SCHEMA_READ permission from the Schema group.Declared In:
lib/modules/content/content_impl.dart
Related To:
Document
Class:
Content
Declaration:
Future<Document> generateDocument(String slug) asyncParameters:
| Parameter | Type | Mandatory | Default | Description |
|---|---|---|---|---|
| slug | String | yes | - | Slug of the document |
Return Value: Document
Example:
Document document = await Synerise.content.generateDocument(slugName).catchError((error) {
Get Recommendations (v2)
This method generates recommendations that are defined for the options provided.
SCHEMA_SERVICE_SCHEMA_READ permission from the Schema group.Declared In:
lib/modules/content/content_impl.dart
Related To:
RecommendationOptions
RecommendationResponse
Class:
Content
Declaration:
Future<RecommendationResponse> getRecommendationsV2(RecommendationOptions recommendationOptions) async Parameters:
| Parameter | Type | Mandatory | Default | Description |
|---|---|---|---|---|
| recommendationOptions | RecommendationOptions | yes | - | Options for recommendations |
Return Value:
RecommendationResponse
Example:
RecommendationOptions recommendationOptions = RecommendationOptions(
slug: slug,
productID: productId);
RecommendationResponse recommendationResponse = await Synerise.content.getRecommendationsV2(recommendationOptions).catchError((error) {
Generate Screen View
This method generates a customer’s highest-priority screen view campaign from the feed with the provided feed slug.
SCHEMA_SERVICE_SCHEMA_READ permission from the Schema group.Declared In:
lib/modules/content/content_impl.dart
Related To:
ScreenView
Class:
Content
Declaration:
Future<ScreenView> generateScreenView(String feedSlug) async Parameters:
| Parameter | Type | Mandatory | Default | Description |
|---|---|---|---|---|
| feedSlug | String | yes | - | Identifies the feed from which the screen view is selected. |
Return Value:
ScreenView
Example:
ScreenView screenViewResponse = await Synerise.content.generateScreenView(slug).catchError((error) {
Deprecated methods
Get document
This method generates the document that is defined for the provided slug.
SCHEMA_SERVICE_DOCUMENT_READ permission from the Document group.Declared In:
lib/modules/content/content_impl.dart
Class:
ContentImpl
Declaration:
Future<Map<String, Object>> getDocument(String slug) asyncParameters:
| Parameter | Type | Mandatory | Default | Description |
|---|---|---|---|---|
| slug | String | yes | - | Name of the slug |
Return Value:
Document as Map<String, Object>.
Example:
var documentJson = await Synerise.content.getDocument(slug).catchError((error)
Get documents
This method generates documents that are defined for parameters provided in the query object.
SCHEMA_SERVICE_DOCUMENT_READ permission from the Document group.Declared In:
lib/modules/content/content_impl.dart
Related To:
DocumentsApiQuery
Class:
ContentImpl
Declaration:
Future<List<Map<String, Object>>> getDocuments(DocumentsApiQuery apiQuery) asyncParameters:
| Parameter | Type | Mandatory | Default | Description |
|---|---|---|---|---|
| documentsApiQuery | DocumentsApiQuery | yes | - | Object for configuration of the query parameters |
Return Value:
List of documents as Map<String, Object>.
Example:
var documentsJson = await Synerise.content.getDocuments(documentsApiQuery).catchError((error)
Get recommendations
This method generates recommendations that are defined for the options provided.
SCHEMA_SERVICE_DOCUMENT_READ permission from the Document group.Declared In:
lib/modules/content/content_impl.dart
Related To:
RecommendationOptions
RecommendationResponse
Class:
ContentImpl
Declaration:
Future<RecommendationResponse> getRecommendations(RecommendationOptions recommendationOptions) asyncParameters:
| Parameter | Type | Mandatory | Default | Description |
|---|---|---|---|---|
| recommendationOptions | RecommendationOptions | yes | - | Object for configuration of the options parameters |
Return Value:
RecommendationResponse
Example:
var recommendationJson = await Synerise.content.getRecommendations(recommendationOptions).catchError((error)
Get screen view
This method generates the customer’s highest-priority screen view campaign.
SCHEMA_SERVICE_SCHEMA_READ permission from the Schema group.Declared In:
lib/modules/content/content_impl.dart
Related To:
ScreenViewResponse
Class:
ContentImpl
Declaration:
Future<ScreenViewResponse> getScreenView() asyncReturn Value:
ScreenViewResponse
Example:
var documentJson = await Synerise.content.getScreenView().catchError((error)
