Package org.bluez.obex

Interface MessageAccess1

All Superinterfaces:
org.freedesktop.dbus.interfaces.DBusInterface
public interface MessageAccess1 extends org.freedesktop.dbus.interfaces.DBusInterface
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.MessageAccess1

Object path:
[Session object path]

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    ListFilterFields()
    From bluez documentation:

    Return all available fields that can be used in Fields
    filter.

    Map<String,org.freedesktop.dbus.types.Variant<?>>[]
    ListFolders(Map<String,org.freedesktop.dbus.types.Variant<?>> _filter)
    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

    TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>>[]
    ListMessages(String _folder, Map<String,org.freedesktop.dbus.types.Variant<?>> _filter)
    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

    TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>>
    PushMessage(String _sourcefile, String _folder, Map<String,org.freedesktop.dbus.types.Variant<?>> _args)
    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.

    void
    SetFolder(String _name)
    From bluez documentation:

    Set working directory for current session, *name* may
    be the directory name or '..
    void
    UpdateInbox()
    From bluez documentation:

    Request remote to update its inbox.

    Methods inherited from interface org.freedesktop.dbus.interfaces.DBusInterface

    getObjectPath, isRemote

  • Method Details

    • SetFolder

      void SetFolder(String _name) throws BluezInvalidArgumentsException, BluezFailedException
      From bluez documentation:

      Set working directory for current session, *name* may
      be the directory name or '..[/dir]'.

      Parameters:
      _name - name
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezFailedException - on failure

    • ListFolders

      Map<String,org.freedesktop.dbus.types.Variant<?>>[] ListFolders(Map<String,org.freedesktop.dbus.types.Variant<?>> _filter) 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

      Parameters:
      _filter - filter
      Returns:
      Map<String, Variant<?>>[] - maybe null
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezFailedException - on failure

    • ListFilterFields

      String[] ListFilterFields()
      From bluez documentation:

      Return all available fields that can be used in Fields
      filter.

      Returns:
      String[] - maybe null

    • ListMessages

      TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>>[] ListMessages(String _folder, Map<String,org.freedesktop.dbus.types.Variant<?>> _filter) throws BluezInvalidArgumentsException, BluezFailedException
      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

      Parameters:
      _folder - folder
      _filter - filter
      Returns:
      TwoTuple<DBusPath, Map<String,Variant<?>>>[] - maybe null
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezFailedException - on failure

    • UpdateInbox

      void UpdateInbox() throws BluezFailedException
      From bluez documentation:

      Request remote to update its inbox.

      Throws:
      BluezFailedException - on failure

    • PushMessage

      TwoTuple<org.freedesktop.dbus.DBusPath,Map<String,org.freedesktop.dbus.types.Variant<?>>> PushMessage(String _sourcefile, String _folder, Map<String,org.freedesktop.dbus.types.Variant<?>> _args) throws BluezInvalidArgumentsException, 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.

      Parameters:
      _sourcefile - sourcefile
      _folder - folder
      _args - args
      Returns:
      TwoTuple<DBusPath, Map<String,Variant<?>>> - maybe null
      Throws:
      BluezInvalidArgumentsException - when argument is invalid
      BluezFailedException - on failure