/// <summary>
/// Asynchronously Retrieve Schedule Events, with support for cancellation.
/// </summary>
/// <remarks>
/// Retrieves a list of all schedule events associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ScheduleEventFilter"/> class, for narrowing down the results.
/// </param>
/// <param name="options">
/// An instance of the <see cref="RequestOptions"/> class, for customizing method processing.
/// </param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>
/// An enumerable set of <see cref="ScheduleEvent"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public async Task <(IList <ScheduleEvent>, ResultsMeta)> GetScheduleEventsAsync(
ScheduleEventFilter filter,
RequestOptions options,
CancellationToken cancellationToken)
{
var context = new GetContext <ScheduleEvent>(EndpointName.ScheduleEvents, filter, options);
await ExecuteOperationAsync(context, cancellationToken).ConfigureAwait(false);
return(context.Results.Items, context.ResultsMeta);
}
public static ScheduleEventListRequestBuilder List(ScheduleEventFilter filter = null, FilterPager pager = null)
{
return(new ScheduleEventListRequestBuilder(filter, pager));
}
public ScheduleEventListRequestBuilder(ScheduleEventFilter filter, FilterPager pager)
: this()
{
this.Filter = filter;
this.Pager = pager;
}
/// <summary>
/// Asynchronously Retrieve Schedule Events.
/// </summary>
/// <remarks>
/// Retrieves a list of all schedule events associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ScheduleEventFilter"/> class, for narrowing down the results.
/// </param>
/// <param name="options">
/// An instance of the <see cref="RequestOptions"/> class, for customizing method processing.
/// </param>
/// <returns>
/// An enumerable set of <see cref="ScheduleEvent"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public async Task <(IList <ScheduleEvent>, ResultsMeta)> GetScheduleEventsAsync(
ScheduleEventFilter filter,
RequestOptions options)
{
return(await GetScheduleEventsAsync(filter, options, default).ConfigureAwait(false));
}
/// <summary>
/// Asynchronously Retrieve Schedule Events, with support for cancellation.
/// </summary>
/// <remarks>
/// Retrieves a list of all schedule events associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ScheduleEventFilter"/> 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 enumerable set of <see cref="ScheduleEvent"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public async Task <(IList <ScheduleEvent>, ResultsMeta)> GetScheduleEventsAsync(
ScheduleEventFilter filter,
CancellationToken cancellationToken)
{
return(await GetScheduleEventsAsync(filter, null, cancellationToken).ConfigureAwait(false));
}
/// <summary>
/// Asynchronously Retrieve Schedule Events.
/// </summary>
/// <remarks>
/// Retrieves a list of all schedule events associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ScheduleEventFilter"/> class, for narrowing down the results.
/// </param>
/// <returns>
/// An enumerable set of <see cref="ScheduleEvent"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public async Task <(IList <ScheduleEvent>, ResultsMeta)> GetScheduleEventsAsync(
ScheduleEventFilter filter)
{
return(await GetScheduleEventsAsync(filter, null, default).ConfigureAwait(false));
}
/// <summary>
/// Retrieve Schedule Events.
/// </summary>
/// <remarks>
/// Retrieves a list of all schedule events associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ScheduleEventFilter"/> class, for narrowing down the results.
/// </param>
/// <param name="options">
/// An instance of the <see cref="RequestOptions"/> class, for customizing method processing.
/// </param>
/// <returns>
/// An enumerable set of <see cref="ScheduleEvent"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public (IList <ScheduleEvent>, ResultsMeta) GetScheduleEvents(
ScheduleEventFilter filter,
RequestOptions options)
{
return(AsyncUtil.RunSync(() => GetScheduleEventsAsync(filter, options)));
}
/// <summary>
/// Retrieve Schedule Events.
/// </summary>
/// <remarks>
/// Retrieves a list of all schedule events associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ScheduleEventFilter"/> class, for narrowing down the results.
/// </param>
/// <returns>
/// An enumerable set of <see cref="ScheduleEvent"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public (IList <ScheduleEvent>, ResultsMeta) GetScheduleEvents(
ScheduleEventFilter filter)
{
return(AsyncUtil.RunSync(() => GetScheduleEventsAsync(filter)));
}
