@amityco/ts-sdk-react-native/dist/streamRepository/internalApi/getStream.d.ts

Amity Social Cloud Typescript SDK

/**
 * ```js
 * import { getStream } from '@amityco/ts-sdk-react-native'
 * const stream = await getStream('foobar')
 * ```
 *
 * Fetches a {@link Amity.Stream} object
 *
 * @param streamId the ID of the {@link Amity.Stream} to fetch
 * @returns the associated {@link Amity.Stream} object
 *
 * @category Stream API
 * @async
 */
export declare const getStream: {
    (streamId: Amity.Stream['streamId']): Promise<Amity.Cached<Amity.InternalStream>>;
    /**
     * ```js
     * import { getStream } from '@amityco/ts-sdk-react-native'
     * const stream = getStream.locally('foobar')
     * ```
     *
     * Fetches a {@link Amity.Stream} object
     *
     * @param streamId the ID of the {@link Amity.Stream} to fetch
     * @returns the associated {@link Amity.Stream} object
     *
     * @category Stream API
     */
    locally(streamId: Amity.Stream['streamId']): Amity.Cached<Amity.InternalStream> | undefined;
};
//# sourceMappingURL=getStream.d.ts.map