Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect documentation for .Background.SetStatus #1307

Open
Jacalz opened this issue Mar 17, 2024 · 0 comments
Open

Incorrect documentation for .Background.SetStatus #1307

Jacalz opened this issue Mar 17, 2024 · 0 comments
Labels

Comments

@Jacalz
Copy link

Jacalz commented Mar 17, 2024

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.
@Jacalz Jacalz added the bug label Mar 17, 2024
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Needs Triage
Development

No branches or pull requests

1 participant