@amityco/ts-sdk-react-native/dist/role/api/getRole.d.ts

Amity Social Cloud Typescript SDK

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