OpenCloudService
Deprecated. Do not use for new work; prefer HttpService for in-experience HTTP requests.
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.
This class is a service. It is a singleton that may be acquired with GetService.
| Memory category | Instances |
|---|
Member index 5
Description
Deprecated. Do not use for new work; prefer HttpService for in-experience HTTP requests. See the In-experience HTTP requests guide.
History 11
- 698 Change Tags of InvokeAsync from [Yields] to [Yields, Deprecated]
- 698 Change Tags of GetApiV1 from [] to [Deprecated]
- 698 Change Tags of OpenCloudService from [NotCreatable, Service, NotReplicated] to [NotCreatable, Service, NotReplicated, Deprecated]
- 698 Change PreferredDescriptor of OpenCloudService from to HttpService
- 653 Change Parameters of InvokeAsync from (version: string, methodName: string, arguments: Dictionary) to (version: string, methodName: string, arguments: Dictionary, headers: Dictionary = nil)
- 600 Add RegistrationComplete
- 598 Add RegisterOpenCloud
- 598 Add InvokeAsync
- 598 Add HttpRequestAsync
- 583 Add GetApiV1
- 581 Add OpenCloudService
Members 5
GetApiV1
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| OpenCloudApiV1 | ||
Deprecated. Always raises an error with the message
"API is not enabled".
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
HttpRequestAsync
| Parameters (1) | ||
|---|---|---|
| options | Dictionary | |
| Returns (1) | ||
| Dictionary | ||
This function yields. It will block the calling thread until completion.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 598 Add HttpRequestAsync
InvokeAsync
| Parameters (4) | Default | |
|---|---|---|
| version | string | |
| methodName | string | |
| arguments | Dictionary | |
| headers | Dictionary | nil |
| Returns (1) | ||
| Dictionary | ||
Deprecated. Do not use for new work.
Dispatches a server-side Open Cloud call identified by version and
methodName with the given arguments and optional headers, and
returns the response dictionary.
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 safety | Unsafe |
|---|
History 3
- 698 Change Tags of InvokeAsync from [Yields] to [Yields, Deprecated]
- 653 Change Parameters of InvokeAsync from (version: string, methodName: string, arguments: Dictionary) to (version: string, methodName: string, arguments: Dictionary, headers: Dictionary = nil)
- 598 Add InvokeAsync
RegisterOpenCloud
| Parameters (3) | ||
|---|---|---|
| version | string | |
| methodName | string | |
| method | Function | |
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 598 Add RegisterOpenCloud
RegistrationComplete
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |