WebExeBuilder Documentation

setUserAgent

Category: Browser Control

Namespace: web.browser.setUserAgent

Description

Set a custom browser user agent string. This changes how the browser identifies itself to websites.

Syntax

await web.browser.setUserAgent(userAgent: string);

Parameters

  • userAgent (required) - The user agent string to set

Returns

Promise<boolean> - Returns true when operation completes

Example

Simple example

await web.browser.setUserAgent('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36');

Practical example

const customUA = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36';
await web.browser.setUserAgent(customUA);
await web.browser.reload();

Advanced example

async function setMobileUserAgent() {
    const mobileUA = 'Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15';
    
    await web.browser.setUserAgent(mobileUA);
    await web.browser.reload();
    
    console.log('Switched to mobile user agent');
    
    const currentUA = await web.browser.getUserAgent();
    console.log('Current UA:', currentUA);
}

Use Cases

  • Emulate different browsers
  • Test mobile compatibility
  • Access mobile-only sites
  • Bypass user agent restrictions
  • Test responsive designs
  • Emulate specific devices
  • Debug browser-specific issues
  • Custom browser identification
  • web.browser.getUserAgent()
  • web.browser.reload()

Notes

  • Part of browser control functionality
  • Asynchronous operation
  • Returns promise