Teams¶
-
class
synapseclient.team.
Team
(**kwargs)¶ Represents a Synapse Team. User definable fields are:
Parameters: - icon – fileHandleId for icon image of the Team
- description – A short description of this Team.
- name – The name of the Team.
- canPublicJoin – true for teams which members can join without an invitation or approval
-
class
synapseclient.team.
TeamMember
(**kwargs)¶ - Contains information about a user’s membership in a Team. In practice the constructor is not called directly by
- the client.
Parameters: - teamId – the ID of the team
- member – An object of type
org.sagebionetworks.repo.model.UserGroupHeader
describing the member - isAdmin – Whether the given member is an administrator of the team
-
class
synapseclient.team.
UserGroupHeader
(**kwargs)¶ Select metadata about a Synapse principal. In practice the constructor is not called directly by the client.
Parameters: - ownerId – A foreign key to the ID of the ‘principal’ object for the user.
- firstName – First Name
- lastName – Last Name
- userName – A name chosen by the user that uniquely identifies them.
- email – User’s current email address
- isIndividual – True if this is a user, false if it is a group
-
class
synapseclient.team.
UserProfile
(**kwargs)¶ Information about a Synapse user. In practice the constructor is not called directly by the client.
Parameters: - ownerId – A foreign key to the ID of the ‘principal’ object for the user.
- uri – The Uniform Resource Identifier (URI) for this entity.
- etag – Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time an entity is updated it is used to detect when a client’s current representation of an entity is out-of-date.
- firstName – This person’s given name (forename)
- lastName – This person’s family name (surname)
- emails – The list of user email addresses registered to this user.
- userName – A name chosen by the user that uniquely identifies them.
- summary – A summary description about this person
- position – This person’s current position title
- location – This person’s location
- industry – “The industry/discipline that this person is associated with
- company – This person’s current affiliation
- profilePicureFileHandleId – The File Handle ID of the user’s profile picture.
- url – A link to more information about this person
- notificationSettings – An object of type
org.sagebionetworks.repo.model.message.Settings
containing the user’s preferences regarding when email notifications should be sent