/// <summary>
/// Asynchronously Retrieve Reminders, with support for cancellation.
/// </summary>
/// <remarks>
/// Retrieves a list of all reminders associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ReminderFilter"/> 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="Reminder"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public async Task <(IList <Reminder>, ResultsMeta)> GetRemindersAsync(
ReminderFilter filter,
RequestOptions options,
CancellationToken cancellationToken)
{
var context = new GetContext <Reminder>(EndpointName.Reminders, filter, options);
await ExecuteOperationAsync(context, cancellationToken).ConfigureAwait(false);
return(context.Results.Items, context.ResultsMeta);
}
/// <summary>
/// Asynchronously Retrieve Reminders.
/// </summary>
/// <remarks>
/// Retrieves a list of all reminders associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ReminderFilter"/> 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="Reminder"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public async Task <(IList <Reminder>, ResultsMeta)> GetRemindersAsync(
ReminderFilter filter,
RequestOptions options)
{
return(await GetRemindersAsync(filter, options, default).ConfigureAwait(false));
}
/// <summary>
/// Asynchronously Retrieve Reminders, with support for cancellation.
/// </summary>
/// <remarks>
/// Retrieves a list of all reminders associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ReminderFilter"/> 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="Reminder"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public async Task <(IList <Reminder>, ResultsMeta)> GetRemindersAsync(
ReminderFilter filter,
CancellationToken cancellationToken)
{
return(await GetRemindersAsync(filter, null, cancellationToken).ConfigureAwait(false));
}
/// <summary>
/// Asynchronously Retrieve Reminders.
/// </summary>
/// <remarks>
/// Retrieves a list of all reminders associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ReminderFilter"/> class, for narrowing down the results.
/// </param>
/// <returns>
/// An enumerable set of <see cref="Reminder"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public async Task <(IList <Reminder>, ResultsMeta)> GetRemindersAsync(
ReminderFilter filter)
{
return(await GetRemindersAsync(filter, null, default).ConfigureAwait(false));
}
/// <summary>
/// Retrieve Reminders.
/// </summary>
/// <remarks>
/// Retrieves a list of all reminders associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ReminderFilter"/> 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="Reminder"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public (IList <Reminder>, ResultsMeta) GetReminders(
ReminderFilter filter,
RequestOptions options)
{
return(AsyncUtil.RunSync(() => GetRemindersAsync(filter, options)));
}
/// <summary>
/// Retrieve Reminders.
/// </summary>
/// <remarks>
/// Retrieves a list of all reminders associated with your employees
/// or company, with optional filters to narrow down the results.
/// </remarks>
/// <param name="filter">
/// An instance of the <see cref="ReminderFilter"/> class, for narrowing down the results.
/// </param>
/// <returns>
/// An enumerable set of <see cref="Reminder"/> objects, along with an output
/// instance of the <see cref="ResultsMeta"/> class containing additional data.
/// </returns>
public (IList <Reminder>, ResultsMeta) GetReminders(
ReminderFilter filter)
{
return(AsyncUtil.RunSync(() => GetRemindersAsync(filter)));
}
