Interface INetworksBluetoothClients

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface INetworksBluetoothClients

Methods

GetNetworkBluetoothClientAsync(string, string, bool?, int?, CancellationToken)

Return a Bluetooth client

[Get("/networks/{networkId}/bluetoothClients/{bluetoothClientId}")]
Task<BluetoothClient> GetNetworkBluetoothClientAsync(string networkId, string bluetoothClientId, bool? includeConnectivityHistory = null, int? connectivityHistoryTimespan = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

bluetoothClientId string

The bluetooth client id

includeConnectivityHistory bool?

Include the connectivity history for this client (optional)

connectivityHistoryTimespan int?

The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

cancellationToken CancellationToken

Returns

Task<BluetoothClient>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkBluetoothClientsAsync(string, string, double?, int?, string, string, bool?, CancellationToken)

List the Bluetooth clients seen by APs in this network

[Get("/networks/{networkId}/bluetoothClients")]
Task<List<BluetoothClient>> GetNetworkBluetoothClientsAsync(string networkId, string t0 = null, double? timespan = null, int? perPage = 1000, string startingAfter = null, string endingBefore = null, bool? includeConnectivityHistory = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

t0 string

The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)

timespan double?

The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 7 days. The default is 1 day. (optional)

perPage int?

The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)

startingAfter string

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)

endingBefore string

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)

includeConnectivityHistory bool?

Include the connectivity history for this client (optional)

cancellationToken CancellationToken

Returns

Task<List<BluetoothClient>>

Exceptions

ApiException

Thrown when fails to make API call