Page.setUserAgent() method

<h2 id="overload-1">setUserAgent(): Promise<void></h2>

Warning: This API is now obsolete.

Use Page.setUserAgent() instead.

Signature

typescript

class Page {
  abstract setUserAgent(
    userAgent: string,
    userAgentMetadata?: Protocol.Emulation.UserAgentMetadata,
  ): Promise<void>;
}

Parameters

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

userAgent

</td><td>

string

</td><td>

Specific user agent to use in this page

</td></tr> <tr><td>

userAgentMetadata

</td><td>

Protocol.Emulation.UserAgentMetadata

</td><td>

(Optional)

</td></tr> </tbody></table>

Returns:

Promise<void>

Promise which resolves when the user agent is set.

<h2 id="overload-2">setUserAgent(): Promise<void></h2>

Signature

typescript

class Page {
  abstract setUserAgent(options: {
    userAgent?: string;
    userAgentMetadata?: Protocol.Emulation.UserAgentMetadata;
    platform?: string;
  }): Promise<void>;
}

Parameters

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

options

</td><td>

{ userAgent?: string; userAgentMetadata?: Protocol.Emulation.UserAgentMetadata; platform?: string; }

</td><td>

Object containing user agent and optional user agent metadata

</td></tr> </tbody></table>

Returns:

Promise<void>

Promise which resolves when the user agent is set.