ConnectivityApi
ConnectivityApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkSmDeviceConnectivity() : object
- Operation getNetworkSmDeviceConnectivity
- getNetworkSmDeviceConnectivityAsync() : PromiseInterface
- Operation getNetworkSmDeviceConnectivityAsync
- getNetworkSmDeviceConnectivityAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkSmDeviceConnectivityAsyncWithHttpInfo
- getNetworkSmDeviceConnectivityWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkSmDeviceConnectivityWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkSmDeviceConnectivityRequest() : Request
- Create request for operation 'getNetworkSmDeviceConnectivity'
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 —getNetworkSmDeviceConnectivity()
Operation getNetworkSmDeviceConnectivity
public
getNetworkSmDeviceConnectivity(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object
Returns historical connectivity data (whether a device is regularly checking in to Dashboard).
Parameters
- $network_id : string
-
network_id (required)
- $device_id : string
-
device_id (required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (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)
Tags
Return values
object —getNetworkSmDeviceConnectivityAsync()
Operation getNetworkSmDeviceConnectivityAsync
public
getNetworkSmDeviceConnectivityAsync(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface
Returns historical connectivity data (whether a device is regularly checking in to Dashboard).
Parameters
- $network_id : string
-
(required)
- $device_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (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)
Tags
Return values
PromiseInterface —getNetworkSmDeviceConnectivityAsyncWithHttpInfo()
Operation getNetworkSmDeviceConnectivityAsyncWithHttpInfo
public
getNetworkSmDeviceConnectivityAsyncWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface
Returns historical connectivity data (whether a device is regularly checking in to Dashboard).
Parameters
- $network_id : string
-
(required)
- $device_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (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)
Tags
Return values
PromiseInterface —getNetworkSmDeviceConnectivityWithHttpInfo()
Operation getNetworkSmDeviceConnectivityWithHttpInfo
public
getNetworkSmDeviceConnectivityWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>
Returns historical connectivity data (whether a device is regularly checking in to Dashboard).
Parameters
- $network_id : string
-
(required)
- $device_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (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)
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
getNetworkSmDeviceConnectivityRequest()
Create request for operation 'getNetworkSmDeviceConnectivity'
protected
getNetworkSmDeviceConnectivityRequest(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $device_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (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)