Content
Get document
Method that generates the document assigned to a slug.
Declared In
lib/modules/content/content_impl.dart
Method
Future<dynamic> Synerise.Content.getDocument(slug)
Parameters
Parameter | Type | Mandatory | Default | Description |
---|---|---|---|---|
slug |
String |
yes | - | Name of the slug |
Return Value
Returns the document json.
Example
var documentJson = await Synerise.content.getDocument(slug).catchError((error)
Get documents
Method that generates all documents assigned to a schema.
Declared In
lib/modules/content/content_impl.dart
Method
Future<dynamic> Synerise.Content.getDocuments(documentsApiQuery)
Parameters
Parameter | Type | Mandatory | Default | Description |
---|---|---|---|---|
documentsApiQuery |
DocumentsApiQuery |
yes | - | Object for configuration of the query parameters |
Return Value
Returns the documents json.
Example
var documentsJson = await Synerise.content.getDocuments(documentsApiQuery).catchError((error)
Get recommendations
Method that returns a list of recommendations assigned to a slug.
Declared In
lib/modules/content/content_impl.dart
Method
Future<dynamic> Synerise.Content.getRecommendations(recommendationOptions)
Parameters
Parameter | Type | Mandatory | Default | Description |
---|---|---|---|---|
recommendationOptions |
RecommendationOptions |
yes | - | Object for configuration of the query parameters |
Return Value
Returns the recommendation json.
Example
var recommendationJson = await Synerise.content.getRecommendations(recommendationOptions).catchError((error)
Get screen view
Method generating screen view for a customer
Declared In
lib/modules/content/content_impl.dart
Method
Future<dynamic> Synerise.Content.getScreenView()
Return Value
Returns the screen view json.
Example
var documentJson = await Synerise.content.getScreenView().catchError((error)