github.com/mattermosttest/mattermost-server/v5@v5.0.0-20200917143240-9dfa12e121f9/model/user_count.go (about)

     1  // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
     2  // See LICENSE.txt for license information.
     3  
     4  package model
     5  
     6  // Options for counting users
     7  type UserCountOptions struct {
     8  	// Should include users that are bots
     9  	IncludeBotAccounts bool
    10  	// Should include deleted users (of any type)
    11  	IncludeDeleted bool
    12  	// Exclude regular users
    13  	ExcludeRegularUsers bool
    14  	// Only include users on a specific team. "" for any team.
    15  	TeamId string
    16  	// Only include users on a specific channel. "" for any channel.
    17  	ChannelId string
    18  	// Restrict to search in a list of teams and channels
    19  	ViewRestrictions *ViewUsersRestrictions
    20  	// Only include users matching any of the given system wide roles.
    21  	Roles []string
    22  	// Only include users matching any of the given channel roles, must be used with ChannelId.
    23  	ChannelRoles []string
    24  	// Only include users matching any of the given team roles, must be used with TeamId.
    25  	TeamRoles []string
    26  }