Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GuiService

Allows developers to control what GuiObject is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.

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.
Tags: [NotCreatable, Service, NotReplicated]

Member index 95

HistoryMember
553AutoSelectGuiEnabled: bool
553GuiNavigationEnabled: bool
553IsModalDialog: bool
553IsWindows: bool
553MenuIsOpen: bool
634PreferredTextSize: PreferredTextSize
553SelectedObject: GuiObject
599TopbarInset: Rect
553TouchControlsEnabled: bool
573AddCenterDialog(dialog: Instance, centerDialogType: CenterDialogType, showFunction: Function, hideFunction: Function): null
573AddKey(key: string): null
642AddSelectionParent(selectionName: string, selectionParent: Instance): null
642AddSelectionTuple(selectionName: string, selections: Tuple): null
573AddSpecialKey(key: SpecialKey): null
573BroadcastNotification(data: string, notificationType: int): null
573ClearError(): null
573CloseInspectMenu(): null
462CloseStatsBasedOnInputString(input: string): bool
641DismissNotification(notificationId: string): bool
573ForceTenFootInterface(isForced: bool): null
462GetBrickCount(): int
462GetClosestDialogToPosition(position: Vector3): Instance
462GetEmotesMenuOpen(): bool
462GetErrorCode(): ConnectionError
553GetErrorMessage(): string
462GetErrorType(): ConnectionError
462GetGameplayPausedNotificationEnabled(): bool
462GetGuiInset(): Tuple
538GetGuiIsVisible(guiType: GuiType): bool
592GetHardwareSafeViewport(): Vector2
462GetInspectMenuEnabled(): bool
462GetNotificationTypeList(): Dictionary
651GetRawScreenScale(): float
462GetResolutionScale(): int
462GetSafeZoneOffsets(): Dictionary
462GetScreenResolution(): Vector2
462GetUiMessage(): string
573InspectPlayerFromHumanoidDescription(humanoidDescription: Instance, name: string): null
573InspectPlayerFromUserId(userId: int64): null
573InspectPlayerFromUserIdWithCtx(userId: int64, ctx: string): null
462IsMemoryTrackerEnabled(): bool
462IsTenFootInterface(): bool
650OnNotificationDisplayed(notificationId: string): null
650OnNotificationInteraction(notificationId: string, buttonIndex: int): null
573OpenBrowserWindow(url: string): null
573OpenNativeOverlay(title: string, url: string): null
573RemoveCenterDialog(dialog: Instance): null
573RemoveKey(key: string): null
642RemoveSelectionGroup(selectionName: string): null
573RemoveSpecialKey(key: SpecialKey): null
573Select(selectionParent: Instance): null
641SendNotification(notificationInfo: Dictionary): string
598SendUIOcclusionMetricsForQueryRegion(position: UDim2, size: UDim2, regionName: string): null
573SetEmotesMenuOpen(isOpen: bool): null
573SetGameplayPausedNotificationEnabled(enabled: bool): null
573SetGlobalGuiInset(x1: int, y1: int, x2: int, y2: int): null
573SetHardwareSafeAreaInsets(left: float, top: float, right: float, bottom: float): null
573SetInspectMenuEnabled(enabled: bool): null
573SetMenuIsOpen(open: bool, menuName: string = default): null
573SetPurchasePromptIsShown(isShown: bool): null
573SetSafeZoneOffsets(top: float, bottom: float, left: float, right: float): null
591SetTopbarInset(topbarInset: Rect): null
573SetUiMessage(msgType: UiMessageType, uiMessage: string = errorCode): null
462ShowStatsBasedOnInputString(input: string): bool
573ToggleFullscreen(): null
587ToggleGuiIsVisibleForCaptures(guiType: GuiType): null
573ToggleGuiIsVisibleIfAllowed(guiType: GuiType): null
462BrowserWindowClosed()
462CloseInspectMenuRequest()
489CoreGuiRenderOverflowed()
462EmotesMenuOpenChanged(isOpen: bool)
553ErrorMessageChanged(newErrorMessage: string)
538GuiVisibilityChangedSignal(guiType: GuiType, visible: bool)
462InspectMenuEnabledChangedSignal(enabled: bool)
462InspectPlayerFromHumanoidDescriptionRequest(humanoidDescription: Instance, name: string)
462InspectPlayerFromUserIdWithCtxRequest(userId: int64, ctx: string)
462KeyPressed(key: string, modifiers: string)
462MenuClosed()
462MenuOpened()
462NativeClose()
462NetworkPausedEnabledChanged(enabled: bool)
487Open9SliceEditor(selectedImageObject: Instance)
635OpenStyleEditor(styleBase: Instance)
561PurchasePromptShown()
462SafeZoneOffsetsChanged()
462ShowLeaveConfirmation()
462SpecialKeyPressed(key: SpecialKey, modifiers: string)
462UiMessageChanged(msgType: UiMessageType, newUiMessage: string)
573SendCoreUiNotification(title: string, text: string): null
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 21

