NativePHP Mobile

https://nativephp.com/docs/mobile/2
Admin
NativePHP Mobile is a library that allows developers to build performant, offline-capable native...
Tokens:54,628
Snippets:556
Trust Score:8.5
Update:9 months ago
Show doc for...
Tokens:
Raw
### Using the NativePHP 'native' Helper Script

Source: https://nativephp.com/docs/mobile/2/getting-started/quick-start

This shell example demonstrates the usage of the 'native' helper script generated by `php artisan native:install`. It shows how to run commands like 'native run' as a more concise alternative to 'php artisan native:run' or './native run'.

```shell
# Instead of...
php artisan native:run

# Do
native run

# Or
./native run
```

--------------------------------

### Install and Run NativePHP Mobile App

Source: https://nativephp.com/docs/mobile/2/getting-started/quick-start

This bash script outlines the essential commands to install NativePHP for mobile into a Laravel application, prepare the app for native building, and run it on a mobile device. It includes installing the package, running the installation artisan command, and initiating the app.

```bash
# Install NativePHP for Mobile into a new Laravel app
composer require nativephp/mobile

# Ready your app to go native
php artisan native:install

# Run your app on a mobile device
php artisan native:run
```

--------------------------------

### Install Xcode Command Line Tools

Source: https://nativephp.com/docs/mobile/2/getting-started/environment-setup

Installs the necessary command-line tools for Xcode. Verify the installation by checking the current path of the Xcode command-line tools.

```shell
xcode-select --install
xcode-select -p
```

--------------------------------

### Install Homebrew Package Manager

Source: https://nativephp.com/docs/mobile/2/getting-started/environment-setup

Installs Homebrew, a package manager for macOS, which is required for installing other development tools. The script downloads and executes the installation instructions from Homebrew's official repository.

```shell
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Configure Windows Environment Variables for Android

Source: https://nativephp.com/docs/mobile/2/getting-started/environment-setup

Sets up essential environment variables on Windows for Android development, including JAVA_HOME and ANDROID_HOME. This ensures that the system can locate the Java Development Kit and Android SDK, along with their associated tools. Note that paths may vary based on installation.

```shell
set ANDROID_HOME=C:\Users\yourname\AppData\Local\Android\Sdk
set PATH=%PATH%;%JAVA_HOME%\bin;%ANDROID_HOME%\platform-tools

# This isn't required if JAVA_HOME is already set in the Windows Env Variables
set JAVA_HOME=C:\Program Files\Microsoft\jdk-17.0.8.7-hotspot
```

--------------------------------

### Start Video Recording

Source: https://nativephp.com/docs/mobile/2/apis/camera

Explicitly initiates the video recording process. If this method is not called, the recording typically starts automatically after configuration.

```php
Camera::recordVideo()
    ->maxDuration(60)
    ->start();
```

--------------------------------

### Run NativePHP Application

Source: https://nativephp.com/docs/mobile/2/getting-started/installation

Starts compiling and running your NativePHP application on a selected device. It's recommended to test your application in the browser first to resolve potential issues. Follow the on-screen prompts during execution.

```shell
php artisan native:run
```

--------------------------------

### Install CocoaPods Dependency Manager

Source: https://nativephp.com/docs/mobile/2/getting-started/environment-setup

Installs CocoaPods, a dependency manager for Swift and Objective-C Cocoa projects. This is a prerequisite for managing iOS project dependencies. Verify the installation by checking the installed version.

```shell
brew install cocoapods
pod --version
```

--------------------------------

### Start Audio Recording with PHP Microphone Module

Source: https://nativephp.com/docs/mobile/2/apis/microphone

Explicitly starts an audio recording using the Microphone::record() method. This is optional as recordings auto-start when the pending microphone instance is destroyed. It returns a boolean indicating success or failure, with failure often due to permission denial.

```php
$recorder = Microphone::record()->id('my-recording');

if ($recorder->start()) {
    // Recording started
} else {
    // Recording failed - likely due to permission denial
}
```

--------------------------------

### Start Recording

Source: https://nativephp.com/docs/mobile/2/apis/microphone

Explicitly start the audio recording. This is optional as recordings auto-start if this method is not called.

```APIDOC
## `start()`

### Description
Explicitly start the audio recording. This is optional - recordings auto-start if you don't call this method.

### Method
Implicit (called on the recorder instance)

### Endpoint
N/A (Client-side method)

### Parameters
None

