@river-build/react-sdk/dist/types/useGdm.d.ts

React Hooks for River SDK

import type { GdmModel } from '@river-build/sdk';
import { type ObservableConfig } from './useObservable';
/**
 * Hook to get the data of a Group DM.
 * You can use this hook to get Group DM metadata and if the user has joined the Group DM.
 * @param streamId - The id of the Group DM to get the data of.
 * @param config - Configuration options for the observable.
 * @returns The GdmModel of the Group DM.
 */
export declare const useGdm: (streamId: string, config?: ObservableConfig.FromData<GdmModel>) => {
    data: GdmModel;
    error: Error | undefined;
    status: "error" | "loading" | "loaded";
    isLoading: boolean;
    isError: boolean;
    isLoaded: boolean;
} | {
    data: GdmModel;
    error: Error | undefined;
    status: "error" | "loading" | "loaded";
    isLoading: boolean;
    isError: boolean;
    isLoaded: boolean;
} | {
    data: GdmModel;
    error: Error | undefined;
    status: "error" | "loading" | "loaded";
    isLoading: boolean;
    isError: boolean;
    isLoaded: boolean;
};
//# sourceMappingURL=useGdm.d.ts.map