HistoryMember
201GamepadNavigationEnabled: bool
304ScreenGuiEnabled: bool
213ShowLegacyPlayerList: bool
213UseLuaChat: bool
213Version: double
213GetConnectorCount(): int
213GetInstanceCount(): int
303GetNativeViewFeatureList(): Dictionary
213GetVoxelCount(): float
650NotificationDismissed(notificationId: string): null
650NotificationDisplayed(notificationId: string): null
303RequestNativeView(url: string, featureType: int): void
273SetErrorMessage(errorMessage: string): void
91SetGlobalSizeOffsetPixel(x: int, y: int): void
303ShowAppShellTabBar(value: bool): void
650UserInteractedWithNotification(notificationId: string, buttonIndex: int): null
304EscapeKeyPressed()
420InspectPlayerFromUserIdRequest(userId: int64)
642OpenAttenuationCurveEditor(selectedCurveObjects: Objects)
591TopbarInsetChanged(topbarInset: Dictionary)

Description

GuiService allows developers to control what GuiObject is currently being selected by the gamepad navigator, as well as check if Roblox's main menu is currently open.

History 315

Members 95

AddCenterDialog

Parameters (4)
dialogInstance
centerDialogTypeCenterDialogType
showFunctionFunction
hideFunctionFunction
Returns (1)
null

History 3

AddKey

Parameters (1)
keystring
Returns (1)
null

History 3

AddSelectionParent

Parameters (2)
selectionNamestring
selectionParentInstance
Returns (1)
null

Creates a gui selection group where gamepad gui navigation will only consider selectable gui objects that are within the group (children of selectionParent). A use case is you have a menu pop open, but there are other selectable objects on the screen (maybe from previous menus), but you want to the user to only be able to select gui objects in the new menu.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work. SelectionGroup should be used instead.

History 5

Tags: [Deprecated]

AddSelectionTuple

Parameters (2)
selectionNamestring
selectionsTuple
Returns (1)
null

Functions similarly to GuiService:AddSelectionParent(), but you can give it a tuple of GuiObject that you want to be contained in the group.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work. SelectionGroup should be used instead.

History 5

Tags: [Deprecated]

AddSpecialKey

Parameters (1)
keySpecialKey
Returns (1)
null

History 3

AutoSelectGuiEnabled

TypeDefault
bool

If activated, the Select button on a Gamepad or Backslash will automatically set a GUI as the selected object. Turning this off will mean that Gui navigation will still work if GuiService.GuiNavigationEnabled is enabled but you will have to set GuiService.SelectedObject manually to start Gui navigation.

History 4

BroadcastNotification

Parameters (2)
datastring
notificationTypeint
Returns (1)
null

History 3

BrowserWindowClosed

Parameters (0)
No parameters.
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

ClearError

Parameters (0)
No parameters.
Returns (1)
null

History 3

CloseInspectMenu

Parameters (0)
No parameters.
Returns (1)
null

This function closes the Inspect Menu, if open, when run from a LocalScript.

See also:

History 3

CloseInspectMenuRequest

Parameters (0)
No parameters.

History 2

CloseStatsBasedOnInputString

Parameters (1)
inputstring
Returns (1)
bool

History 2

CoreGuiRenderOverflowed

Parameters (0)
No parameters.

History 3

DismissNotification

Parameters (1)
notificationIdstring
Returns (1)
bool

History 1

EmotesMenuOpenChanged

Parameters (1)
isOpenbool

History 2

ErrorMessageChanged

Parameters (1)
newErrorMessagestring
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. UiMessageChanged should be used instead.