### Request Example
```php
$recorder = Microphone::record()->id('my-recording');

if ($recorder->start()) {
    // Recording started
} else {
    // Recording failed - likely due to permission denial
}
```

### Response
#### Success Response
- `bool` - `true` if recording started successfully

#### Error Response
- `bool` - `false` if recording failed or was already started

#### Response Example
```php
true
```
```

--------------------------------

### Share Captured Photo Example

Source: https://nativephp.com/docs/mobile/2/apis/share

Example showing how to share a captured photo. This involves listening for the `PhotoTaken` event and then using the `Share::file()` method to share the photo at the provided path. This example is provided for PHP, Vue, and React.

```php
use Native\Mobile\Attributes\OnNative;
use Native\Mobile\Events\Camera\PhotoTaken;

#[OnNative(PhotoTaken::class)]
public function handlePhotoTaken(string $path)
{
    Share::file(
        title: 'My Photo',
        text: 'Check out this photo I just took!',
        filePath: $path
    );
}
```

```javascript
import { share, on, off, Events } from '#nativephp';
import { onMounted, onUnmounted } from 'vue';

const handlePhotoTaken = (payload) => {
    share.file(
        'My Photo',
        'Check out this photo I just took!',
        payload.path
    );
};

onMounted(() => {
    on(Events.Camera.PhotoTaken, handlePhotoTaken);
});

onUnmounted(() => {
    off(Events.Camera.PhotoTaken, handlePhotoTaken);
});
```

```jsx
import { share, on, off, Events } from '#nativephp';
import { useEffect } from 'react';

const handlePhotoTaken = (payload) => {
    share.file(
        'My Photo',
        'Check out this photo I just took!',
        payload.path
    );
};

useEffect(() => {
    on(Events.Camera.PhotoTaken, handlePhotoTaken);

    return () => {
        off(Events.Camera.PhotoTaken, handlePhotoTaken);
    };
}, []);
```

--------------------------------

### Add NativePHP Composer Repository

Source: https://nativephp.com/docs/mobile/2/getting-started/quick-start

This JSON snippet shows how to add the NativePHP Composer repository to your composer.json file. This is a necessary step to allow Composer to find and install NativePHP packages.

```json
{
    "repositories": [
        {
            "type": "composer",
            "url": "https://nativephp.composer.sh"
        }
    ]
}
```

--------------------------------

### Share Website Link Example

Source: https://nativephp.com/docs/mobile/2/apis/share

An example demonstrating how to share a website link using the Share API. This snippet shows the practical application of the `url()` method for sharing external or app-related links.

```php
Share::url(
    title: 'My Awesome App',
    text: 'Download my app today!',
    url: 'https://myapp.com'
);
```

```javascript
await share.url(
    'My Awesome App',
    'Download my app today!',
    'https://myapp.com'
);
```

--------------------------------

### PHP: Copy File for Backup Example

Source: https://nativephp.com/docs/mobile/2/apis/file

Demonstrates creating a backup of a file by copying it to a different directory. It includes a check for the success of the copy operation.

```PHP
$original = storage_path('app/documents/contract.pdf');
$backup = storage_path('app/backups/contract_backup.pdf');

if (File::copy($original, $backup)) {
    // Backup created successfully
} else {
    // Handle backup failure
}
```

--------------------------------

### Set NativePHP App Identifier

Source: https://nativephp.com/docs/mobile/2/getting-started/quick-start

This .env file example shows how to set the NATIVEPHP_APP_ID for your application. This identifier is crucial for building mobile apps and must follow specific rules (lowercase letters, numbers, and periods only).

```dotenv
NATIVEPHP_APP_ID=com.cocacola.cokezero
```

--------------------------------

### Run NativePHP Installer

Source: https://nativephp.com/docs/mobile/2/getting-started/installation

Executes the NativePHP installer command to set up and configure your Laravel application for iOS and Android development. It may prompt to install ICU-enabled PHP binaries if your application uses the 'intl' PHP extension.

```shell
php artisan native:install
```

--------------------------------

### PHP: Organize Files by Date Example

Source: https://nativephp.com/docs/mobile/2/apis/file

Shows how to move files into date-based directories for organization. It dynamically creates the destination path using the current date.

```PHP
use Native\Mobile\Facades\File;

$today = now()->format('Y-m-d');
$source = storage_path('app/uploads/file.jpg');
$destination = storage_path("app/uploads/{$today}/file.jpg");

