@amityco/ts-sdk-react-native/src/userRepository/relationship/block/api/blockUser.ts

Amity Social Cloud Typescript SDK

import { getActiveClient } from '~/client/api';
import { ingestInCache } from '~/cache/api/ingestInCache';
import { fireEvent } from '~/core/events';
import { upsertInCache } from '~/cache/api';
import { prepareFollowStatusPayload } from '../../follow/utils';

/* begin_public_function
  id: user.relationship.block
*/
/**
 * ```js
 * import { UserRepository } from '@amityco/ts-sdk-react-native'
 * const blockedUser = await UserRepository.blockUser('userId')
 * ```
 *
 * Blocks a {@link Amity.InternalUser}
 *
 * @param userId The ID of the {@link Amity.InternalUser} to block
 * @returns the blocked {@link Amity.InternalUser} object
 *
 * @category Post API
 * @async
 */
export const blockUser = async (
  userId: Amity.InternalUser['userId'],
): Promise<Amity.BlockedPayload> => {
  const client = getActiveClient();

  client.log('user/blockUser', userId);
  const { data } = await client.http.post<Amity.BlockedPayload>(`/api/v4/me/user-blocks/${userId}`);

  const cachedAt = client.cache && Date.now();

  const { follows, followCounts } = data;

  const followStatus = { follows };

  if (client.cache) {
    ingestInCache(followStatus, { cachedAt });
    upsertInCache(['followInfo', 'get', userId], followCounts[0], { cachedAt });
  }

  const payload = prepareFollowStatusPayload(followStatus);

  fireEvent('local.follow.unfollowed', payload);

  return data;
};
/* end_public_function */