Fix Embedded App SDK doc for setOrientationLockState()
#6759
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Lulalaby
reviewed
Mar 27, 2024
There was a problem hiding this comment.
A table should maybe be included for the mapping from int to flag
#### Lock States
| Type | State |
| ==== | ========== |
| 1 | Unlocked |
| 2 | Portrait |
| 3 | Landscape |
#### Grid Lock States
| Type | State |
| ==== | ======== |
| 1 | Unlocked |
| 2 | Locked |
|
@Snazzah thanks for this! I'll take a peek. These are currently manually written but will be auto-generated soon™️, so we'll have things like types/etc included in tables. |
matthova
reviewed
May 13, 2024
| @@ -493,15 +493,15 @@ Locks the application to specific orientations in each of the supported layout m | |||
|
|
|||
| #### Required Scopes | |||
|
|
|||
| - guilds.members.read | |||
| No scopes required | |||
There was a problem hiding this comment.
Great callout. Yes, no scopes are required for this command.
matthova
reviewed
May 13, 2024
Comment on lines
+502
to
+504
| lock_state: 3, // landscape | ||
| picture_in_picture_lock_state: 3, // landscape | ||
| grid_lock_state: 1 // unlocked |
There was a problem hiding this comment.
This is a rough edge case where we offer an enum, but getting to it is a bit verbose
Suggested change
| lock_state: 3, // landscape | |
| picture_in_picture_lock_state: 3, // landscape | |
| grid_lock_state: 1 // unlocked | |
| lock_state: Common.OrientationLockStateTypeObject.LANDSCAPE, | |
| picture_in_picture_lock_state: Common.OrientationLockStateTypeObject.LANDSCAPE, | |
| grid_lock_state: Common.OrientationLockStateTypeObject.UNLOCKED |
Ideally we could also show above this snippet
import {Common} from '@discord/embedded-app-sdk';
JustinBeckwith
added
embedded-app-sdk
|
Thanks for surfacing the issue! Addressed in #6863 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Seems like this command doesn't actually need the
guilds.members.readscope, and the values in the usage doesn't use strings.