@relatiohq/opencloud
@relatiohq/opencloud
Classes
| Class | Description |
|---|---|
| OpenCloudError | Base error class for all Roblox Open Cloud API errors. Extends the native Error class with additional context about API failures. |
| RateLimitError | Error thrown when API rate limits are exceeded. Extends OpenCloudError with retry timing information. |
| AuthError | Error thrown when authentication fails or credentials are invalid. This typically indicates an invalid or missing API key. |
| OpenCloud | Main entry point for the Roblox Open Cloud SDK. Provides access to all Roblox Open Cloud API resources. |
| Groups | API client for Roblox Group endpoints. Provides methods to retrieve group information, shouts, and group memberships. |
| Users | API client for Roblox Users endpoints. Provides methods to retrieve user information, inventory, and asset quotas. |
Interfaces
| Interface | Description |
|---|---|
| HttpOptions | Configuration options for the HTTP client. |
| OpenCloudConfig | Configuration options for initializing the OpenCloud SDK client. |
| ListOptions | Common options for list/pagination operations. |
| Group | - |
| GroupMembershipItem | - |
| JoinRequestItem | - |
| GroupShout | - |
| GroupPermissions | - |
| GroupRole | - |
| User | - |
| GenerateThumbnailOptions | - |
| UserThumbnail | - |
| AssetQuota | - |
| CollectibleDetails | - |
| AssetDetails | - |
| BadgeDetails | - |
| GamePassDetails | - |
| PrivateServerDetails | - |
| InventoryItem | - |
| UserNotificationSource | - |
| UserNotificationPayload | - |
| UserNotificationResponse | - |
| UserNotificationBody | - |
Type Aliases
| Type Alias | Description |
|---|---|
| Page | Generic paginated response type for list operations. Combines pagination metadata with the actual list data. |
| GroupRolesPage | - |
| GroupMembershipItemsPage | - |
| JoinRequestItemsPage | - |
| SocialNetworkProfiles | - |
| SocialNetworkVisibility | - |
| ThumbnailFormat | - |
| ThumbnailShape | - |
| QuotaType | - |
| AssetType | - |
| QuotaPeriod | - |
| InventoryItemAssetType | - |
| InstanceState | - |
| InventoryItemsPage | - |
| AssetQuotasPage | - |
| NotificationType | - |