@amityco/ts-sdk/dist/client/events/onVisitorUsageLimitReached.d.ts

Amity Social Cloud Typescript SDK

/**
 * Fired when a visitor or bot user has exceeded their daily API request quota (100 req/day).
 * The backend returns error code `400323` (`VISITOR_USAGE_LIMIT_EXCEEDED`) on any subsequent
 * read request after the limit is hit.
 *
 * Subscribe to this event to show a full-page error state or prompt the user to sign in.
 *
 * ```js
 * import { onVisitorUsageLimitReached } from '@amityco/ts-sdk'
 * const dispose = onVisitorUsageLimitReached(() => {
 *   // show usage limit UI
 * })
 * ```
 *
 * @param callback The function to call when the event is fired
 * @returns an {@link Amity.Unsubscriber} function to stop listening
 *
 * @category Client Events
 */
export declare const onVisitorUsageLimitReached: (callback: Amity.Listener<undefined>) => Amity.Unsubscriber;
//# sourceMappingURL=onVisitorUsageLimitReached.d.ts.map