@amityco/ts-sdk-react-native/dist/streamRepository/api/updateStream.d.ts

Amity Social Cloud Typescript SDK

/**
 * @deprecated this function is deprecated,
 * please use {@link Amity.StreamRepository.editStream} instead.
 *
 * ```js
 * import { updateStream } from '@amityco/ts-sdk-react-native'
 * const updated = await updateStream(streamId, { title: 'foobar' })
 * ```
 *
 * Updates an {@link Amity.Stream}
 *
 * @param streamId The ID of the {@link Amity.Stream} to edit
 * @param patch The patch data to apply
 * @returns the updated {@link Amity.Stream} object
 *
 * @category Stream API
 * @async
 */
export declare const updateStream: (streamId: Amity.Stream['streamId'], patch: Patch<Amity.Stream, 'title' | 'thumbnailFileId' | 'description' | 'metadata' | 'channelEnabled'>) => Promise<Amity.Cached<Amity.Stream>>;
//# sourceMappingURL=updateStream.d.ts.map