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