Documentation

SenseApi

SenseApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
__construct()  : mixed
getConfig()  : Configuration
getDeviceCameraSense()  : object
Operation getDeviceCameraSense
getDeviceCameraSenseAsync()  : PromiseInterface
Operation getDeviceCameraSenseAsync
getDeviceCameraSenseAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraSenseAsyncWithHttpInfo
getDeviceCameraSenseObjectDetectionModels()  : object
Operation getDeviceCameraSenseObjectDetectionModels
getDeviceCameraSenseObjectDetectionModelsAsync()  : PromiseInterface
Operation getDeviceCameraSenseObjectDetectionModelsAsync
getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo
getDeviceCameraSenseObjectDetectionModelsWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraSenseObjectDetectionModelsWithHttpInfo
getDeviceCameraSenseWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraSenseWithHttpInfo
updateDeviceCameraSense()  : object
Operation updateDeviceCameraSense
updateDeviceCameraSenseAsync()  : PromiseInterface
Operation updateDeviceCameraSenseAsync
updateDeviceCameraSenseAsyncWithHttpInfo()  : PromiseInterface
Operation updateDeviceCameraSenseAsyncWithHttpInfo
updateDeviceCameraSenseWithHttpInfo()  : array<string|int, mixed>
Operation updateDeviceCameraSenseWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
getDeviceCameraSenseObjectDetectionModelsRequest()  : Request
Create request for operation 'getDeviceCameraSenseObjectDetectionModels'
getDeviceCameraSenseRequest()  : Request
Create request for operation 'getDeviceCameraSense'
updateDeviceCameraSenseRequest()  : Request
Create request for operation 'updateDeviceCameraSense'

Properties

$client

protected ClientInterface $client

Methods

getDeviceCameraSense()

Operation getDeviceCameraSense

public getDeviceCameraSense(string $serial) : object

Returns sense settings for a given camera

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getDeviceCameraSenseAsync()

Operation getDeviceCameraSenseAsync

public getDeviceCameraSenseAsync(string $serial) : PromiseInterface

Returns sense settings for a given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getDeviceCameraSenseAsyncWithHttpInfo()

Operation getDeviceCameraSenseAsyncWithHttpInfo

public getDeviceCameraSenseAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns sense settings for a given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getDeviceCameraSenseObjectDetectionModels()

Operation getDeviceCameraSenseObjectDetectionModels

public getDeviceCameraSenseObjectDetectionModels(string $serial) : object

Returns the MV Sense object detection model list for the given camera

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getDeviceCameraSenseObjectDetectionModelsAsync()

Operation getDeviceCameraSenseObjectDetectionModelsAsync

public getDeviceCameraSenseObjectDetectionModelsAsync(string $serial) : PromiseInterface

Returns the MV Sense object detection model list for the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo()

Operation getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo

public getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns the MV Sense object detection model list for the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getDeviceCameraSenseObjectDetectionModelsWithHttpInfo()

Operation getDeviceCameraSenseObjectDetectionModelsWithHttpInfo

public getDeviceCameraSenseObjectDetectionModelsWithHttpInfo(string $serial) : array<string|int, mixed>

Returns the MV Sense object detection model list for the given camera

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraSenseWithHttpInfo()

Operation getDeviceCameraSenseWithHttpInfo

public getDeviceCameraSenseWithHttpInfo(string $serial) : array<string|int, mixed>

Returns sense settings for a given camera

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

updateDeviceCameraSense()

Operation updateDeviceCameraSense

public updateDeviceCameraSense(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : object

Update sense settings for the given camera

Parameters
$serial : string

serial (required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

update_device_camera_sense (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

updateDeviceCameraSenseAsync()

Operation updateDeviceCameraSenseAsync

public updateDeviceCameraSenseAsync(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : PromiseInterface

Update sense settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateDeviceCameraSenseAsyncWithHttpInfo()

Operation updateDeviceCameraSenseAsyncWithHttpInfo

public updateDeviceCameraSenseAsyncWithHttpInfo(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : PromiseInterface

Update sense settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateDeviceCameraSenseWithHttpInfo()

Operation updateDeviceCameraSenseWithHttpInfo

public updateDeviceCameraSenseWithHttpInfo(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : array<string|int, mixed>

Update sense settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

getDeviceCameraSenseObjectDetectionModelsRequest()

Create request for operation 'getDeviceCameraSenseObjectDetectionModels'

protected getDeviceCameraSenseObjectDetectionModelsRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request

getDeviceCameraSenseRequest()

Create request for operation 'getDeviceCameraSense'

protected getDeviceCameraSenseRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request

updateDeviceCameraSenseRequest()

Create request for operation 'updateDeviceCameraSense'

protected updateDeviceCameraSenseRequest(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : Request
Parameters
$serial : string

(required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request

Search results