kaios-types
    Preparing search index...

    Interface MozMobileMessageManager

    dom.sms.enabled

    sms

    CertifiedApps

    interface MozMobileMessageManager {
        ondeleted: EventHandler;
        ondeliveryerror: EventHandler;
        ondeliverysuccess: EventHandler;
        onfailed: EventHandler;
        onreaderror: EventHandler;
        onreadsuccess: EventHandler;
        onreceived: EventHandler;
        onretrieving: EventHandler;
        onsending: EventHandler;
        onsent: EventHandler;
        addEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | AddEventListenerOptions,
        ): void;
        delete(id: number): DOMRequest;
        delete(message: SmsMessage): DOMRequest;
        delete(message: MmsMessage): DOMRequest;
        delete(params: (number | MmsMessage | SmsMessage)[]): DOMRequest;
        dispatchEvent(event: Event): boolean;
        getMessage(id: number): DOMRequest;
        getMessages(filter?: MobileMessageFilter, reverse?: boolean): DOMCursor;
        getSegmentInfoForText(text: string): DOMRequest;
        getSmscAddress(serviceId?: number): Promise<SmscAddress>;
        getThreads(): DOMCursor;
        markMessageRead(
            id: number,
            read: boolean,
            sendReadReport?: boolean,
        ): DOMRequest;
        removeEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | EventListenerOptions,
        ): void;
        retrieveMMS(id: number): DOMRequest;
        retrieveMMS(message: MmsMessage): DOMRequest;
        send(
            number: string,
            text: string,
            sendParameters?: SmsSendParameters,
        ): DOMRequest;
        send(
            numbers: string[],
            text: string,
            sendParameters?: SmsSendParameters,
        ): DOMRequest[];
        sendMMS(
            parameters?: MmsParameters,
            sendParameters?: MmsSendParameters,
        ): DOMRequest;
        setSmscAddress(
            smscAddress?: SmscAddress,
            serviceId?: number,
        ): Promise<void>;
    }

    Hierarchy

    • EventTarget
      • MozMobileMessageManager
    Index

    Properties

    ondeleted: EventHandler

    Event handler for when a message is deleted.

    ondeliveryerror: EventHandler

    Event handler for when a message delivery fails.

    ondeliverysuccess: EventHandler

    Event handler for when a message is successfully delivered.

    onfailed: EventHandler

    Event handler for when a message send fails.

    onreaderror: EventHandler

    Event handler for when a read report fails.

    onreadsuccess: EventHandler

    Event handler for when a read report is successfully sent/received.

    onreceived: EventHandler

    Event handler for when a message is received.

    onretrieving: EventHandler

    Event handler for when a message is being retrieved.

    onsending: EventHandler

    Event handler for when a message is being sent.

    onsent: EventHandler

    Event handler for when a message is successfully sent.

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Marks a message as read or unread.

      Parameters

      • id: number

        The ID of the message.

      • read: boolean

        True to mark as read, false to mark as unread.

      • OptionalsendReadReport: boolean

        Whether to send a read report.

      Returns DOMRequest

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | EventListenerOptions

      Returns void