WorldsApi class

Constructors

WorldsApi(Dio _dio)

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createWorld({CreateWorldRequest? createWorldRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<World>>

Create World Create a new world. This endpoint requires `assetUrl` to be a valid File object with `.vrcw` file extension, and `imageUrl` to be a valid File object with an image file extension.

deleteWorld({required String worldId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Delete World Delete a world. Notice a world is never fully &quot;deleted&quot;, only its ReleaseStatus is set to &quot;hidden&quot; and the linked Files are deleted. The WorldID is permanently reserved.

getActiveWorlds({bool? featured, SortOption? sort, int? n = 60, OrderOption? order, int? offset, String? search, String? tag, String? notag, ReleaseStatus? releaseStatus, String? maxUnityVersion, String? minUnityVersion, String? platform, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<LimitedWorld>>>

List Active Worlds Search and list currently Active worlds by query filters.

getFavoritedWorlds({bool? featured, SortOption? sort, int? n = 60, OrderOption? order, int? offset, String? search, String? tag, String? notag, ReleaseStatus? releaseStatus, String? maxUnityVersion, String? minUnityVersion, String? platform, String? userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<LimitedWorld>>>

List Favorited Worlds Search and list favorited worlds by query filters.

getRecentWorlds({bool? featured, SortOption? sort, int? n = 60, OrderOption? order, int? offset, String? search, String? tag, String? notag, ReleaseStatus? releaseStatus, String? maxUnityVersion, String? minUnityVersion, String? platform, String? userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<LimitedWorld>>>

List Recent Worlds Search and list recently visited worlds by query filters.

getWorld({required String worldId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<World>>

Get World by ID Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.

getWorldInstance({required String worldId, required String instanceId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Instance>>

Get World Instance Returns a worlds instance.

getWorldMetadata({required String worldId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<WorldMetadata>>

Get World Metadata Return a worlds custom metadata. This is currently believed to be unused. Metadata can be set with `updateWorld` and can be any arbitrary object.

getWorldPublishStatus({required String worldId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<WorldPublishStatus>>

Get World Publish Status Returns a worlds publish status.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

publishWorld({required String worldId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Publish World Publish a world. You can only publish one world per week.

searchWorlds({bool? featured, SortOption? sort, String? user, String? userId, int? n = 60, OrderOption? order, int? offset, String? search, String? tag, String? notag, ReleaseStatus? releaseStatus, String? maxUnityVersion, String? minUnityVersion, String? platform, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<LimitedWorld>>>

Search All Worlds Search and list any worlds by query filters.

toString() → String

A string representation of this object.

inherited

unpublishWorld({required String worldId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Unpublish World Unpublish a world.

updateWorld({required String worldId, UpdateWorldRequest? updateWorldRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<World>>

Update World Update information about a specific World.

Operators

operator ==(Object other) → bool

The equality operator.

inherited