obex-agent-api.txt 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. OBEX D-Bus Agent API description
  2. ********************************
  3. Agent Manager hierarchy
  4. =======================
  5. Service org.bluez.obex
  6. Interface org.bluez.obex.AgentManager1
  7. Object path /org/bluez/obex
  8. Methods void RegisterAgent(object agent)
  9. Register an agent to request authorization of
  10. the user to accept/reject objects. Object push
  11. service needs to authorize each received object.
  12. Possible errors: org.bluez.obex.Error.AlreadyExists
  13. void UnregisterAgent(object agent)
  14. This unregisters the agent that has been previously
  15. registered. The object path parameter must match the
  16. same value that has been used on registration.
  17. Possible errors: org.bluez.obex.Error.DoesNotExist
  18. Agent hierarchy
  19. ===============
  20. Service unique name
  21. Interface org.bluez.obex.Agent1
  22. Object path freely definable
  23. Methods void Release()
  24. This method gets called when the service daemon
  25. unregisters the agent. An agent can use it to do
  26. cleanup tasks. There is no need to unregister the
  27. agent, because when this method gets called it has
  28. already been unregistered.
  29. string AuthorizePush(object transfer)
  30. This method gets called when the service daemon
  31. needs to accept/reject a Bluetooth object push request.
  32. Returns the full path (including the filename) where
  33. the object shall be stored. The tranfer object will
  34. contain a Filename property that contains the default
  35. location and name that can be returned.
  36. Possible errors: org.bluez.obex.Error.Rejected
  37. org.bluez.obex.Error.Canceled
  38. void Cancel()
  39. This method gets called to indicate that the agent
  40. request failed before a reply was returned. It cancels
  41. the previous request.