BrowserService
Bridges the Roblox client to its native web browser or WebView.
This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
| Memory category | Instances |
|---|
Member index 13
Description
This service is reserved for Roblox's own code and isn't accessible from experience scripts.
BrowserService bridges the Roblox client to its native web browser or
embedded WebView. It opens browser windows and native overlays, runs
JavaScript inside the resulting WebView, and relays messages to and from the
web-side hybrid bridge (window.Roblox.Hybrid).
OpenBrowserWindow opens a URL only if it is allowlisted (a Roblox site, a
youtube.com/watch page, or a stripe.com or vnggames.com subdomain);
otherwise the request is rejected. OpenNativeOverlay opens a native overlay
for Roblox URLs only. SendCommand forwards a JSON command to the WebView,
ExecuteJavaScript evaluates a script inside it, and CloseBrowserWindow
closes it. OpenWeChatAuthWindow launches the Tencent (WeChat) authentication
flow, while ReturnToJavaScript and EmitHybridEvent invoke callbacks and
dispatch events on the web-side hybrid bridge. Signals such as
BrowserWindowClosed, BrowserWindowWillNavigate, JavaScriptCallback, and
AuthCookieCopiedToEngine report WebView activity back to the client.
History 36
- 573 Change ReturnType of SendCommand from void to null
- 573 Change ReturnType of ReturnToJavaScript from void to null
- 573 Change ReturnType of OpenWeChatAuthWindow from void to null
- 573 Change ReturnType of OpenNativeOverlay from void to null
- 573 Change ReturnType of OpenBrowserWindow from void to null
- 573 Change ReturnType of ExecuteJavaScript from void to null
- 573 Change ReturnType of EmitHybridEvent from void to null
- 573 Change ReturnType of CopyAuthCookieFromBrowserToEngine from void to null
- 573 Change ReturnType of CloseBrowserWindow from void to null
- 462 Change ThreadSafety of JavaScriptCallback from to Unsafe
- 462 Change ThreadSafety of BrowserWindowWillNavigate from to Unsafe
- 462 Change ThreadSafety of BrowserWindowClosed from to Unsafe
- 462 Change ThreadSafety of AuthCookieCopiedToEngine from to Unsafe
- 462 Change ThreadSafety of SendCommand from to Unsafe
- 462 Change ThreadSafety of ReturnToJavaScript from to Unsafe
- 462 Change ThreadSafety of OpenWeChatAuthWindow from to Unsafe
- 462 Change ThreadSafety of OpenNativeOverlay from to Unsafe
- 462 Change ThreadSafety of OpenBrowserWindow from to Unsafe
- 462 Change ThreadSafety of ExecuteJavaScript from to Unsafe
- 462 Change ThreadSafety of EmitHybridEvent from to Unsafe
- 462 Change ThreadSafety of CopyAuthCookieFromBrowserToEngine from to Unsafe
- 462 Change ThreadSafety of CloseBrowserWindow from to Unsafe
- 403 Add SendCommand
- 402 Add ExecuteJavaScript
- 374 Add AuthCookieCopiedToEngine
- 374 Add OpenWeChatAuthWindow
- 374 Add CopyAuthCookieFromBrowserToEngine
- 371 Add JavaScriptCallback
- 371 Add BrowserWindowWillNavigate
- 371 Add BrowserWindowClosed
- 371 Add ReturnToJavaScript
- 371 Add OpenNativeOverlay
- 371 Add OpenBrowserWindow
- 371 Add EmitHybridEvent
- 371 Add CloseBrowserWindow
- 371 Add BrowserService
Members 13
AuthCookieCopiedToEngine
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of AuthCookieCopiedToEngine from to Unsafe
- 374 Add AuthCookieCopiedToEngine
BrowserWindowClosed
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of BrowserWindowClosed from to Unsafe
- 371 Add BrowserWindowClosed
CloseBrowserWindow
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of CloseBrowserWindow from void to null
- 462 Change ThreadSafety of CloseBrowserWindow from to Unsafe
- 371 Add CloseBrowserWindow
CopyAuthCookieFromBrowserToEngine
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of CopyAuthCookieFromBrowserToEngine from void to null
- 462 Change ThreadSafety of CopyAuthCookieFromBrowserToEngine from to Unsafe
- 374 Add CopyAuthCookieFromBrowserToEngine
EmitHybridEvent
| Parameters (3) | ||
|---|---|---|
| moduleName | string | |
| eventName | string | |
| params | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of EmitHybridEvent from void to null
- 462 Change ThreadSafety of EmitHybridEvent from to Unsafe
- 371 Add EmitHybridEvent
ExecuteJavaScript
| Parameters (1) | ||
|---|---|---|
| javascript | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of ExecuteJavaScript from void to null
- 462 Change ThreadSafety of ExecuteJavaScript from to Unsafe
- 402 Add ExecuteJavaScript
JavaScriptCallback
| Parameters (1) | |
|---|---|
| content | string |
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 462 Change ThreadSafety of JavaScriptCallback from to Unsafe
- 371 Add JavaScriptCallback
OpenBrowserWindow
| Parameters (1) | ||
|---|---|---|
| url | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of OpenBrowserWindow from void to null
- 462 Change ThreadSafety of OpenBrowserWindow from to Unsafe
- 371 Add OpenBrowserWindow
OpenNativeOverlay
| Parameters (2) | ||
|---|---|---|
| title | string | |
| url | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of OpenNativeOverlay from void to null
- 462 Change ThreadSafety of OpenNativeOverlay from to Unsafe
- 371 Add OpenNativeOverlay
OpenWeChatAuthWindow
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of OpenWeChatAuthWindow from void to null
- 462 Change ThreadSafety of OpenWeChatAuthWindow from to Unsafe
- 374 Add OpenWeChatAuthWindow
ReturnToJavaScript
| Parameters (3) | ||
|---|---|---|
| callbackId | string | |
| success | bool | |
| params | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of ReturnToJavaScript from void to null
- 462 Change ThreadSafety of ReturnToJavaScript from to Unsafe
- 371 Add ReturnToJavaScript
SendCommand
| Parameters (1) | ||
|---|---|---|
| command | string | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of SendCommand from void to null
- 462 Change ThreadSafety of SendCommand from to Unsafe
- 403 Add SendCommand