GroupsListOptions In-Process API Supplementary Type

GroupsListOptions is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

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;  }
}

Properties

Name	Type	Description	Options
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	All, Joinless, PrivateListed, PrivateUnlisted, PublicClosed, PublicOpen
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	ContainerIdsOrder, LastUpdate, Name, SortOrder
SortOrder	`string`	Sort order	Ascending, Descending
UserId	`int?`	User ID to check permissions. This option is only used whenever the PermissionId is also supplied.
Username	`string`	Username

Recommended