flatpak/xdg-desktop-portal

Incorrect documentation for .Background.SetStatus

Jacalz opened this issue · 0 comments

Operating System

Fedora Silverblue 39

XDG Desktop Portal version

1.18

XDG Desktop Portal version (Other)

No response

Desktop Environment

GNOME

Desktop Environment (Other)

No response

Expected Behavior

The documentation at https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Background.html says that SetStatus only takes an options vardict but running that gives an error. I wonder if the documentation fails to refer to a parent window needed to be passed in?

Current Behavior

Executing SetStatus with only the options vardict as the documentation says results in Type of message, “(a{sv})”, does not match expected type “(sa{sv})” as the error. Passing in a string as the first input value, like the parent window used in RequestBackground, makes the call work.

Steps to Reproduce

  1. Call .Background.SetStatus with only an options vardict.
  2. Notice that it fails.
  3. Add a string as the first parameter.
  4. Notice that it now works.

Anything else we should know?

I noticed this when implementing rymdport/portal#9.

Another FYI:

  • "true if the application is will be autostarted." for the response values in RequestBackground has one "is" too many.