org.bluez.obex.MessageAccess1 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
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.
package org.bluez.obex;
import org.freedesktop.dbus.interfaces.DBusInterface;
import java.util.Map;
import org.bluez.datatypes.TwoTuple;
import org.bluez.exceptions.BluezFailedException;
import org.bluez.exceptions.BluezInvalidArgumentsException;
import org.freedesktop.dbus.DBusPath;
import org.freedesktop.dbus.types.Variant;
/**
* File generated - 2020-06-18.
* Based on bluez Documentation: obex-api.txt.
*
* Service: org.bluez.obex
* Interface: org.bluez.obex.MessageAccess1
*
* Object path:
* [Session object path]
*
*/
public interface MessageAccess1 extends DBusInterface {
/**
* From bluez documentation:
*
* Set working directory for current session, *name* may
* be the directory name or '..[/dir]'.
*
*
* @param _name name
*
* @throws BluezInvalidArgumentsException when argument is invalid
* @throws BluezFailedException on failure
*/
void SetFolder(String _name) throws BluezInvalidArgumentsException, BluezFailedException;
/**
* From bluez documentation:
*
* Returns a dictionary containing information about
* the current folder content.
*
* The following keys are defined:
*
* string Name : Folder name
*
* Possible filters: Offset and MaxCount
*
*
* @param _filter filter
*
* @return Map<String, Variant<?>>[] - maybe null
*
* @throws BluezInvalidArgumentsException when argument is invalid
* @throws BluezFailedException on failure
*/
Map>[] ListFolders(Map> _filter) throws BluezInvalidArgumentsException, BluezFailedException;
/**
* From bluez documentation:
*
* Return all available fields that can be used in Fields
* filter.
*
*
* @return String[] - maybe null
*/
String[] ListFilterFields();
/**
* From bluez documentation:
*
* Returns an array containing the messages found in the
* given subfolder of the current folder, or in the
* current folder if folder is empty.
*
* Possible Filters: Offset, MaxCount, SubjectLength, Fields,
* Type, PeriodStart, PeriodEnd, Status, Recipient, Sender,
* Priority
*
* Each message is represented by an object path followed
* by a dictionary of the properties.
*
* Properties:
*
* string Subject:
*
* Message subject
*
* string Timestamp:
*
* Message timestamp
*
* string Sender:
*
* Message sender name
*
* string SenderAddress:
*
* Message sender address
*
* string ReplyTo:
*
* Message Reply-To address
*
* string Recipient:
*
* Message recipient name
*
* string RecipientAddress:
*
* Message recipient address
*
* string Type:
*
* Message type
*
* Possible values: "email", "sms-gsm",
* "sms-cdma" and "mms"
*
* uint64 Size:
*
* Message size in bytes
*
* boolean Text:
*
* Message text flag
*
* Specifies whether message has textual
* content or is binary only
*
* string Status:
*
* Message status
*
* Possible values for received messages:
* "complete", "fractioned", "notification"
*
* Possible values for sent messages:
* "delivery-success", "sending-success",
* "delivery-failure", "sending-failure"
*
* uint64 AttachmentSize:
*
* Message overall attachment size in bytes
*
* boolean Priority:
*
* Message priority flag
*
* boolean Read:
*
* Message read flag
*
* boolean Sent:
*
* Message sent flag
*
* boolean Protected:
*
* Message protected flag
*
*
* @param _folder folder
* @param _filter filter
*
* @return TwoTuple<DBusPath, Map<String,Variant<?>>>[] - maybe null
*
* @throws BluezInvalidArgumentsException when argument is invalid
* @throws BluezFailedException on failure
*/
TwoTuple>>[] ListMessages(String _folder, Map> _filter) throws BluezInvalidArgumentsException, BluezFailedException;
/**
* From bluez documentation:
*
* Request remote to update its inbox.
*
*
* @throws BluezFailedException on failure
*/
void UpdateInbox() throws BluezFailedException;
/**
* From bluez documentation:
*
* Transfer a message (in bMessage format) to the
* remote device.
*
* The message is transferred either to the given
* subfolder of the current folder, or to the current
* folder if folder is empty.
*
* Possible args: Transparent, Retry, Charset
*
* 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 GetAll.
*
*
* @param _sourcefile sourcefile
* @param _folder folder
* @param _args args
*
* @return TwoTuple<DBusPath, Map<String,Variant<?>>> - maybe null
*
* @throws BluezInvalidArgumentsException when argument is invalid
* @throws BluezFailedException on failure
*/
TwoTuple>> PushMessage(String _sourcefile, String _folder, Map> _args) throws BluezInvalidArgumentsException, BluezFailedException;
}