File::move($source, $destination);
```

--------------------------------

### Build iOS App for Ad-Hoc Distribution

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

Builds an iOS application for ad-hoc distribution, allowing installation on specific registered devices. Requires certificate, password, and a provisioning profile configured for ad-hoc distribution. Uses the 'ad-hoc' export method.

```bash
php artisan native:package ios \
  --export-method=ad-hoc \
  --certificate-path=/path/to/distribution.p12 \
  --certificate-password=certificatepassword \
  --provisioning-profile-path=/path/to/ad-hoc-profile.mobileprovision
```

--------------------------------

### PHP: Move Captured Media Example

Source: https://nativephp.com/docs/mobile/2/apis/file

Example of moving a captured photo from a temporary location to permanent storage using the File API. It handles potential success or failure of the move operation.

```PHP
use Native\Mobile\Attributes\OnNative;
use Native\Mobile\Events\Camera\PhotoTaken;
use Native\Mobile\Facades\File;

#[OnNative(PhotoTaken::class)]
public function handlePhotoTaken(string $path)
{
    $destination = storage_path('app/photos/'.basename($path));

    if (File::move($path, $destination)) {
        $this->photo_path = $destination;
    } else {
        $this->error = 'Failed to save photo';
    }
}
```

--------------------------------

### PHP Facade Examples for Native Device Functions

Source: https://nativephp.com/docs/mobile/2/the-basics/native-functions

Illustrates common PHP Facades provided by NativePHP for accessing native device functionalities such as Biometrics, Browser, and Camera directly from your Laravel application.

```php
Native\Mobile\Facades\Biometrics
Native\Mobile\Facades\Browser
Native\Mobile\Facades\Camera
```

--------------------------------

### Advanced Scanner Configuration - PHP and JS

Source: https://nativephp.com/docs/mobile/2/apis/scanner

An example demonstrating how to chain multiple configuration methods to customize the scanner's behavior, including setting a prompt, enabling continuous scanning, specifying formats, and assigning a session ID.

```php
Scanner::scan()
    ->prompt('Scan your ticket')
    ->continuous(true)
    ->formats(['qr', 'ean13'])
    ->id('ticket-scanner');
```

```js
await scanner.scan()
    .prompt('Scan your ticket')
    .continuous(true)
    .formats(['qr', 'ean13'])
    .id('ticket-scanner');
```

--------------------------------

### Add NativePHP Composer Repository using CLI

Source: https://nativephp.com/docs/mobile/2/getting-started/quick-start

This shell command demonstrates how to add the NativePHP Composer repository using the Composer CLI, specifically for versions 2.9 and above. It's a convenient alternative to manually editing composer.json.

```shell
composer repo add nativephp composer https://nativephp.composer.sh
```

--------------------------------

### Configure macOS Environment Variables for Android

Source: https://nativephp.com/docs/mobile/2/getting-started/environment-setup

Sets up essential environment variables on macOS for Android development, including JAVA_HOME and ANDROID_HOME. This ensures that the system can locate the Java Development Kit and Android SDK, along with their associated tools.

```shell
# This isn't required if JAVA_HOME is already set in your environment variables (check using `printenv | grep JAVA_HOME`)
export JAVA_HOME=$(/usr/libexec/java_home -v 17) 

export ANDROID_HOME=$HOME/Library/Android/sdk
export PATH=$PATH:$JAVA_HOME/bin:$ANDROID_HOME/emulator:$ANDROID_HOME/tools:$ANDROID_HOME/tools/bin:$ANDROID_HOME/platform-tools
```

--------------------------------

### Start Audio Recording (PHP & JS)

Source: https://nativephp.com/docs/mobile/2/apis/microphone

Initiates an audio recording using the device's microphone. The PHP version returns a `PendingMicrophone` instance for further configuration. The JavaScript version allows setting an optional ID for tracking.

```php
Microphone::record()->start();
```

```javascript
// Basic recording
await microphone.record();

// With identifier for tracking
await microphone.record()
    .id('voice-memo');
```

--------------------------------

### Handling Custom NativePHP Events with Livewire

Source: https://nativephp.com/docs/mobile/2/the-basics/events

Provides an example of how to handle a custom event within a Livewire component using the `#[OnNative()]` attribute. This allows for server-side logic to be executed when a specific native event occurs.

