Background SDK/com.localz.backgroundsdk/LocalzBackgroundSDK

LocalzBackgroundSDK

LocalzBackgroundSDK is the main entry point for interacting with the Localz Background SDK. It provides methods for configuration, authentication, state management, and handling Firebase messages.

Functions

configure

suspend fun configure(key: String, environment: LocalzEnvironment, appVersion: String)

Configures the SDK with the provided key, environment, and app version.

currentUsername

suspend fun currentUsername(): String

Retrieves the current username of the logged-in user.

handleLocalzFirebaseMessage

suspend fun handleLocalzFirebaseMessage(data: Map<String, String>)

Handles a Firebase message from Localz.

hasRequiredPermissions

suspend fun hasRequiredPermissions(): PermissionState

Checks if the required permissions are granted.

initialize

suspend fun initialize(): LocalzResult<BackgroundSdkState>

Initializes the SDK and prepares it for use.

isInitialized

suspend fun isInitialized(): Boolean

Checks if the SDK is initialized.

isLocalzFirebaseMessage

fun isLocalzFirebaseMessage(data: Map<String, String>): Boolean

Determines if the given Firebase message originates from Localz.

loginAzureSSO

suspend fun loginAzureSSO(idToken: String, accessToken: String, refreshToken: String? = null): LocalzResult<BackgroundSdkState>

Logs in using Azure SSO authentication.

loginBasicAuth

suspend fun loginBasicAuth(username: String, password: String): LocalzResult<BackgroundSdkState>

Logs in using basic authentication.

loginGenericSSO

suspend fun loginGenericSSO(idToken: String, accessToken: String? = null, refreshToken: String? = null): LocalzResult<BackgroundSdkState>

Logs in using Generic SSO authentication with tokens.

loginGenericSSOWithAuthCode

suspend fun loginGenericSSOWithAuthCode(authorizationCode: String, redirectUrl: String): LocalzResult<BackgroundSdkState>

Logs in using Generic SSO authentication with authorization code.

loginGoogleSSO

suspend fun loginGoogleSSO(googleServerAuthCode: String): LocalzResult<BackgroundSdkState>

Logs in using Google SSO authentication.

loginMDLPSSO

suspend fun loginMDLPSSO(idToken: String): LocalzResult<BackgroundSdkState>

Logs in using MDLP SSO authentication.

logout

suspend fun logout(): LocalzResult<BackgroundSdkState>

Logs out the current user.

logReportFlow

fun logReportFlow(): Flow<LogReport>

Provides a Flow of log reports generated by the SDK.

stateFlow

fun stateFlow(): StateFlow<BackgroundSdkState>

Provides a StateFlow of the current BackgroundSdkState.