List of basic SDK methods to initialize SDK, see version, get permissions and log a user into the SDK.
-
initializeSDK(String appKey, String appSecret)
Initializes the Moca SDK with your application credentials and sets up the SDK for further use.
Parameters:appKey
: String, required – your Moca app key.appSecret
: String, required – your Moca app secret.
Future<MocaResult<void>> initializeSDK(String appKey, String appSecret);
-
initialized()
Returns whether the Moca SDK has been successfully initialized.Future<MocaResult<bool?>> initialized();
-
getVersion()
Retrieves the current version of the Moca SDK.Future<MocaResult<String?>> getVersion();
-
getLogLevel()
Retrieves the current logging level of the Moca SDK.Future<MocaResult<String?>> getLogLevel();
-
getPermissionsStatus()
Gets the current permissions status (e.g., for location tracking) used by the SDK.Future<MocaResult<String?>> getPermissionsStatus();
-
geoTrackingEnabled()
Checks if geo-tracking is currently enabled.Future<MocaResult<bool?>> geoTrackingEnabled();
-
eventTrackingEnabled()
Checks if event tracking is currently enabled.Future<MocaResult<bool?>> eventTrackingEnabled();
-
getUserId()
Retrieves the current user identifier set in the SDK.Future<MocaResult<String?>> getUserId();
-
setUserId(String userId)
Sets a stable unique identifier for the user to track user-specific events.
Parameters:userId
: String, required – A stable unique identifier for the user.
Future<MocaResult<void>> setUserId(String userId);
-
setGeoTrackingEnabled(bool enabled)
Enables or disables geo-tracking in the SDK.
Parameters:enabled
: bool, required – Enable (true
) or disable (false
) geo-tracking.
Future<MocaResult<void>> setGeoTrackingEnabled(bool enabled);
-
setEventTrackingEnabled(bool enabled)
Enables or disables event tracking in the SDK.
Parameters:enabled
: bool, required – Enable (true
) or disable (false
) event tracking.
Future<MocaResult<void>> setEventTrackingEnabled(bool enabled);
-
setLogLevel(String logLevel)
Sets the logging level for the SDK (e.g., "debug", "info").
Parameters:logLevel
: String, required – Desired logging level.
Future<MocaResult<String?>> setLogLevel(String logLevel);
-
flushEvents()
Flushes any queued events to the server.Future<MocaResult<bool?>> flushEvents();
-
getQueuedEvents()
Retrieves the number of events that are queued to be sent.Future<MocaResult<int?>> getQueuedEvents();