Overview

Builder used to create UserAgentMetadata objects.

Examples:

  // Create a setting with default options.
  new UserAgentMetadata.Builder().build();

  // Create a setting with a brand version contains brand name: myBrand, major version: 100,
  // full version: 100.1.1.1.
  BrandVersion brandVersion = new BrandVersion.Builder().setBrand("myBrand")
                                                        .setMajorVersion("100")
                                                        .setFullVersion("100.1.1.1")
                                                        .build();
  new UserAgentMetadata.Builder().setBrandVersionList(Collections.singletonList(brandVersion))
                                 .build();

  // Create a setting brand version, platform, platform version and bitness.
  new UserAgentMetadata.Builder().setBrandVersionList(Collections.singletonList(brandVersion))
                                 .setPlatform("myPlatform")
                                 .setPlatform("1.1.1.1")
                                 .setBitness(BITNESS_64)
                                 .build();
 

Summary

Constructors

Create an empty UserAgentMetadata Builder.

Create a UserAgentMetadata Builder from an existing UserAgentMetadata object.

Methods

Builds the current settings into a UserAgentMetadata object.

Returns:

The UserAgentMetadata object represented by this Builder

Sets user-agent metadata brands and their versions. The brand name, major version and full version should not be blank. The default value is an empty list which means the system default user-agent metadata brands and versions will be used to generate the user-agent client hints.

Parameters:

brandVersions: a list of UserAgentMetadata.BrandVersion used to generated user-agent client hints sec-cu-ua and sec-ch-ua-full-version-list.

Sets the user-agent metadata full version. The full version should not be blank, even though the spec about brand full version could be empty. A blank full version could cause inconsistent brands when generating brand version related user-agent client hints. It also provides a bad experience for developers when processing the brand full version. If null is provided, the system default value will be used to generate the client hint.

Parameters:

fullVersion: The full version is used to generate user-agent client hint sec-ch-ua-full-version.

Sets the user-agent metadata platform. The platform should not be blank. If null is provided, the system default value will be used to generate the client hint.

Parameters:

platform: The platform is used to generate user-agent client hint sec-ch-ua-platform.

Sets the user-agent metadata platform version. If null is provided, the system default value will be used to generate the client hint.

Parameters:

platformVersion: The platform version is used to generate user-agent client hint sec-ch-ua-platform-version.

Sets the user-agent metadata architecture. If null is provided, the system default value will be used to generate the client hint.

Parameters:

architecture: The architecture is used to generate user-agent client hint sec-ch-ua-arch.

Sets the user-agent metadata model. If null is provided, the system default value will be used to generate the client hint.

Parameters:

model: The model is used to generate user-agent client hint sec-ch-ua-model.

Sets the user-agent metadata mobile, the default value is true.

Parameters:

mobile: The mobile is used to generate user-agent client hint sec-ch-ua-mobile.

Sets the user-agent metadata bitness, the default value is UserAgentMetadata.BITNESS_DEFAULT, which indicates an empty string for sec-ch-ua-bitness.

Parameters:

bitness: The bitness is used to generate user-agent client hint sec-ch-ua-bitness.

Sets the user-agent metadata wow64, the default is false.

Parameters:

wow64: The wow64 is used to generate user-agent client hint sec-ch-ua-wow64.