deleteNoteComment method
Soft-delete (native) or hard-delete (provider) a comment.
Allowed for the comment author and for the note owner.
Parameters:
-
String id (required): Note id.
-
String commentId (required): Comment id.
-
String accountId: Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with
provider. If omitted on a list endpoint the call fans out across every connected account. -
String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
Implementation
Future<SuccessFlag?> deleteNoteComment(String id, String commentId, { String? accountId, String? xWorkspaceID, }) async {
final response = await deleteNoteCommentWithHttpInfo(id, commentId, accountId: accountId, xWorkspaceID: xWorkspaceID, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'SuccessFlag',) as SuccessFlag;
}
return null;
}