FavoritesApi class

Constructors

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

addFavorite({AddFavoriteRequest? addFavoriteRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Favorite>>

Add Favorite Add a new favorite. Friend groups are named `group_0` through `group_3`. Avatar and World groups are named `avatars1` to `avatars4` and `worlds1` to `worlds4`. You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides.

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

Clear Favorite Group Clear ALL contents of a specific favorite group.

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

Show Favorite Return information about a specific Favorite.

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

Show Favorite Group Fetch information about a specific favorite group.

getFavoriteGroups({int? n = 60, int? offset, String? ownerId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<FavoriteGroup>>>

List Favorite Groups Return a list of favorite groups owned by a user. Returns the same information as `getFavoriteGroups`.

getFavorites({int? n = 60, int? offset, String? type, String? tag, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<Favorite>>>

List Favorites Returns a list of favorites.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

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

Remove Favorite Remove a favorite from your favorites list.

toString() → String

A string representation of this object.

inherited

updateFavoriteGroup({required String favoriteGroupType, required String favoriteGroupName, required String userId, UpdateFavoriteGroupRequest? updateFavoriteGroupRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Update Favorite Group Update information about a specific favorite group.

Operators

operator ==(Object other) → bool

The equality operator.

inherited