AvatarsApi class

Constructors

AvatarsApi(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

createAvatar({CreateAvatarRequest? createAvatarRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Avatar>>

Create Avatar Create an avatar. It's possible to optionally specify a ID if you want a custom one. Attempting to create an Avatar with an already claimed ID will result in a DB error.

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

Delete Avatar Delete an avatar. Notice an avatar is never fully &quot;deleted&quot;, only its ReleaseStatus is set to &quot;hidden&quot; and the linked Files are deleted. The AvatarID is permanently reserved.

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

Get Avatar Get information about a specific Avatar.

getFavoritedAvatars({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<Avatar>>>

List Favorited Avatars Search and list favorited avatars by query filters.

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

Get Own Avatar Get the current avatar for the user. This will return an error for any other user than the one logged in.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

searchAvatars({bool? featured, SortOption? sort, String? user, String? userId, int? n = 60, OrderOption? order, int? offset, 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<Avatar>>>

Search Avatars Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.

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

Select Avatar Switches into that avatar.

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

Select Fallback Avatar Switches into that avatar as your fallback avatar.

toString() → String

A string representation of this object.

inherited

updateAvatar({required String avatarId, UpdateAvatarRequest? updateAvatarRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Avatar>>

Update Avatar Update information about a specific avatar.

Operators

operator ==(Object other) → bool

The equality operator.

inherited