```php
use App\Events\MyButtonPressed;
use Native\Mobile\Attributes\OnNative;

#[OnNative(MyButtonPressed::class)]
public function buttonPressed()
{
    // Do stuff
}

```

--------------------------------

### Handle MediaSelected Event Across Platforms

Source: https://nativephp.com/docs/mobile/2/apis/camera

This snippet demonstrates how to handle the MediaSelected event, which fires when media is chosen from the gallery. It shows implementations in PHP, Vue, and React, allowing developers to process the selected media files. The examples include logic to iterate through the files and call a processing function. Dependencies include NativePHP's event system and frontend frameworks' state management.

```php
use Native\Mobile\Attributes\OnNative;
use Native\Mobile\Events\Gallery\MediaSelected;

#[OnNative(MediaSelected::class)]
public function handleMediaSelected($success, $files, $count)
{
    foreach ($files as $file) {
        // Process each selected media item
        $this->processMedia($file);
    }
}
```

```javascript
import { on, off, Events } from '#nativephp';
import { ref, onMounted, onUnmounted } from 'vue';

const selectedFiles = ref([]);

const handleMediaSelected = (payload) => {
    const { success, files, count } = payload;

    if (success) {
        selectedFiles.value = files;
        files.forEach(file => processMedia(file));
    }
};

onMounted(() => {
    on(Events.Gallery.MediaSelected, handleMediaSelected);
});

onUnmounted(() => {
    off(Events.Gallery.MediaSelected, handleMediaSelected);
});
```

```jsx
import { on, off, Events } from '#nativephp';
import { useState, useEffect } from 'react';

const [selectedFiles, setSelectedFiles] = useState([]);

const handleMediaSelected = (payload) => {
    const { success, files, count } = payload;

    if (success) {
        setSelectedFiles(files);
        files.forEach(file => processMedia(file));
    }
};

useEffect(() => {
    on(Events.Gallery.MediaSelected, handleMediaSelected);

    return () => {
        off(Events.Gallery.MediaSelected, handleMediaSelected);
    };
}, []);
```

--------------------------------

### Check if iOS - PHP and JavaScript

Source: https://nativephp.com/docs/mobile/2/apis/system

Provides code examples for checking if the current device is running iOS using the System API in PHP and JavaScript. This is useful for implementing platform-specific logic.

```PHP
if (System::isIos()) {
    // iOS-specific code
}
```

```JavaScript
const ios = await system.isIos();

if (ios) {
    // iOS-specific code
}
```

--------------------------------

### JavaScript Interaction with Native Functions using NativePHP

Source: https://nativephp.com/docs/mobile/2/the-basics/native-functions

Demonstrates how to import and use NativePHP's JavaScript library to interact with native device features like the microphone. It includes examples of event listeners for recording status updates using Vue's composition API.

```javascript
import { on, off, Microphone, Events } from '#nativephp';
import { onMounted, onUnmounted } from 'vue';

const buttonClicked = () => {
    Microphone.record();
};

const handleRecordingFinished = () => {
    // Update the UI
};

onMounted(() => {
    on(Events.Microphone.MicrophoneRecorded, handleRecordingFinished);
});

onUnmounted(() => {
    off(Events.Microphone.MicrophoneRecorded, handleRecordingFinished);
});
```

--------------------------------

### Handle Push Notification Token Event - PHP (Livewire)

Source: https://nativephp.com/docs/mobile/2/concepts/push-notifications

This example shows how to listen for the `TokenGenerated` event in a Livewire component to receive and store the push notification token. It utilizes the `#[OnNative]` attribute to bind the event to the `storePushToken` method, which then passes the token to an `APIService` for storage.

```php
use App\Services\APIService;
use Native\Mobile\Attributes\OnNative;
use Native\Mobile\Facades\PushNotifications;
use Native\Mobile\Events\PushNotification\TokenGenerated;

class PushNotifications extends Component
{
    #[OnNative(TokenGenerated::class)]
    public function storePushToken(APIService $api, string $token)
    {
        $api->storePushToken($token);
    }
}
```

--------------------------------

### Configure iOS Build Credentials with Environment Variables

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

Demonstrates how to store iOS build credentials in a `.env` file for use with NativePHP. This approach simplifies command-line arguments by loading configuration automatically.

