Class
OpenCloudApiV1
NotCreatableNotReplicatedDeprecated
Deprecated Open Cloud API surface for in-experience cloud operations such as user notifications.
Deprecated. This class is deprecated and should not be used for new work. Use
HttpService instead and see the
In-experience HTTP requests guide.
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.
Methods 2#
| CreateModel | Creates and returns an OpenCloudModel container for a registered model
type name.DeprecatedCustomLuaState |
| CreateUserNotificationAsync | Deprecated method that attempted to send a user notification via Open Cloud; always errors.DeprecatedYields |
CreateModel(name: string): OpenCloudModel#
DeprecatedCustomLuaStateDeprecated
Deprecated. This method is deprecated. Do not use it for new work.
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.
| Name | Type | Default | Description |
|---|---|---|---|
name | string | The registered model type name (for example, "UserNotification"). |
Returns
OpenCloudModel— AnOpenCloudModelcontainer wrapping a typed model instance.
CreateUserNotificationAsync(user: string, userNotification: OpenCloudModel): OpenCloudModel#
YieldsDeprecatedDeprecated
Deprecated. This method is deprecated. Do not use it for new work.
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.
| Name | Type | Default | Description |
|---|---|---|---|
user | string | The target user identifier. | |
userNotification | OpenCloudModel | An OpenCloudModel container (from
OpenCloudApiV1:CreateModel()) populated with notification
payload fields. |
Returns
OpenCloudModel— Unused; the call always errors.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild