TestimoX

API Reference

Class

GroupMembershipScenarioService

Edit on GitHub
Namespace ADPlayground.Groups
Assembly ADPlayground
Source ADPlayground/Groups/GroupMembershipScenarioService.cs:87
Modifiers static

Provides typed, reusable group membership scenarios for direct/effective members and parent memberships.

Inheritance

  • Object
  • GroupMembershipScenarioService

Methods

public static IReadOnlyList<TEntry> ApplyPaging<TEntry>(IEnumerable<TEntry> entries, DirectoryScenarioPagingOptions paging) #
ADPlayground/Groups/GroupMembershipScenarioService.cs:198
Returns: IReadOnlyList<TEntry>

Type Parameters

TEntry

Parameters

entries IEnumerable<TEntry> requiredposition: 0
paging DirectoryScenarioPagingOptions requiredposition: 1
ApplyPaging``1(System.Collections.Generic.IEnumerable{``0} entries, ADPlayground.DirectoryScenarioPagingOptions paging) #

Applies offset/limit paging to an ordered sequence.

Type Parameters

TEntry
Entry type.

Parameters

entries System.Collections.Generic.IEnumerable{``0} required
Ordered source entries.
paging ADPlayground.DirectoryScenarioPagingOptions required
Optional paging options.

Returns

Paged entries as a stable materialized list.

public static async Task<IReadOnlyList<GroupMembershipEntry>> QueryGroupMembersEffectiveAsync(GroupMembersScenarioOptions options, DirectoryScenarioPagingOptions paging = null, CancellationToken cancellationToken = null) #
Returns: Task<IReadOnlyList<GroupMembershipEntry>>

Queries ordered effective members with optional paging applied.

Parameters

options ADPlayground.Groups.GroupMembersScenarioOptions requiredposition: 0
Group member scenario options.
paging ADPlayground.DirectoryScenarioPagingOptions = null optionalposition: 1
Optional paging options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 2
Cancellation token.

Returns

Paged effective member entries.

public static async Task<IReadOnlyList<GroupParentEntry>> QueryPrincipalGroupMembershipAsync(PrincipalGroupMembershipScenarioOptions options, DirectoryScenarioPagingOptions paging = null, CancellationToken cancellationToken = null) #
Returns: Task<IReadOnlyList<GroupParentEntry>>

Queries ordered parent-group membership entries with optional paging applied.

Parameters

options ADPlayground.Groups.PrincipalGroupMembershipScenarioOptions requiredposition: 0
Principal group-membership options.
paging ADPlayground.DirectoryScenarioPagingOptions = null optionalposition: 1
Optional paging options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 2
Cancellation token.

Returns

Paged parent-group membership entries.

public static Task<GroupMembershipResult> ResolveGroupMembersEffectiveAsync(GroupMembersScenarioOptions options, CancellationToken cancellationToken = null) #
ADPlayground/Groups/GroupMembershipScenarioService.cs:87
Returns: Task<GroupMembershipResult>

Resolves effective (recursive) members for the provided group identities.

Parameters

options ADPlayground.Groups.GroupMembersScenarioOptions requiredposition: 0
Group member scenario options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 1
Cancellation token.

Returns

Effective group-membership result.

public static Task<GroupParentResult> ResolvePrincipalGroupMembershipAsync(PrincipalGroupMembershipScenarioOptions options, CancellationToken cancellationToken = null) #
ADPlayground/Groups/GroupMembershipScenarioService.cs:142
Returns: Task<GroupParentResult>

Resolves parent-group memberships for provided principal identities.

Parameters

options ADPlayground.Groups.PrincipalGroupMembershipScenarioOptions requiredposition: 0
Principal group-membership options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 1
Cancellation token.

Returns

Parent-group membership result.

public static IAsyncEnumerable<GroupMembershipEntry> StreamGroupMembersDirectAsync(GroupMembersScenarioOptions options, CancellationToken cancellationToken = null) #
Returns: IAsyncEnumerable<GroupMembershipEntry>

Streams direct members for the provided group identities.

Parameters

options ADPlayground.Groups.GroupMembersScenarioOptions requiredposition: 0
Group member scenario options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 1
Cancellation token.

Returns

Stream of direct membership entries.

public static IAsyncEnumerable<GroupMembershipEntry> StreamGroupMembersEffectiveAsync(GroupMembersScenarioOptions options, CancellationToken cancellationToken = null) #
Returns: IAsyncEnumerable<GroupMembershipEntry>

Streams effective (recursive) members for the provided group identities.

Parameters

options ADPlayground.Groups.GroupMembersScenarioOptions requiredposition: 0
Group member scenario options.
cancellationToken System.Threading.CancellationToken = null optionalposition: 1
Cancellation token.

Returns

Stream of effective membership entries.