Class UserAgentHelper

Utility class for generating user agent strings for Copilot Studio client requests.

Index

Constructors

Methods

getProductInfo getVersion getVersionString

Constructors

constructor

new UserAgentHelper(): UserAgentHelper
Returns UserAgentHelper

Methods

`Static`getProductInfo

getProductInfo(): string
Generates a user agent string appropriate for the current environment.
- For browser environments, includes the browser's user agent.
- For Node.js environments, includes Node version, platform, architecture, and release.
Returns string
A user agent string for HTTP headers.
- Defined in userAgentHelper.ts:19

`Static`getVersion

getVersion(): string
Gets the SDK version number.

Returns string
The version number (e.g., "0.1.0")
- Defined in userAgentHelper.ts:46

`Static`getVersionString

getVersionString(): string
Gets just the version string without environment details.

Returns string
The version string (e.g., "CopilotStudioClient.agents-sdk-js/0.1.0")
- Defined in userAgentHelper.ts:38