/// <summary>
/// Asynchronously Retrieve Effective Settings, with support for cancellation.
/// </summary>
/// <remarks>
/// Retrieves a list of all effective settings associated with a single user,
/// with filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="EffectiveSettingsFilter"/> class, for narrowing down the results.
/// </param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>
/// An instance of the <see cref="EffectiveSettings"/> class.
/// </returns>
public async Task <EffectiveSettings> GetEffectiveSettingsAsync(
EffectiveSettingsFilter filter,
CancellationToken cancellationToken)
{
var context = new GetContext <EffectiveSettings>(EndpointName.EffectiveSettings, filter);
await ExecuteOperationAsync(context, cancellationToken).ConfigureAwait(false);
return(context.Results.Items.FirstOrDefault());
}
/// <summary>
/// Retrieve Effective Settings.
/// </summary>
/// <remarks>
/// Retrieves a list of all effective settings associated with a single user,
/// with filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="EffectiveSettingsFilter"/> class, for narrowing down the results.
/// </param>
/// <returns>
/// An instance of the <see cref="EffectiveSettings"/> class.
/// </returns>
public EffectiveSettings GetEffectiveSettings(EffectiveSettingsFilter filter)
{
return(AsyncUtil.RunSync(() => GetEffectiveSettingsAsync(filter)));
}
/// <summary>
/// Asynchronously Retrieve Effective Settings.
/// </summary>
/// <remarks>
/// Retrieves a list of all effective settings associated with a single user,
/// with filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="EffectiveSettingsFilter"/> class, for narrowing down the results.
/// </param>
/// <returns>
/// An instance of the <see cref="EffectiveSettings"/> class.
/// </returns>
public async Task <EffectiveSettings> GetEffectiveSettingsAsync(
EffectiveSettingsFilter filter)
{
return(await GetEffectiveSettingsAsync(filter, default).ConfigureAwait(false));
}
