Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ExperienceNotificationService

Service containing methods to validate users and prompt them to enable experience notifications.

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

Member index 5

HistoryMember
615CanPromptOptInAsync(): bool
615InvokeOptInPromptClosed(): null
615PromptOptIn(): null
615OptInPromptClosed()
615PromptOptInRequested()
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 1

HistoryMember
616CreateUserNotificationAsync(userId: string, userNotification: UserNotification): Instance

Description

Experience Notifications are a way for 13+ users to keep up with their favorite experiences through timely, personalized notifications. This service contains methods to validate users and prompt them to enable notifications.

History 8

Members 5

CanPromptOptInAsync

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

CanPromptOptInAsync() returns true if the local player can be prompted to enable notifications. You should always use the result of this method before calling PromptOptIn() since the ability to be prompted depends on various factors like the player's age or whether they've already enabled notifications for your experience.

This method always infers the local player (Players.LocalPlayer) and it can only be called from a LocalScript or from a Script with RunContext set to Client. It should also be called in a pcall() since it's an asynchronous network call that may occasionally fail.

See Experience Notifications for more details on implementing and customizing notifications, using launch data, and more.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

InvokeOptInPromptClosed

Parameters (0)
No parameters.
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

OptInPromptClosed

Parameters (0)
No parameters.

This event fires when the local player closes a prompt that was displayed through PromptOptIn(). It can only be connected in a LocalScript or in a Script with RunContext set to Client.

See Experience Notifications for more details on implementing and customizing notifications, using launch data, and more.

Thread safetyUnsafe

History 1

PromptOptIn

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

PromptOptIn() prompts the local player to enable notifications through an in-experience modal. You should always use the result of CanPromptOptInAsync() before calling this method since the ability to be prompted depends on various factors like the player's age or whether they've already enabled notifications for your experience.

This method always infers the local player (Players.LocalPlayer) and it can only be called from a LocalScript or from a Script with RunContext set to Client.

See Experience Notifications for more details on implementing and customizing notifications, using launch data, and more.

Thread safetyUnsafe

History 1

PromptOptInRequested

Parameters (0)
No parameters.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Removed members 1

CreateUserNotificationAsync

Parameters (2)
userIdstring
userNotificationUserNotification
Returns (1)
Instance
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

Settings