```env
APP_STORE_API_KEY_PATH=/path/to/api-key.p8
APP_STORE_API_KEY_ID=ABC123DEF
APP_STORE_API_ISSUER_ID=01234567-89ab-cdef-0123-456789abcdef
IOS_DISTRIBUTION_CERTIFICATE_PATH=/path/to/distribution.p12
IOS_DISTRIBUTION_CERTIFICATE_PASSWORD=certificatepassword
IOS_DISTRIBUTION_PROVISIONING_PROFILE_PATH=/path/to/profile.mobileprovision
IOS_TEAM_ID=ABC1234567
```

--------------------------------

### Build iOS App Using Environment Variables

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

Builds an iOS application for the App Store using credentials defined in the `.env` file. This command assumes the necessary environment variables are set.

```bash
php artisan native:package ios --export-method=app-store
```

--------------------------------

### Import SecureStorage Facade/Module

Source: https://nativephp.com/docs/mobile/2/apis/secure-storage

Import the SecureStorage facade in PHP or the secureStorage module in JavaScript to begin using its functionalities. This is the first step before performing any storage operations.

```PHP
use Native\Mobile\Facades\SecureStorage;
```

```JS
import { secureStorage } from '#nativephp';
```

--------------------------------

### NativePHP EDGE Component Error Message Example

Source: https://nativephp.com/docs/mobile/2/edge-components

This example shows a typical error message generated by the EDGE component system when a required prop is missing. It indicates the specific component and the missing prop, guiding the developer to add the necessary attributes.

```text
EDGE Component <native:bottom-nav-item> is missing required properties: 'label'.
Add these attributes to your component: label="..."

EDGE Component <native:bottom-nav-item> is missing required properties: 'label'.
Add these attributes to your component: label="..."
```

--------------------------------

### Specify Custom Output Directory for Android Build

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

This command builds an Android application bundle and allows you to specify a custom directory for the build artifacts. This is helpful for organizing build outputs or integrating with other tools. It requires standard Android signing information. The `--output=/path/to/custom/directory` flag sets the destination.

```bash
php artisan native:package android \
  --build-type=bundle \
  --keystore=/path/to/my-app.keystore \
  --keystore-password=mykeystorepassword \
  --key-alias=my-app-key \
  --key-password=mykeypassword \
  --output=/path/to/custom/directory
```

--------------------------------

### Upload iOS App to App Store Connect

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

Builds an iOS application and automatically uploads it to App Store Connect. Requires full API credentials, certificate, provisioning profile, and team ID. Uses the 'app-store' export method and the '--upload-to-app-store' flag.

```bash
php artisan native:package ios \
  --export-method=app-store \
  --api-key-path=/path/to/api-key.p8 \
  --api-key-id=ABC123DEF \
  --api-issuer-id=01234567-89ab-cdef-0123-456789abcdef \
  --certificate-path=/path/to/distribution.p12 \
  --certificate-password=certificatepassword \
  --provisioning-profile-path=/path/to/profile.mobileprovision \
  --team-id=ABC1234567 \
  --upload-to-app-store
```

--------------------------------

### Build iOS App for Development

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

Builds an iOS application for development and testing purposes. Requires a development certificate, its password, and a development provisioning profile. Uses the 'development' export method.

```bash
php artisan native:package ios \
  --export-method=development \
  --certificate-path=/path/to/development.p12 \
  --certificate-password=certificatepassword \
  --provisioning-profile-path=/path/to/development-profile.mobileprovision
```

--------------------------------

### Test iOS App Upload to App Store Connect

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

Tests the upload process to App Store Connect with an existing IPA file without performing a full rebuild. Requires API credentials. Useful for verifying upload configurations.

```bash
php artisan native:package ios \
  --test-upload \
  --api-key-path=/path/to/api-key.p8 \
  --api-key-id=ABC123DEF \
  --api-issuer-id=01234567-89ab-cdef-0123-456789abcdef
```

--------------------------------

### Get Secure Value from Storage

Source: https://nativephp.com/docs/mobile/2/apis/secure-storage

Retrieve a securely stored value by its key using the `get` method. PHP returns the value or null. JavaScript returns an object with the `value` property, which can be null.

```PHP
$token = SecureStorage::get('api_token');
```

```JS
const result = await secureStorage.get('api_token');
const token = result.value; // or null if not found
```

--------------------------------

### Require NativePHP Composer Package

Source: https://nativephp.com/docs/mobile/2/getting-started/installation

Installs the NativePHP/mobile Composer package into your Laravel project. This command requires the repository to be defined in composer.json. It may prompt for authentication using your license email and key.

```shell
composer require nativephp/mobile
```

