Miscellaneous

Settings


Declared In:
lib/modules/notifications/settings_impl.dart

Declaration:

class SettingsImpl

Properties:

Property Type Description
sdk GeneralSettings General settings - This group contains options related to the general functioning of mobile SDK
notifications NotificationsSettings Notifications settings - This group contains options related to push notifications
tracker TrackerSettings Tracker - This group contains options related to tracking the customer activities in a mobile application
inAppMessaging InAppMessagingSettings In-app messaging - This group contains options related to the in-app messages feature
injector InjectorSettings Injector - This group contains options related to displaying campaigns

Note:
Learn more about settings here



Misc


ApiQuerySortingOrder

Declared In:
lib/model/base_api_query.dart

Declaration:

enum ApiQuerySortingOrder {
  ascending('asc'),
  descending('desc');
  }



ScreenViewApiQuery

The object to set parameters easily for fetching screen views from API.

Declared In:
Headers/SNRScreenViewApiQuery.h

Inherits From:
NSObject

Declaration:

class ScreenViewApiQuery: NSObject

Properties:

Property Type Optional Default Description
feedSlug String no nil Identifies a specific screen view feed
productID String yes nil Item identifier

Initializers:

init(feedSlug: String, productID: String?)



ScreenView

Declared In:
lib/model/content/screen_view.dart

Related To:
ScreenViewAudienceInfo

Declaration:

class ScreenView

Properties:

Property Type Optional Description
identifier String no Screen View’s ID
name String no Screen View’s name
hashString String no Screen View’s hash
path String no URL of the screen view’s definition
priority int no Screen View’s priority (1-99, where 1 is the highest)
audience ScreenViewAudienceInfo yes Audience of a Screen View
data Map<String, Object> yes Content of the screen view
createdAt DateTime no Screen View’s creation date
updatedAt DateTime no Screen View’s last update date
Important: All properties are read-only.


ScreenViewAudienceInfo

Declared In:
lib/model/content/screen_view_audience_info.dart

Related To:
ScreenView

Declaration:

class ScreenViewAudienceInfo

Properties:

Property Type Optional Description
segments List yes UUIDs of the segments that belong to the audience
query String yes Segmentation query for the Analytics engine
targetType String yes Audience’s target type (segments or query)
Important: All properties are read-only.


ScreenViewResponse

Model representing a highest-priority customer screen view campaign.

WARNING: This is a read-only class and it is not meant to be instantiated directly.

Declared In:
lib/model/content/screen_view_response.dart

Related To:
ScreenViewAudience

Declaration:

class ScreenViewResponse

Properties:

Property Type Optional Description
audience ScreenViewAudience no Audience of a screen view
identifier String no Screen view’s ID
hashString String no Screen view’s hash
path String no URL of the screen view’s definition
name String no Screen view’s name
priority int no Screen View’s priority (1-99, where 1 is the highest)
descriptionText String yes Screen view’s description
data Map<String, Object> no Content of the screen view
version String no Version of a screen view
parentVersion String yes Parent version of a screen view
createdAt DateTime no Screen view’s creation date
updatedAt DateTime no Screen view’s update date
deletedAt DateTime yes Screen view’s deletion date


ScreenViewAudience

Model representing an audience of customer screen view.

WARNING: This is a read-only class and it is not meant to be instantiated directly.

Declared In:
lib/model/content/screen_view_audience.dart

Related To: ScreenViewResponse

Declaration:

class ScreenViewAudience

Properties:

Property Type Optional Description
IDs List yes Audience’s identifiers
query String yes Audience’s query


SyneriseError

Represents a SyneriseError, which provides a structured way to handle errors, including parsing PlatformExceptions and handling unknown errors.

Declared In:
lib/modules/base/base_module_method_channel.dart

Declaration:

class SyneriseError

Initializers:

SyneriseError(
  int code;
  String message;
  dynamic details;
  String? stacktrace;);

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker