puppeteer/docs/api/puppeteer.page.setuseragent.md

sidebar_label

sidebar_label
Page.setUserAgent

Page.setUserAgent() method

setUserAgent(): Promise<void>

Warning: This API is now obsolete.

Use Page.setUserAgent() instead.

Signature

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

Parameters

Parameter	Type	Description
userAgent	string	Specific user agent to use in this page
userAgentMetadata	Protocol.Emulation.UserAgentMetadata	(Optional)

Returns:

Promise<void>

Promise which resolves when the user agent is set.

setUserAgent(): Promise<void>

Signature

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

Parameters

Parameter	Type	Description
options	{ userAgent?: string; userAgentMetadata?: Protocol.Emulation.UserAgentMetadata; platform?: string; }	Object containing user agent and optional user agent metadata

Returns:

Promise<void>

Promise which resolves when the user agent is set.