org.bluez.obex.Message1 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bluez-dbus-osgi Show documentation

Java native bluetooth library which uses bluez via dbus (linux only). This is the OSGi compliant bundle of all required libraries in one bundle.

The newest version!

package org.bluez.obex;

import org.bluez.datatypes.TwoTuple;
import org.bluez.exceptions.BluezFailedException;
import org.bluez.exceptions.BluezInvalidArgumentsException;
import org.freedesktop.dbus.DBusPath;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.Variant;

import java.util.Map;

/**
 * File generated - 2023-02-20.

 * Based on bluez Documentation: obex-api.txt.

 * 

 * Service: org.bluez.obex

 * Interface: org.bluez.obex.Message1

 * 

 * Object path:

 *             [Session object path]/{message0,...}

 * 

 * Supported properties: 

 * 

 * 		string Folder [readonly]

 * 

 * 			Folder which the message belongs to

 * 

 * 		string Subject [readonly]

 * 

 * 			Message subject

 * 

 * 		string Timestamp [readonly]

 * 

 * 			Message timestamp

 * 

 * 		string Sender [readonly]

 * 

 * 			Message sender name

 * 

 * 		string SenderAddress [readonly]

 * 

 * 			Message sender address

 * 

 * 		string ReplyTo [readonly]

 * 

 * 			Message Reply-To address

 * 

 * 		string Recipient [readonly]

 * 

 * 			Message recipient name

 * 

 * 		string RecipientAddress [readonly]

 * 

 * 			Message recipient address

 * 

 * 		string Type [readonly]

 * 

 * 			Message type

 * 

 * 			Possible values: "email", "sms-gsm",

 * 			"sms-cdma" and "mms"

 * 

 * 		uint64 Size [readonly]

 * 

 * 			Message size in bytes

 * 

 * 		string Status [readonly]

 * 

 * 			Message reception status

 * 

 * 			Possible values: "complete",

 * 			"fractioned" and "notification"

 * 

 * 		boolean Priority [readonly]

 * 

 * 			Message priority flag

 * 

 * 		boolean Read [read/write]

 * 

 * 			Message read flag

 * 

 * 		boolean Deleted [writeonly]

 * 

 * 			Message deleted flag

 * 

 * 		boolean Sent [readonly]

 * 

 * 			Message sent flag

 * 

 * 		boolean Protected [readonly]

 * 

 * 			Message protected flag

 * 

 */
public interface Message1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * Download message and store it in the target file.

     * 

     * If an empty target file is given, a temporary file

     * will be automatically generated.

     * 

     * The returned path represents the newly created transfer,

     * which should be used to find out if the content has been

     * successfully transferred or if the operation fails.

     * 

     * The properties of this transfer are also returned along

     * with the object path, to avoid a call to GetProperties.

     * 

     * 
     * @param _targetfile targetfile
     * @param _attachment attachment
     * 
     * @return TwoTuple<DBusPath, Map<String,Variant<?>>> - maybe null
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezFailedException on failure
     */
    TwoTuple>> Get(String _targetfile, boolean _attachment) throws BluezInvalidArgumentsException, BluezFailedException;

}