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

unneeded session_id? #1310

Open
dcz-self opened this issue Mar 21, 2024 · 4 comments
Open

unneeded session_id? #1310

dcz-self opened this issue Mar 21, 2024 · 4 comments
Labels

Comments

@dcz-self
Copy link

Operating System

n/a

XDG Desktop Portal version

Git

XDG Desktop Portal version (Other)

No response

Desktop Environment

Deepin

Desktop Environment (Other)

No response

Expected Behavior

Docs describe things that are in use/applicable.

Current Behavior

Docs for the impl of CreateSession for some portals describe a "session_id" which serves no clear purpose.

It doesn't seem to be the same as the session handle, and the impl doesn't need to return that anyway. xdg-desktop-portal sources don't make use of that return value.

Is that field a nonexistent phantom coming from some copy-paste error?

Steps to Reproduce

  1. Go to https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.impl.portal.InputCapture.html#org-freedesktop-impl-portal-inputcapture-createsession or https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.impl.portal.GlobalShortcuts.html#org-freedesktop-impl-portal-globalshortcuts-createsession
  2. Scroll down to the results vardict
  3. Notice session_id

Anything else we should know?

No response

@dcz-self dcz-self added the bug label Mar 21, 2024
@whot
Copy link
Contributor

whot commented Mar 21, 2024

Yeah, looks like a copy/paste from the ScreenCast portal - this should be session_handle instead which is returned in the results. Mind filing a PR for this? (and ScreenCast and GlobalShortcuts)

@dcz-self
Copy link
Author

Should this actually be session_handle rather than nothing? IN session_handle o, is already passed by the caller, so is there a point returning it again?

@whot
Copy link
Contributor

whot commented Mar 25, 2024

Can you check if any of the impls actually return this (see ScreenCast and others too)? This looks much like a copy-paste from the .portal where the client passes the token and the portal returns the handle. Since it's the impl this isn't needed here (iirc, I've paged parts of all this out) so it could be dropped.

@dcz-self
Copy link
Author

dcz-self commented Mar 27, 2024 via email

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

2 participants