@amityco/ts-sdk/dist/client/api/autoSubscription.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { Client, AmityAutoSubscription } from '@amityco/ts-sdk'
 * Client.enableAutoSubscriptions([AmityAutoSubscription.BLOCK])
 * ```
 *
 * Enables one or more managed auto-subscription handles. Managed handles are
 * re-applied on every (re)connect and ref-counted. All handles are on by
 * default; use this to re-enable handles previously turned off via
 * {@link disableAutoSubscriptions}. Synchronous fire-and-forget — the registry
 * updates immediately and the broker subscribe is retried on reconnect.
 *
 * @param features the {@link AmityAutoSubscription} handles to enable
 *
 * @category Client API
 */
export declare const enableAutoSubscriptions: (features: Amity.AutoSubscription[]) => void;
/**
 * ```js
 * import { Client, AmityAutoSubscription } from '@amityco/ts-sdk'
 * Client.disableAutoSubscriptions([AmityAutoSubscription.LIVESTREAM])
 * ```
 *
 * Disables one or more managed auto-subscription handles. The change persists
 * across reconnect (it is not silently re-enabled) until
 * {@link enableAutoSubscriptions} is called again. Synchronous fire-and-forget.
 *
 * @param features the {@link AmityAutoSubscription} handles to disable
 *
 * @category Client API
 */
export declare const disableAutoSubscriptions: (features: Amity.AutoSubscription[]) => void;
/**
 * ```js
 * import { Client } from '@amityco/ts-sdk'
 * Client.autoSubscriptions().forEach(s => console.log(s.feature, s.isActive, s.topicCount))
 * ```
 *
 * Inspects the managed auto-subscription registry — each handle's `isActive`,
 * `isSystem`, and `topicCount`.
 *
 * @returns a snapshot of the managed subscription registry
 *
 * @category Client API
 */
export declare const autoSubscriptions: () => Amity.AutoSubscriptionState[];
//# sourceMappingURL=autoSubscription.d.ts.map