History 4

Tags: [Deprecated]

ForceTenFootInterface

Parameters (1)
isForcedbool
Returns (1)
null

History 3

GetBrickCount

Parameters (0)
No parameters.
Returns (1)
int

History 2

GetClosestDialogToPosition

Parameters (1)
positionVector3
Returns (1)
Instance

History 2

GetEmotesMenuOpen

Parameters (0)
No parameters.
Returns (1)
bool

Returns a boolean indicating whether or not the player Emotes menu is open.

Developers can open or close the Emotes menu by calling the GuiService:SetEmotesMenuOpen() function.

History 2

GetErrorCode

Parameters (0)
No parameters.
Returns (1)
ConnectionError

History 2

GetErrorMessage

Parameters (0)
No parameters.
Returns (1)
string
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. GetUiMessage should be used instead.

History 4

Tags: [Deprecated]

GetErrorType

Parameters (0)
No parameters.
Returns (1)
ConnectionError

History 2

GetGameplayPausedNotificationEnabled

Parameters (0)
No parameters.
Returns (1)
bool

This function returns whether or not the gameplay paused notification has been disabled by the developer.

Developers can enable or disable the notification by calling the GuiService:SetGameplayPausedNotificationEnabled() function.

See also:

History 2

GetGuiInset

Parameters (0)
No parameters.
Returns (1)
Tuple

Returns two Vector2 values representing the inset of user GUIs in pixels, from the top left corner of the screen and the bottom right corner of the screen respectively.

The inset values supplied by this function only take effect on ScreenGuis that have their IgnoreGuiInset property set to false.

History 2

GetGuiIsVisible

Parameters (1)
guiTypeGuiType
Returns (1)
bool

History 1

GetHardwareSafeViewport

Parameters (0)
No parameters.
Returns (1)
Vector2

History 1

GetInspectMenuEnabled

Parameters (0)
No parameters.
Returns (1)
bool

This function returns whether the Inspect and Buy menu functionality is currently enabled. The feature is enabled by default and can be set using the GuiService:SetInspectMenuEnabled() function.

See also:

History 2

GetNotificationTypeList

Parameters (0)
No parameters.
Returns (1)
Dictionary

History 2

GetRawScreenScale

Parameters (0)
No parameters.
Returns (1)
float

History 1

GetResolutionScale

Parameters (0)
No parameters.
Returns (1)
int

History 3

GetSafeZoneOffsets

Parameters (0)
No parameters.
Returns (1)
Dictionary

History 2

GetScreenResolution

Parameters (0)
No parameters.
Returns (1)
Vector2
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

GetUiMessage

Parameters (0)
No parameters.
Returns (1)
string

History 2

GuiNavigationEnabled

TypeDefault
bool

Used to enable and disable the default controller GUI navigation.

History 4

GuiVisibilityChangedSignal

Parameters (2)
guiTypeGuiType
visiblebool

History 1

InspectMenuEnabledChangedSignal

Parameters (1)
enabledbool

History 2

InspectPlayerFromHumanoidDescription

Parameters (2)
humanoidDescriptionInstance
namestring
Returns (1)
null

This function allows a developer to bring up the Inspect menu showing the assets listed in this HumanoidDescription object.

This allows further customization with what is shown in the Inspect Menu when players inspect other players in your game. If your game modifies what the players are wearing, you can instead give the Inspect Menu a HumanoidDescription object that represents what a player is wearing and those items will be shown. You should pass a name as well to represent the name of the player that will be inspected.

See also:

History 3

InspectPlayerFromHumanoidDescriptionRequest

Parameters (2)
humanoidDescriptionInstance
namestring

History 2

InspectPlayerFromUserId

Parameters (1)
userIdint64
Returns (1)
null

This function allows the Inspect Menu to appear showing the user that has the given UserId. This is especially useful when you want to inspect players who aren't in the current game.

This shows the same information as the "Currently Wearing" tab on the specified user's profile.

See also:

History 3

InspectPlayerFromUserIdWithCtx

Parameters (2)
userIdint64
ctxstring
Returns (1)
null

History 3

InspectPlayerFromUserIdWithCtxRequest

Parameters (2)
userIdint64
ctxstring

History 2

IsMemoryTrackerEnabled

Parameters (0)
No parameters.
Returns (1)
bool

History 2

IsModalDialog

TypeDefault
bool

This property tells whether or not a modal dialog is visible, such as the game menu or a purchase prompt.

This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

IsTenFootInterface

Parameters (0)
No parameters.
Returns (1)
bool

Returns true if the client is using the ten foot interface, which is a special version of Roblox's UI, exclusive to consoles. This is the only guaranteed way to verify if the user is on a console or not.

History 3

IsWindows

TypeDefault
bool

The IsWindows property defines if the user is playing on a computer running Windows.

This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

KeyPressed

Parameters (2)
keystring
modifiersstring

History 2

MenuClosed

Parameters (0)
No parameters.

Fires when the user closes the Roblox coregui escape menu.

History 2

MenuIsOpen

TypeDefault
bool

Returns true if any menu of CoreGui is open.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

MenuOpened

Parameters (0)
No parameters.

Fires when the user opens the Roblox coregui escape menu.

History 2

NativeClose

Parameters (0)
No parameters.

History 2

NetworkPausedEnabledChanged

Parameters (1)
enabledbool

History 2

OnNotificationDisplayed

Parameters (1)
notificationIdstring
Returns (1)
null

History 1

OnNotificationInteraction

Parameters (2)
notificationIdstring
buttonIndexint
Returns (1)
null

History 1

Open9SliceEditor

Parameters (1)
selectedImageObjectInstance

History 1

OpenBrowserWindow

Parameters (1)
urlstring
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

OpenNativeOverlay

Parameters (2)
titlestring
urlstring
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

OpenStyleEditor

Parameters (1)
styleBaseInstance

History 1

PreferredTextSize

TypeDefault
PreferredTextSize
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 1

Tags: [ReadOnly, NotReplicated]

PurchasePromptShown

Parameters (0)
No parameters.

History 1

RemoveCenterDialog

Parameters (1)
dialogInstance
Returns (1)
null

History 3

RemoveKey

Parameters (1)
keystring
Returns (1)
null

History 3

RemoveSelectionGroup

Parameters (1)
selectionNamestring
Returns (1)
null

Removes a group that was created with GuiService:AddSelectionParent() or GuiService:AddSelectionTuple().

This function is deprecated. It exists only for backward compatibility, and should not be used for new work. SelectionGroup should be used instead.

History 5

Tags: [Deprecated]

RemoveSpecialKey

Parameters (1)
keySpecialKey
Returns (1)
null

History 3

SafeZoneOffsetsChanged

Parameters (0)
No parameters.

History 2

Select

Parameters (1)
selectionParentInstance
Returns (1)
null

When Select is called on an instance selectionParent that is PlayerGui or a descendant of PlayerGui, the engine searches all available selectable, visible and on-screen GuiObjects that are descendants of selectionParent and sets the GuiService.SelectedObject to the GuiObject with the smallest GuiService.SelectionOrder.

History 3

SelectedObject

TypeDefault
GuiObject

Sets the GuiObject currently being focused on by the GUI Navigator (used for Gamepads). This may reset to nil if the object is off-screen.

This property is changed by the GuiObject.SelectionGained and GuiObject.SelectionLost events.

If you would like to determine when this property changes without tracking the SelectionGained and SelectionLost events for all GUI elements, you can use the Changed event.

History 7

SendCoreUiNotification

Parameters (2)
titlestring
textstring
Returns (1)
null

History 3

SendNotification

Parameters (1)
notificationInfoDictionary
Returns (1)
string

History 3

SendUIOcclusionMetricsForQueryRegion

Parameters (3)
positionUDim2
sizeUDim2
regionNamestring
Returns (1)
null

History 1

SetEmotesMenuOpen

Parameters (1)
isOpenbool
Returns (1)
null

Opens or closes the player Emotes menu.

History 3

SetGameplayPausedNotificationEnabled

Parameters (1)
enabledbool
Returns (1)
null

This method allows developers to disable the built-in notification when a players gameplay is paused. They can then add in their own UI if they wish to customize it.

Developers can query whether the notification is enabled by calling the GuiService:GetGameplayPausedNotificationEnabled() function.

See also:

History 3

SetGlobalGuiInset

Parameters (4)
x1int
y1int
x2int
y2int
Returns (1)
null

History 5

