BluetoothClientsApi
BluetoothClientsApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkBluetoothClient() : object
- Operation getNetworkBluetoothClient
- getNetworkBluetoothClientAsync() : PromiseInterface
- Operation getNetworkBluetoothClientAsync
- getNetworkBluetoothClientAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkBluetoothClientAsyncWithHttpInfo
- getNetworkBluetoothClients() : object
- Operation getNetworkBluetoothClients
- getNetworkBluetoothClientsAsync() : PromiseInterface
- Operation getNetworkBluetoothClientsAsync
- getNetworkBluetoothClientsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkBluetoothClientsAsyncWithHttpInfo
- getNetworkBluetoothClientsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkBluetoothClientsWithHttpInfo
- getNetworkBluetoothClientWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkBluetoothClientWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkBluetoothClientRequest() : Request
- Create request for operation 'getNetworkBluetoothClient'
- getNetworkBluetoothClientsRequest() : Request
- Create request for operation 'getNetworkBluetoothClients'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkBluetoothClient()
Operation getNetworkBluetoothClient
public
getNetworkBluetoothClient(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : object
Return a Bluetooth client
Parameters
- $network_id : string
-
network_id (required)
- $bluetooth_client_id : string
-
bluetooth_client_id (required)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)
- $connectivity_history_timespan : int = null
-
The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)
Tags
Return values
object —getNetworkBluetoothClientAsync()
Operation getNetworkBluetoothClientAsync
public
getNetworkBluetoothClientAsync(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : PromiseInterface
Return a Bluetooth client
Parameters
- $network_id : string
-
(required)
- $bluetooth_client_id : string
-
(required)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)
- $connectivity_history_timespan : int = null
-
The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)
Tags
Return values
PromiseInterface —getNetworkBluetoothClientAsyncWithHttpInfo()
Operation getNetworkBluetoothClientAsyncWithHttpInfo
public
getNetworkBluetoothClientAsyncWithHttpInfo(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : PromiseInterface
Return a Bluetooth client
Parameters
- $network_id : string
-
(required)
- $bluetooth_client_id : string
-
(required)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)
- $connectivity_history_timespan : int = null
-
The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)
Tags
Return values
PromiseInterface —getNetworkBluetoothClients()
Operation getNetworkBluetoothClients
public
getNetworkBluetoothClients(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : object
List the Bluetooth clients seen by APs in this network
Parameters
- $network_id : string
-
network_id (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
- $timespan : float = null
-
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)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
- $starting_after : string = null
-
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)
- $ending_before : string = null
-
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)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)
Tags
Return values
object —getNetworkBluetoothClientsAsync()
Operation getNetworkBluetoothClientsAsync
public
getNetworkBluetoothClientsAsync(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : PromiseInterface
List the Bluetooth clients seen by APs in this network
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
- $timespan : float = null
-
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)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
- $starting_after : string = null
-
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)
- $ending_before : string = null
-
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)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)
Tags
Return values
PromiseInterface —getNetworkBluetoothClientsAsyncWithHttpInfo()
Operation getNetworkBluetoothClientsAsyncWithHttpInfo
public
getNetworkBluetoothClientsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : PromiseInterface
List the Bluetooth clients seen by APs in this network
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
- $timespan : float = null
-
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)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
- $starting_after : string = null
-
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)
- $ending_before : string = null
-
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)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)
Tags
Return values
PromiseInterface —getNetworkBluetoothClientsWithHttpInfo()
Operation getNetworkBluetoothClientsWithHttpInfo
public
getNetworkBluetoothClientsWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : array<string|int, mixed>
List the Bluetooth clients seen by APs in this network
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
- $timespan : float = null
-
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)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
- $starting_after : string = null
-
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)
- $ending_before : string = null
-
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)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkBluetoothClientWithHttpInfo()
Operation getNetworkBluetoothClientWithHttpInfo
public
getNetworkBluetoothClientWithHttpInfo(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : array<string|int, mixed>
Return a Bluetooth client
Parameters
- $network_id : string
-
(required)
- $bluetooth_client_id : string
-
(required)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)
- $connectivity_history_timespan : int = null
-
The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
getNetworkBluetoothClientRequest()
Create request for operation 'getNetworkBluetoothClient'
protected
getNetworkBluetoothClientRequest(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $bluetooth_client_id : string
-
(required)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)
- $connectivity_history_timespan : int = null
-
The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)
Tags
Return values
Request —getNetworkBluetoothClientsRequest()
Create request for operation 'getNetworkBluetoothClients'
protected
getNetworkBluetoothClientsRequest(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
- $timespan : float = null
-
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)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
- $starting_after : string = null
-
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)
- $ending_before : string = null
-
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)
- $include_connectivity_history : bool = null
-
Include the connectivity history for this client (optional)