Skip to main content

Module: hooks/useSCBlockedUsersManager

Functions​

useSCBlockedUsersManager​

▸ useSCBlockedUsersManager(user?): { block: undefined ; blocked: number[] = data; isBlocked: undefined ; isLoading: () => boolean ; loading: boolean ; refresh: undefined } | { block: (user: SCUserType) => Promise<any> ; blocked: number[] = data; isBlocked: (user: SCUserType) => boolean ; isLoading: () => boolean ; loading: boolean ; refresh: (setLoadingStatus: boolean) => Promise<number[]> }

info

This custom hook is used to manage blocked users.

How to use it:

Follow these steps:

1. const scUserContext: SCUserContextType = useSCUser();
2. const scBlockedUsersManager: SCBlockedUsersManagerType = scUserContext.manager.blockedUsers;
3. scBlockedUsersManager.isBlocked(user)

Parameters​

NameType
user?SCUserType

Returns​

{ block: undefined ; blocked: number[] = data; isBlocked: undefined ; isLoading: () => boolean ; loading: boolean ; refresh: undefined } | { block: (user: SCUserType) => Promise<any> ; blocked: number[] = data; isBlocked: (user: SCUserType) => boolean ; isLoading: () => boolean ; loading: boolean ; refresh: (setLoadingStatus: boolean) => Promise<number[]> }

Defined in​

packages/react-core/src/hooks/useSCBlockedUsersManager.ts:22