File tree Expand file tree Collapse file tree 1 file changed +27
-0
lines changed
synapseclient/models/protocols Expand file tree Collapse file tree 1 file changed +27
-0
lines changed Original file line number Diff line number Diff line change @@ -178,6 +178,33 @@ def get_user_membership_status(
178178
179179 Returns:
180180 TeamMembershipStatus object
181+
182+ Example:
183+ Check if a user is a member of a team
184+ This example shows how to check a user's membership status in a team.
185+
186+
187+ ```python
188+ from synapseclient import Synapse
189+ from synapseclient.models import Team
190+
191+ syn = Synapse()
192+ syn.login()
193+
194+ # Get a team by ID
195+ team = Team.from_id(123456)
196+
197+ # Check membership status for a specific user
198+ user_id = "3350396" # Replace with actual user ID
199+ status = team.get_user_membership_status(user_id)
200+
201+ print(f"User ID: {status.user_id}")
202+ print(f"Is member: {status.is_member}")
203+ print(f"Can join: {status.can_join}")
204+ print(f"Has open invitation: {status.has_open_invitation}")
205+ print(f"Has open request: {status.has_open_request}")
206+ print(f"Membership approval required: {status.membership_approval_required}")
207+ ```
181208 """
182209 from synapseclient .models .team import TeamMembershipStatus
183210
You can’t perform that action at this time.
0 commit comments