@amityco/ts-sdk-react-native/src/commentRepository/api/softDeleteComment.ts

Amity Social Cloud Typescript SDK

import { getActiveClient } from '~/client/api';

import { deleteComment } from './deleteComment';

/* begin_public_function
  id: comment.soft_delete
*/
/**
 * ```js
 * import { CommentRepository } from '@amityco/ts-sdk-react-native'
 * const success = await CommentRepository.softDeleteComment('foobar')
 * ```
 *
 * Deletes a {@link Amity.Comment}
 *
 * @param commentId The {@link Amity.Comment} ID to delete
 * @return A success boolean if the {@link Amity.Comment} was deleted
 *
 * @category Comment API
 * @async
 */
export const softDeleteComment = async (
  commentId: Amity.Comment['commentId'],
): Promise<Amity.Comment> => {
  const client = getActiveClient();
  client.log('comment/softDeleteComment', commentId);

  const softDeleted = deleteComment(commentId);

  return softDeleted;
};
/* end_public_function */