@amityco/ts-sdk-react-native/dist/invitationRepository/observers/getInvitations.d.ts

Amity Social Cloud Typescript SDK

/**
 *
 * ```js
 * import { InvitationRepository } from '@amityco/ts-sdk-react-native';
 *
 * // For room invitations
 * const unsubscribe = InvitationRepository.getInvitations(
 *   { targetId: 'room123', targetType: 'room' },
 *   response => {
 *     console.log('Room invitation event:', response.room, response.users, response.eventType)
 *   }
 * );
 *
 * // For community invitations (when implemented)
 * const unsubscribe2 = observeInvitations(
 *   { targetId: 'community456', targetType: 'community' },
 *   response => {
 *     console.log('Community invitation event:', response.community, response.users, response.eventType)
 *   }
 * );
 * ```
 *
 * Observe invitations events including invited, accepted, rejected, and canceled
 *
 * @param params The target ID and type to observe invitations for
 * @param callback The function to call when new invitation events are available
 * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the events
 *
 * @category Invitation Observable
 */
export declare const getInvitations: <T extends "community" | "room">(params: Pick<Amity.QueryInvitations, "targetId" | "targetType"> & {
    targetType: T;
}, callback: Amity.Listener<Amity.Invitation[]>) => Amity.Unsubscriber;
//# sourceMappingURL=getInvitations.d.ts.map