getFavoriteGroup method
Show Favorite Group Fetch 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.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 containing a Response
with a FavoriteGroup as data
Throws DioException
if API call or serialization fails
Implementation
Future<Response<FavoriteGroup>> 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,
}) 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'GET',
headers: <String, dynamic>{
...?headers,
},
extra: <String, dynamic>{
'secure': <Map<String, String>>[
{
'type': 'apiKey',
'name': 'authCookie',
'keyName': 'auth',
'where': '',
},
],
...?extra,
},
validateStatus: validateStatus,
);
final _response = await _dio.request<Object>(
_path,
options: _options,
cancelToken: cancelToken,
onSendProgress: onSendProgress,
onReceiveProgress: onReceiveProgress,
);
FavoriteGroup? _responseData;
try {
final rawData = _response.data;
_responseData = rawData == null
? null
: deserialize<FavoriteGroup, FavoriteGroup>(rawData, 'FavoriteGroup',
growable: true);
} catch (error, stackTrace) {
throw DioException(
requestOptions: _response.requestOptions,
response: _response,
type: DioExceptionType.unknown,
error: error,
stackTrace: stackTrace,
);
}
return Response<FavoriteGroup>(
data: _responseData,
headers: _response.headers,
isRedirect: _response.isRedirect,
requestOptions: _response.requestOptions,
redirects: _response.redirects,
statusCode: _response.statusCode,
statusMessage: _response.statusMessage,
extra: _response.extra,
);
}