@amityco/ts-sdk
Version:
Amity Social Cloud Typescript SDK
20 lines • 718 B
TypeScript
/**
* ```js
* import { onUserDidBlock } from '@amityco/ts-sdk'
* const dispose = onUserDidBlock(status => {
* // ...
* })
* ```
*
* Fired when a block relationship is created in real time — either a user
* blocks the current user (incoming) or the current user blocks someone on
* another device (outgoing). The local block-relationship store is updated
* before the callback runs.
*
* @param callback The function to call when the event was fired
* @returns an {@link Amity.Unsubscriber} function to stop listening
*
* @category Block Events
*/
export declare const onUserDidBlock: (callback: Amity.Listener<Amity.FollowStatus>) => Amity.Unsubscriber;
//# sourceMappingURL=onUserDidBlock.d.ts.map