react-native-notificare/lib/typescript/notificare.d.ts

Notificare React Native module.

import { type EmitterSubscription } from 'react-native';
import { NotificareDeviceModule } from './notificare-device-module';
import { NotificareEventsModule } from './notificare-events-module';
import type { NotificareApplication } from './models/notificare-application';
import type { NotificareNotification } from './models/notificare-notification';
import type { NotificareDynamicLink } from './models/notificare-dynamic-link';
import type { NotificareDevice } from './models/notificare-device';
export declare class Notificare {
    private static readonly eventEmitter;
    private static readonly deviceModule;
    private static readonly eventsModule;
    static device(): NotificareDeviceModule;
    static events(): NotificareEventsModule;
    /**
     * Indicates whether Notificare has been configured.
     *
     * @returns {Promise<boolean>} - A promise that resolves to `true` if Notificare
     * is successfully configured, and `false` otherwise.
     */
    static isConfigured(): Promise<boolean>;
    /**
     * Indicates whether Notificare is ready.
     *
     * @returns {Promise<boolean>} - A promise that resolves to `true` if the SDK
     * has completed the initialization process and is ready for use.
     */
    static isReady(): Promise<boolean>;
    /**
     * Launches the Notificare SDK, and all the additional available modules,
     * preparing them for use.
     *
     * @returns {Promise<void>} - A promise that resolves when the Notificare SDK
     * and its modules have been successfully launched and are ready for use.
     */
    static launch(): Promise<void>;
    /**
     * Unlaunches the Notificare SDK.
     *
     * This method shuts down the SDK, removing all data, both locally and remotely
     * in the servers. It destroys all the device's data permanently.
     *
     * @returns {Promise<void>} - A promise that resolves when the SDK has been
     * successfully unlaunched and all data has been removed.
     */
    static unlaunch(): Promise<void>;
    /**
     * Provides the current application metadata, if available.
     *
     * @returns {Promise<NotificareApplication | null>} - A promise that resolves
     * to a {@link NotificareApplication} object representing the configured
     * application, or `null` if the application is not yet available.
     */
    static getApplication(): Promise<NotificareApplication | null>;
    /**
     * Fetches the application metadata.
     *
     * @return {Promise<NotificareApplication>} - A promise that resolves to a
     * {@link NotificareApplication} object containing the application metadata.
     */
    static fetchApplication(): Promise<NotificareApplication>;
    /**
     * Fetches a {@link NotificareNotification} by its ID.
     *
     * @param {string} id - The ID of the notification to fetch.
     * @return {Promise<NotificareNotification>} - A promise that resolves to a
     * {@link NotificareNotification} object associated with the provided ID.
     */
    static fetchNotification(id: string): Promise<NotificareNotification>;
    /**
     * Fetches a {@link NotificareDynamicLink} from a URL.
     *
     * @param {string} url - The URL to fetch the dynamic link from.
     * @return {Promise<NotificareDynamicLink >} - A promise that resolves to a
     * {@link NotificareDynamicLink} object.
     */
    static fetchDynamicLink(url: string): Promise<NotificareDynamicLink>;
    /**
     * Checks if a deferred link exists and can be evaluated.
     *
     * @return {Promise<Boolean>} - A promise that resolves to `true` if a deferred
     * link can be evaluated, `false` otherwise.
     */
    static canEvaluateDeferredLink(): Promise<boolean>;
    /**
     * Evaluates the deferred link. Once the deferred link is evaluated, Notificare
     * will open the resolved deep link.
     *
     * @return {Promise<boolean>} - A promise that resolves to `true` if the
     * deferred link was successfully evaluated, `false` otherwise.
     */
    static evaluateDeferredLink(): Promise<boolean>;
    /**
     * Called when the Notificare SDK is fully ready and the application metadata
     * is available.
     *
     * This method is invoked after the SDK has been successfully launched and is
     * available for use.
     *
     * @param callback - A callback that will be invoked with the result of the
     * onReady event. It will the {@link NotificareApplication} object containing
     * the application's metadata.
     * @returns {EmitterSubscription} - The {@link EmitterSubscription} for the
     * onReady event.
     */
    static onReady(callback: (application: NotificareApplication) => void): EmitterSubscription;
    /**
     * Called when the Notificare SDK has been unlaunched.
     *
     * This method is invoked after the SDK has been shut down (unlaunched) and
     * is no longer in use.
     *
     * @param callback - A callback that will be invoked with the result of the
     * onUnlaunched event.
     * @returns {EmitterSubscription} - The {@link EmitterSubscription} for the
     * onUnlaunched event.
     */
    static onUnlaunched(callback: () => void): EmitterSubscription;
    /**
     * Called when the device has been successfully registered with the Notificare
     * platform.
     *
     * This method is triggered after the device is initially created, which
     * happens the first time `launch()` is called.
     * Once created, the method will not trigger again unless the device is
     * deleted by calling `unlaunch()` and created again on a new `launch()`.
     *
     * @param callback - A callback that will be invoked with the result of the
     * onDeviceRegistered event. It will provide the registered {@link NotificareDevice}
     * instance representing the device's registration details.
     * @returns {EmitterSubscription} - The {@link EmitterSubscription} for the
     * onDeviceRegistered event.
     */
    static onDeviceRegistered(callback: (device: NotificareDevice) => void): EmitterSubscription;
    /**
     * Called when the device opens a URL.
     *
     * This method is invoked when the device opens a URL.
     *
     * @param callback - A callback that will be invoked with the result of the
     * onUrlOpened event. It will provide the opened URL.
     * @returns {EmitterSubscription} - The {@link EmitterSubscription} for the
     * onUrlOpened event.
     */
    static onUrlOpened(callback: (url: string) => void): EmitterSubscription;
}
//# sourceMappingURL=notificare.d.ts.map