--------------------------------

### Build iOS App for App Store Distribution

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

Builds a production-ready iOS application for distribution via the App Store. Requires API credentials, certificate, provisioning profile, and team ID. Uses the 'app-store' export method.

```bash
php artisan native:package ios \
  --export-method=app-store \
  --api-key-path=/path/to/api-key.p8 \
  --api-key-id=ABC123DEF \
  --api-issuer-id=01234567-89ab-cdef-0123-456789abcdef \
  --certificate-path=/path/to/distribution.p12 \
  --certificate-password=certificatepassword \
  --provisioning-profile-path=/path/to/profile.mobileprovision \
  --team-id=ABC1234567
```

--------------------------------

### Jump Ahead in Android Version Numbers

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

This command builds an Android application bundle and allows you to manually increment the version code by a specified amount, useful for skipping version numbers or implementing specific release strategies. It requires standard Android signing information. The `--jump-by=10` option adds 10 to the calculated version code.

```bash
php artisan native:package android \
  --build-type=bundle \
  --keystore=/path/to/my-app.keystore \
  --keystore-password=mykeystorepassword \
  --key-alias=my-app-key \
  --key-password=mykeypassword \
  --jump-by=10
```

--------------------------------

### Get Device ID

Source: https://nativephp.com/docs/mobile/2/apis/device

Retrieves a unique identifier for the device.

```APIDOC
## GET /device/id

### Description
Returns a unique identifier for the device.

### Method
GET

### Endpoint
/device/id

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (string) - A unique identifier for the device.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```
```

--------------------------------

### Build Android App in Non-Interactive Environment

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

This command builds an Android application bundle and disables TTY mode, making it suitable for CI/CD pipelines and automated build processes. It requires standard Android signing information. The `--no-tty` flag ensures non-interactive execution.

```bash
php artisan native:package android \
  --build-type=bundle \
  --keystore=/path/to/my-app.keystore \
  --keystore-password=mykeystorepassword \
  --key-alias=my-app-key \
  --key-password=mykeypassword \
  --no-tty
```

--------------------------------

### Get Battery Info

Source: https://nativephp.com/docs/mobile/2/apis/device

Retrieves information about the device's battery.

```APIDOC
## GET /device/battery

### Description
Returns information about the device's battery.

### Method
GET

### Endpoint
/device/battery

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **info** (string) - A JSON encoded string containing battery information.

#### Response Example
```json
{
  "info": "{\"batteryLevel\": 0.85, \"isCharging\": true}"
}
```
```

--------------------------------

### Get Device Info

Source: https://nativephp.com/docs/mobile/2/apis/device

Retrieves information about the underlying device, OS, and platform.

```APIDOC
## GET /device/info

### Description
Returns information about the underlying device, OS, and platform.

### Method
GET

### Endpoint
/device/info

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **info** (string) - A JSON encoded string containing device information.

#### Response Example
```json
{
  "info": "{\"platform\": \"ios\", \"model\": \"iPhone13,4\", \"osVersion\": \"17.0\"}"
}
```
```

--------------------------------

### Get Recording Status (PHP & JS)

Source: https://nativephp.com/docs/mobile/2/apis/microphone

Retrieves the current status of the microphone recording. Possible statuses are 'idle', 'recording', or 'paused'.

```php
$status = Microphone::getStatus();

if ($status === 'recording') {
    // A recording is in progress
}
```

```javascript
const result = await microphone.getStatus();

if (result.status === 'recording') {
    // A recording is in progress
}
```

--------------------------------

### Import Biometrics Facade (PHP)

Source: https://nativephp.com/docs/mobile/2/apis

Imports the Biometrics facade for use in PHP applications. This is a common setup step for accessing the API.

```php
use Native\Mobile\Facades\Biometrics;

use Native\Mobile\Facades\Biometrics;
```

--------------------------------

### Get Recorder ID (PHP)

Source: https://nativephp.com/docs/mobile/2/apis/microphone

Retrieves the unique identifier for a recorder instance. If no ID was explicitly set, a UUID v4 is automatically generated.

```php
$recorder = Microphone::record()
    ->id('my-recording');