SetHardwareSafeAreaInsets

Parameters (4)
leftfloat
topfloat
rightfloat
bottomfloat
Returns (1)
null

History 2

SetInspectMenuEnabled

Parameters (1)
enabledbool
Returns (1)
null

This function allows developers to enable or disable default Inspect and Buy functionality. This is useful when you want to disable the feature in your game, entirely or during certain parts of your game (such as a cutscene). The feature is enabled by default.

The code sample below demonstrates how to disable the Inspect Menu for your game:

1
2
local GuiService = game:GetService("GuiService")
GuiService:SetInspectMenuEnabled(false)

See also:

History 3

SetMenuIsOpen

Parameters (2)Default
openbool
menuNamestringdefault
Returns (1)
null

History 4

SetPurchasePromptIsShown

Parameters (1)
isShownbool
Returns (1)
null

History 2

SetSafeZoneOffsets

Parameters (4)
topfloat
bottomfloat
leftfloat
rightfloat
Returns (1)
null

History 3

SetTopbarInset

Parameters (1)
topbarInsetRect
Returns (1)
null

History 2

SetUiMessage

Parameters (2)Default
msgTypeUiMessageType
uiMessagestringerrorCode
Returns (1)
null

History 4

ShowLeaveConfirmation

Parameters (0)
No parameters.

History 2

ShowStatsBasedOnInputString

Parameters (1)
inputstring
Returns (1)
bool

History 2

SpecialKeyPressed

Parameters (2)
keySpecialKey
modifiersstring

History 2

ToggleFullscreen

Parameters (0)
No parameters.
Returns (1)
null

History 3

ToggleGuiIsVisibleForCaptures

Parameters (1)
guiTypeGuiType
Returns (1)
null

History 1

ToggleGuiIsVisibleIfAllowed

Parameters (1)
guiTypeGuiType
Returns (1)
null

History 2

TopbarInset

TypeDefault
Rect

Returns a Rect object representing the unoccupied area between the Roblox left-most controls and the edge of the device safe area.

The value is dynamic and can be expected to change based on the visibility of UI controls such as changing the local player's Health property, usage of StarterGui:SetCoreGuiEnabled(), changing the size and position of Roblox UI Controls, and/or others. For this reason, it's recommend that you detect and react to changes of this property with Object:GetPropertyChangedSignal().

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

TouchControlsEnabled

TypeDefault
bool

Used to enable and disable touch controls and touch control display UI. Defaults to true.

History 2

UiMessageChanged

Parameters (2)
msgTypeUiMessageType
newUiMessagestring

History 2

Removed members 21

EscapeKeyPressed

Parameters (0)
No parameters.

History 2

GamepadNavigationEnabled

TypeDefault
bool

History 2

GetConnectorCount

Parameters (0)
No parameters.
Returns (1)
int

History 2

GetInstanceCount

Parameters (0)
No parameters.
Returns (1)
int

History 2

GetNativeViewFeatureList

Parameters (0)
No parameters.
Returns (1)
Dictionary

History 2

GetVoxelCount

Parameters (0)
No parameters.
Returns (1)
float

History 3

InspectPlayerFromUserIdRequest

Parameters (1)
userIdint64

History 4

NotificationDismissed

Parameters (1)
notificationIdstring
Returns (1)
null

History 2

NotificationDisplayed

Parameters (1)
notificationIdstring
Returns (1)
null

History 2

OpenAttenuationCurveEditor

Parameters (1)
selectedCurveObjectsObjects
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

RequestNativeView

Parameters (2)
urlstring
featureTypeint
Returns (1)
void

History 3

ScreenGuiEnabled

TypeDefault
bool

History 2

SetErrorMessage

Parameters (1)
errorMessagestring
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

SetGlobalSizeOffsetPixel

Parameters (2)
xint
yint
Returns (1)
void

History 4

ShowAppShellTabBar

Parameters (1)
valuebool
Returns (1)
void

History 2

ShowLegacyPlayerList

TypeDefault
bool

History 2

TopbarInsetChanged

Parameters (1)
topbarInsetDictionary

History 2

UseLuaChat

TypeDefault
bool
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

UserInteractedWithNotification

Parameters (2)
notificationIdstring
buttonIndexint
Returns (1)
null

History 2

Version

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

Settings