Android Helper Documentation

Android 17 (API 37) Ready

Kotlin Coroutines & DataStore

Flutter MethodChannel Bridge

Ask AI Assistant about Android Helper Documentation:

📦 Installation & Setup

📦 androidhelper setup & Android Helper.initialize(this)

Kotlin

Add the library dependency to your build file then initialize inside Application class.

[versions] androidhelper = "1.5.0-beta04"

[libraries] androidhelper = { group = "com.github.zaitxcode", name = "androidhelper", version.ref = "androidhelper" }

import com.zaitxcode.android.Android Helper

Android Helper.initialize(this)

🌐 Network Helpers

🌐 Network.isConnected, activeTransport, isWifiConnected & getIpAddress

Kotlin

Check internet connectivity, validated connection, transport type, and IP address via Network module.

import com.zaitxcode.android.net.Network

val isOnline: Boolean = Network.isConnected

val isValidated: Boolean = Network.hasValidatedInternet()

val isMetered: Boolean = Network.isConnectionMetered()

val transport: String = Network.activeTransport()

val isWifi: Boolean = Network.isWifiConnected()

val isCellular: Boolean = Network.isCellularConnected()

val ipAddress: String? = Network.getIpAddress()

🔗 External Intents & Actions

🔗 Intent.openWhatsApp, dial, sendSms, sendEmail, shareFile, openMap, Browser.openUrl

Kotlin

Open URLs, WhatsApp chats, dialer, SMS, email, maps, app settings, and Play Store directly via Intent & Browser modules.

import com.zaitxcode.android.content.Intent

import com.zaitxcode.android.browser.Browser

Browser.openUrl("https://docs.zaitxcode.com/androidhelper")

Intent.openWhatsApp("201234567890", "Hello")

Intent.dial("201234567890")

Intent.sendSms("201234567890", "Test message")

Intent.sendEmail("info@example.com", "Subject", "Body")

Intent.shareText("Text to share")

Intent.openMap(30.0444, 31.2357, "Cairo")

Intent.openAppSettings()

Intent.openPlayStore()

🔊 Audio & Display Helpers

🔊 Audio.playClickSound, isMuted, getMusicVolume & Display Metrics

Kotlin

Play tactile system click sound, query audio ringer mode/volume, screen orientation & dimensions in DP via Audio & Display modules.

import com.zaitxcode.android.hardware.Audio

import com.zaitxcode.android.hardware.Display

Audio.playClickSound()

val muted: Boolean = Audio.isMuted()

val volumePercent: Int = Audio.getMusicVolume()

val isPortrait: Boolean = Display.isPortrait()

val isLandscape: Boolean = Display.isLandscape()

val widthDp: Int = Display.getScreenWidthDp()

val heightDp: Int = Display.getScreenHeightDp()

📋 Clipboard, Vibration & Screen

📋 Clipboard.copyText, getText, hasCopiedText & Vibration.vibrate & Screen.blockCapture

Kotlin

Trigger physical vibration motor, clipboard read/write/clear, and screen capture block via Clipboard, Vibration & Screen modules.

Clipboard.copyText("Copied text")

val text: String? = Clipboard.getText()

val hasText: Boolean = Clipboard.hasCopiedText()

Clipboard.clear()

Vibration.vibrate(200)

Vibration.vibratePattern(longArrayOf(0, 100, 50, 200), -1)

Vibration.cancel()

Screen.blockCapture()

Screen.unblockCapture()

val blocked: Boolean = Screen.isCaptureBlocked()

🔔 Notifications & Keyboard

🔔 Notification.showNotification, createChannel, cancelAll & Keyboard.hideKeyboard

Kotlin

Create notification channels, show custom notifications, cancel notifications, and hide/show soft keyboard via Notification & Keyboard modules.

Notification.createChannel("demo", "Demo Channel")

Notification.showNotification("demo", "Android Helper", "Hello", R.drawable.ic_launcher)

Notification.cancelAll()

val canPost: Boolean = Notification.canPostNotifications()

Keyboard.hideKeyboard()

📱 Device, Battery & App Info

📱 Device, Battery, AppInfo & AppState Metrics

Kotlin

Query device model, brand, SDK level, tablet/emulator state, battery status/health, and foreground application state via Device, Battery, AppInfo & AppState modules.

val device: String = Device.deviceName()

val sdkLevel: Int = Device.sdk()

val isEmulator: Boolean = Device.isEmulator()

val batteryLevel: Int = Battery.getBatteryLevel()

val isCharging: Boolean = Battery.isCharging()

val packageName: String = AppInfo.packageName()

val isForeground: Boolean = AppState.isAppInForeground()

💾 Data, Storage & Crypto

💾 File, Storage, Time, Validation & Encryption

Kotlin

File write/read/append/delete, storage space format, time formatting, email/phone/URL validation, SHA-256, SHA-512, HMAC, and Base64 encoding via File, Storage, Time, Validation & Encryption modules.

AppFile.writeText("demo.txt", "content")

val content: String? = AppFile.readText("demo.txt")

val freeBytes: Long = Storage.getFreeInternalStorage()

val formattedTime: String = Time.format(Time.now(), "yyyy-MM-dd HH:mm:ss")

val isValidEmail: Boolean = Validation.isValidEmail("user@example.com")

val sha256Hash: String = Encryption.sha256("password")

🔐 Security, Biometric & Logger

🔐 Biometric.authenticate, Permission.isGranted, Signature & Logger

Kotlin

Prompt biometric authentication, grant/check runtime permissions, extract app SHA-1 signature, and log diagnostics via Biometric, Permission, Signature & Logger modules.

val canBio: Boolean = Biometric.canAuthenticate()

Biometric.authenticate(activity = fragmentActivity, title = "Biometric Auth", onSuccess = {})

val isCameraGranted: Boolean = Permission.isGranted(Manifest.permission.CAMERA)

val sha1Fingerprint: String = Signature.getAppPrimarySignatureSHA1()

Android Helper.log("Tag", "Diagnostic info")