@adeprez/capacitor-user-agent

User Agent get/set/reset plugin for Capacitor

Install

npm install @adeprez/capacitor-user-agent
npx cap sync

Usage

import { UserAgent } from '@adeprez/capacitor-user-agent';

async getMyUserAgent(): Promise<string> {
  const result = await UserAgent.get();
  return result.userAgent;
}

setMyUserAgent(userAgent: string): Promise<void> {
  return UserAgent.set({userAgent});
}

API

• get()
• set(...)
• reset()

get()

get() => Promise<{ userAgent: string; }>

Get the Webview's user agent

Returns: Promise<{ userAgent: string; }>

set(...)

set(options: { userAgent: string; reloadOnChange?: boolean; }) => Promise<void>

Update the Webview user agent (Android and iOS only). Set reloadOnChange to true to reload the page when the user agent changes (default is false). Starting from KITKAT Android version, changing the user-agent while loading a web page causes WebView to initiate loading once again.

| Param | Type | | ------------- | ------------------------------------------------------------- | | options | { userAgent: string; reloadOnChange?: boolean; } |

reset()

reset() => Promise<void>

Reset the Webview user agent (Android and iOS only)