updateFavoriteGroup method
Future<Response<void> >
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,
Update Favorite Group Update information about a specific favorite group.
Parameters:
favoriteGroupType
- The type of group to fetch, must be a valid FavoriteType.favoriteGroupName
- The name of the group to fetch, must be a name of a FavoriteGroup.userId
- Must be a valid user ID.updateFavoriteGroupRequest
cancelToken
- ACancelToken
that can be used to cancel the operationheaders
- Can be used to add additional headers to the requestextras
- Can be used to add flags to the requestvalidateStatus
- AValidateStatus
callback that can be used to determine request success based on the HTTP status of the responseonSendProgress
- AProgressCallback
that can be used to get the send progressonReceiveProgress
- AProgressCallback
that can be used to get the receive progress
Returns a Future
Throws DioException
if API call or serialization fails
Implementation
Future<Response<void>> 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,
}) async {
final _path =
r'/favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId}'
.replaceAll(
'{' r'favoriteGroupType' '}', favoriteGroupType.toString())
.replaceAll(
'{' r'favoriteGroupName' '}', favoriteGroupName.toString())
.replaceAll('{' r'userId' '}', userId.toString());
final _options = Options(
method: r'PUT',
headers: <String, dynamic>{
...?headers,
},
extra: <String, dynamic>{
'secure': <Map<String, String>>[
{
'type': 'apiKey',
'name': 'authCookie',
'keyName': 'auth',
'where': '',
},
],
...?extra,
},
contentType: 'application/json',
validateStatus: validateStatus,
);
dynamic _bodyData;
try {
_bodyData = jsonEncode(updateFavoriteGroupRequest);
} catch (error, stackTrace) {
throw DioException(
requestOptions: _options.compose(
_dio.options,
_path,
),
type: DioExceptionType.unknown,
error: error,
stackTrace: stackTrace,
);
}
final _response = await _dio.request<Object>(
_path,
data: _bodyData,
options: _options,
cancelToken: cancelToken,
onSendProgress: onSendProgress,
onReceiveProgress: onReceiveProgress,
);
return _response;
}