Skip to content

Update Embedded App SDK docs with relationship features #7547

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

miaber
Copy link

@miaber miaber commented May 8, 2025

Documenting getRelationships command and RELATIONSHIP_UPDATED event from the latest Embedded App SDK release


| Property | Type |
|----------|-----------------------------------------------------|
| type | number |
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also document the types, but the enum is not specified in the SDK

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed! Are they the same as these in the Social SDK? Would love to have them documented here too

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep! I added a section for types at the bottom, pretty much copied from here

@miaber miaber marked this pull request as ready for review May 8, 2025 19:47
@miaber miaber requested a review from a team as a code owner May 8, 2025 19:47
@miaber miaber requested review from markmandel and removed request for a team May 8, 2025 19:47
@colinloretz colinloretz added the embedded-app-sdk Feedback and bug reports on Embedded App SDK label May 8, 2025
@anthonydiscord anthonydiscord requested review from anthonydiscord and removed request for markmandel May 8, 2025 21:16

| Property | Type |
|----------|-----------------------------------------------------|
| type | number |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed! Are they the same as these in the Social SDK? Would love to have them documented here too

Copy link
Contributor

@anthonydiscord anthonydiscord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since relationships.read requires approval to use I'd like to add a note where we document it

@miaber miaber force-pushed the mia/getRelationshipsDoc branch from 39052e8 to 17e5cf0 Compare May 12, 2025 21:37
@miaber miaber requested a review from anthonydiscord May 12, 2025 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
embedded-app-sdk Feedback and bug reports on Embedded App SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants