@amityco/ts-sdk-react-native/dist/communityRepository/api/joinCommunity.d.ts

Amity Social Cloud Typescript SDK

/**
 * @deprecated This function will to be deprecated and use the new community.join().
 */
/**
 * ```js
 * import { joinCommunity } from '@amityco/ts-sdk-react-native'
 * const isJoined = await joinCommunity('foobar')
 * ```
 *
 * Joins a {@link Amity.Community} object
 *
 * @param communityId the {@link Amity.Community} to join
 * @returns A success boolean if the {@link Amity.Community} was joined
 *
 * @category Community API
 * @async
 */
export declare const joinCommunity: (communityId: Amity.Community['communityId']) => Promise<boolean>;
//# sourceMappingURL=joinCommunity.d.ts.map