From 71997eaac716894cbf0d368c42d55d4d9aacaa98 Mon Sep 17 00:00:00 2001 From: Jeremy MacArthur Date: Thu, 8 Oct 2020 07:42:55 -0400 Subject: [PATCH] Adding godocs for the 4 functions listed: (#15806) * Adding godocs for the 4 functions listed: SqlTeamStore.UpdateLastTeamIconUpdate SqlTeamStore.UpdateMembersRole SqlTeamStore.UserBelongsToTeams SqlTeamStore.GetTeamMembersForExport * Apply suggestions from code review Applying suggestions from the community to help clean up the grammar in the docs. Co-authored-by: Justine Geffen * Apply suggestions from code review part 2 Co-authored-by: Justine Geffen Co-authored-by: Justine Geffen Co-authored-by: Mattermod --- store/sqlstore/team_store.go | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/store/sqlstore/team_store.go b/store/sqlstore/team_store.go index e031a35e9a..f4722ab853 100644 --- a/store/sqlstore/team_store.go +++ b/store/sqlstore/team_store.go @@ -1268,6 +1268,9 @@ func (s SqlTeamStore) RemoveAllMembersByUser(userId string) error { return nil } +// UpdateLastTeamIconUpdate sets the last updated time for the icon based on the parameter passed in teamId. The +// LastTeamIconUpdate and UpdateAt fields are set to the parameter passed in curTime. Returns nil on success and an error +// otherwise. func (s SqlTeamStore) UpdateLastTeamIconUpdate(teamId string, curTime int64) error { query, args, err := s.getQueryBuilder(). Update("Teams"). @@ -1494,6 +1497,7 @@ func (s SqlTeamStore) GetUserTeamIds(userId string, allowFromCache bool) ([]stri return teamIds, nil } +// GetTeamMembersForExport gets the various teams for which a user, denoted by userId, is a part of. func (s SqlTeamStore) GetTeamMembersForExport(userId string) ([]*model.TeamMemberForExport, error) { var members []*model.TeamMemberForExport query, args, err := s.getQueryBuilder(). @@ -1514,6 +1518,7 @@ func (s SqlTeamStore) GetTeamMembersForExport(userId string) ([]*model.TeamMembe return members, nil } +//UserBelongsToTeams returns true if the user denoted by userId is a member of the teams in the teamIds string array. func (s SqlTeamStore) UserBelongsToTeams(userId string, teamIds []string) (bool, error) { idQuery := sq.Eq{ "UserId": userId, @@ -1534,6 +1539,8 @@ func (s SqlTeamStore) UserBelongsToTeams(userId string, teamIds []string) (bool, return c > 0, nil } +// UpdateMembersRole updates all the members of teamID in the userIds string array to be admins and sets all other +// users as not being admin. func (s SqlTeamStore) UpdateMembersRole(teamID string, userIDs []string) error { query, args, err := s.getQueryBuilder(). Update("TeamMembers").