@ua/react-native-airship/lib/typescript/src/AirshipMessageCenter.d.ts

Airship plugin for React Native apps.

import { InboxMessage } from './types';
/**
 * Airship Message Center
 */
export declare class AirshipMessageCenter {
    private readonly module;
    constructor(module: any);
    /**
     * Gets the unread count.
     * @returns A promise with the result.
     */
    getUnreadCount(): Promise<number>;
    /**
     * Gets the inbox messages.
     * @returns A promise with the result.
     */
    getMessages(): Promise<InboxMessage[]>;
    /**
     * Marks a message as read.
     * @param messageId The message Id.
     * @returns A promise. Will reject if the message is not
     * found or if takeOff is not called.
     */
    markMessageRead(messageId: string): Promise<void>;
    /**
     * Deletes a message.
     * @param messageId The message Id.
     * @returns A promise. Will reject if the message is not
     * found or if takeOff is not called.
     */
    deleteMessage(messageId: string): Promise<void>;
    /**
     * Dismisses the OOTB message center if displayed.
     * @returns A promise.
     */
    dismiss(): Promise<void>;
    /**
     * Requests to display the Message Center.
     *
     * Will either emit an event to display the
     * Message Center if auto launch message center
     * is disabled, or display the OOTB message center.
     * @param messageId Optional message Id.
     * @returns A promise.
     */
    display(messageId?: string): Promise<void>;
    /**
     * Overlays the Message Center regardless if auto launch Message Center is enabled or not.
     *
     * @param messageId Optional message Id.
     * @returns A promise.
     */
    showMessageCenter(messageId?: string): Promise<void>;
    /**
     * Overlays the message view regardless if auto launch Message Center is enabled or not.
     *
     * @param messageId The message Id.
     * @returns A promise.
     */
    showMessageView(messageId: string): Promise<void>;
    /**
     * Refreshes the messages.
     * @returns A promise. Will reject if the list fails to refresh or if
     * takeOff is not called yet.
     */
    refreshMessages(): Promise<void>;
    /**
     * Enables or disables showing the OOTB UI when requested to display by either
     * `display` or by a notification with a Message Center action.
     * @param autoLaunch true to show OOTB UI, false to emit events.
     */
    setAutoLaunchDefaultMessageCenter(autoLaunch: boolean): void;
}
//# sourceMappingURL=AirshipMessageCenter.d.ts.map