GroupsListOptions 类

命名空间: Limyee.Extensibility.Api.Version1
程序集: Limyee.Api.dll

定义

class GroupsListOptions
{
	string ContainerIds { get; set;  }
	string GroupNameFilter { get; set;  }
	string GroupTypes { get; set;  }
	bool? IncludeAllSubGroups { get; set;  }
	bool? IncludePendingMemberships { get; set;  }
	int? PageIndex { get; set;  }
	int? PageSize { get; set;  }
	int? ParentGroupId { get; set;  }
	string Permission { get; set;  }
	string SortBy { get; set;  }
	string SortOrder { get; set;  }
	int? UserId { get; set;  }
	string Username { get; set;  }
}

属性

名称	类型	描述	默认值	选项
ContainerIds	string	Comma separated list of ContainerIds. Used to limit to a specific set of groups as well as sort order if SoryBy is set to ContainerIdsOrder
GroupNameFilter	string	Group name filter
GroupTypes	string	Group types		Joinless, PublicOpen, PublicClosed, PrivateUnlisted, PrivateListed, All
IncludeAllSubGroups	bool?	Used when getting child groups, will return all subgroups recursively.
IncludePendingMemberships	bool?	When getting groups for a user, include groups where user has PendingMembership
PageIndex	int?	Specify the page number of paged results to return. Zero-based index.
PageSize	int?	Specify the number of results to return per page.
ParentGroupId	int?	Setting a Parent Group Id returns just the child groups for the group.
Permission	string	Used to get a list of groups for which the user set in UserId has the provided Permission ID.
SortBy	string	Sort by		Name, SortOrder, LastUpdate, ContainerIdsOrder
SortOrder	string	Sort order
UserId	int?	User ID to check permissions. This option is only used whenever the PermissionId is also supplied.
Username	string	Username