$id = $recorder->getId(); // 'my-recording'
```

--------------------------------

### Get Video Recorder ID

Source: https://nativephp.com/docs/mobile/2/apis/camera

Retrieves the unique identifier for the current video recorder instance. If no ID was explicitly set, it auto-generates a UUID.

```php
$recorder = Camera::recordVideo();
$id = $recorder->getId(); // Returns UUID
```

--------------------------------

### Force Clean Rebuild for iOS

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

This command forces a complete rebuild of the iOS application, ensuring a fresh archive is created. It is useful for resolving build issues or when significant changes have been made. The `--export-method=app-store` option specifies the deployment method.

```bash
php artisan native:package ios \
  --export-method=app-store \
  --rebuild
```

--------------------------------

### Get Last Recording File Path (PHP & JS)

Source: https://nativephp.com/docs/mobile/2/apis/microphone

Retrieves the file path of the most recently recorded audio. Returns `null` if no recording has been made.

```php
$path = Microphone::getRecording();

if ($path) {
    // Process the recording file
}
```

```javascript
const result = await microphone.getRecording();

if (result.path) {
    // Process the recording file
}
```

--------------------------------

### Get Unique Device ID

Source: https://nativephp.com/docs/mobile/2/apis/device

Retrieve a unique identifier for the current device. This ID can be used for various purposes, such as associating data with a specific device instance.

```PHP
$id = Device::getId();
```

```JavaScript
const result = await device.getId();
const deviceId = result.id;
```

--------------------------------

### Import Camera Facade/Module

Source: https://nativephp.com/docs/mobile/2/apis/camera

Imports the necessary Camera facade in PHP or the camera module in JavaScript to access its methods. This is the first step before utilizing any camera-related functions.

```php
use Native\Mobile\Facades\Camera;
```

```js
import { camera, on, off, Events } from '#nativephp';
```

--------------------------------

### Get Battery Information

Source: https://nativephp.com/docs/mobile/2/apis/device

Retrieve current information about the device's battery, including its charge level and charging status. The data is returned as a JSON encoded string.

```PHP
$info = Device::getBatteryInfo();
$batteryInfo = json_decode($info);
```

```JavaScript
const result = await device.getBatteryInfo();
const batteryInfo = JSON.parse(result.info);

console.log(batteryInfo.batteryLevel); // 0-1 (e.g., 0.85 = 85%)
console.log(batteryInfo.isCharging);   // true/false
```

--------------------------------

### Get Device Information

Source: https://nativephp.com/docs/mobile/2/apis/device

Fetch detailed information about the device, including its model, operating system version, and platform. The returned data is JSON encoded and needs to be decoded for use.

```PHP
$info = Device::getInfo();
$deviceInfo = json_decode($info);
```

```JavaScript
const result = await device.getInfo();
const deviceInfo = JSON.parse(result.info);

console.log(deviceInfo.platform);  // 'ios' or 'android'
console.log(deviceInfo.model);     // e.g., 'iPhone13,4'
console.log(deviceInfo.osVersion); // e.g., '17.0'
```

--------------------------------

### Configure NativePHP Environment Variables

Source: https://nativephp.com/docs/mobile/2/getting-started/installation

Sets essential environment variables in your .env file for NativePHP to function correctly. NATIVEPHP_APP_ID is a unique identifier for your app, and NATIVEPHP_APP_VERSION/CODE specify the app's versioning.

```dotenv
NATIVEPHP_APP_ID=com.yourcompany.yourapp
NATIVEPHP_APP_VERSION="DEBUG"
NATIVEPHP_APP_VERSION_CODE="1"
```

--------------------------------

### Auto-Increment Android Version from Play Store

Source: https://nativephp.com/docs/mobile/2/getting-started/deployment

This command builds an Android application bundle and automatically increments the version code by querying the Google Play Store for the latest build number. This requires valid Google Service credentials and signing information. The `--build-type=bundle` flag indicates an Android App Bundle is being built.

```bash
php artisan native:package android \
  --build-type=bundle \
  --keystore=/path/to/my-app.keystore \
  --keystore-password=mykeystorepassword \
  --key-alias=my-app-key \
  --key-password=mykeypassword \
  --google-service-key=/path/to/service-account-key.json
```

--------------------------------

### Handle Custom Events with Native Calls

Source: https://nativephp.com/docs/mobile/2/getting-started/changelog

Utilize custom event classes for native calls in NativePHP Mobile. This allows for more structured and maintainable event handling, as demonstrated with the Dialog::alert example.

```php
Dialog::alert('Confirm', 'Delete this?', ['Cancel', 'Delete'])
    ->event(MyCustomEvent::class)
```
Tokens:
Raw