Reference API Roblox

Engine API

Website

Related

Reference API Roblox

OpenCloudApiV1

Deprecated Open Cloud API surface for in-experience cloud operations such as user notifications.

This class is deprecated. It exists only for backward compatibility, and should not be used for new work. HttpService should be used instead.
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.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated, Deprecated]

Member index 2

HistoryMember
698CreateModel(name: string): OpenCloudModel
698CreateUserNotificationAsync(user: string, userNotification: OpenCloudModel): OpenCloudModel
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: 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()
657StyledPropertiesChanged()
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)

Description

Deprecated Open Cloud API class for in-experience cloud operations. Do not use it for new work. Use HttpService with the In-experience HTTP requests workflow instead.

History 7

Members 2

CreateModel

Parameters (1)
namestring
Returns (1)
OpenCloudModel

Deprecated. Creates and returns an OpenCloudModel container of the given type name. The factory instantiates a model object that can hold Open Cloud data structures (such as a user-notification payload) for use with other OpenCloudApiV1 methods.

The name parameter must match a registered model type (for example, "UserNotification"). The returned container wraps a typed model instance whose properties are accessible from Luau via PascalCase keys.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 2

Tags: [Deprecated, CustomLuaState]

CreateUserNotificationAsync

Parameters (2)
userstring
userNotificationOpenCloudModel
Returns (1)
OpenCloudModel

Deprecated. Attempted to send a notification to the specified user via the Open Cloud Notifications API. Always errors with "API CreateUserNotificationAsync is not enabled."

The user parameter is the target user identifier and userNotification is an OpenCloudModel container (created via OpenCloudApiV1:CreateModel()) populated with notification payload fields.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields, Deprecated]

Settings