react-native-rate-app/lib/typescript/index.d.ts

React Native module for In App Rating on Android and iOS

import { AndroidMarket, type OpenStoreForReviewProps, type RequestReviewProps } from "./types";
declare const RNRateApp: {
    /**
     * Requests a review from the user.
     *
     * @param {RequestReviewProps} props - The properties for the review request.
     * @param {AndroidMarket} [props.androidMarket=AndroidMarket.GOOGLE] - The market where the app's review request should be directed on Android.
     * @param {string} [props.androidPackageName] - The package name of the app to request a review for on Samsung Galaxy Store.
     * @returns {Promise<boolean>} A promise that resolves to a boolean indicating whether the review was successfully requested.
     */
    requestReview({ androidMarket, androidPackageName, }?: RequestReviewProps): Promise<boolean>;
    /**
     * Opens the store listing for the app.
     * @param props The properties for the store listing.
     * @returns A promise that resolves to a boolean indicating whether the store listing was successfully opened.
     */
    openStoreForReview({ iOSAppId, androidPackageName, androidMarket, }: OpenStoreForReviewProps): Promise<boolean>;
    /**
     * Gets the URL for the Android market.
     * @param androidMarket The market where the app's store listing should be opened on Android.
     * @param androidPackageName The package name of the app to open the store listing for on Android.
     * @returns The URL for the Android market.
     */
    getAndroidMarketUrl(androidMarket: AndroidMarket, androidPackageName: string): string;
};
export * from "./types";
export * from "./constants";
export declare const requestReview: ({ androidMarket, androidPackageName, }?: RequestReviewProps) => Promise<boolean>, openStoreForReview: ({ iOSAppId, androidPackageName, androidMarket, }: OpenStoreForReviewProps) => Promise<boolean>, getAndroidMarketUrl: (androidMarket: AndroidMarket, androidPackageName: string) => string;
export default RNRateApp;
//# sourceMappingURL=index.d.ts.map