Preparing search index...
The search index is not available
@lucadiba/switchbot-client
@lucadiba/switchbot-client
devices/SwitchBotKeypad
default
Class default
Hierarchy (
View Summary
)
DeviceWithStatus
<
StatusBody
,
CommandBody
>
default
Index
Constructors
constructor
Properties
_deps
_device
Id
Methods
_get
Path
create
Key
delete
Key
get
Hub
Device
Id
get
Status
send
Command
Constructors
constructor
new
default
(
deviceId
:
string
,
deps
:
Deps
)
:
default
Parameters
deviceId
:
string
deps
:
Deps
Returns
default
Properties
Protected
Readonly
_deps
_deps
:
Deps
Protected
Readonly
_device
Id
_deviceId
:
string
Methods
Protected
_get
Path
_getPath
(
path
:
string
)
:
string
Parameters
path
:
string
Returns
string
create
Key
createKey
(
params
:
|
{
name
:
string
;
password
:
string
;
type
:
"permanent"
|
"urgent"
}
|
{
endTime
:
Date
;
name
:
string
;
password
:
string
;
startTime
:
Date
;
type
:
"timeLimit"
|
"disposable"
;
}
,
)
:
Promise
<
any
>
Create a new passcode.
Parameters
params
:
|
{
name
:
string
;
password
:
string
;
type
:
"permanent"
|
"urgent"
}
|
{
endTime
:
Date
;
name
:
string
;
password
:
string
;
startTime
:
Date
;
type
:
"timeLimit"
|
"disposable"
;
}
Returns
Promise
<
any
>
delete
Key
deleteKey
(
id
:
number
)
:
Promise
<
any
>
Delete an existing passcode.
Parameters
id
:
number
Returns
Promise
<
any
>
get
Hub
Device
Id
getHubDeviceId
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Status
getStatus
(
options
?:
GetStatusOptions
)
:
Promise
<
StatusBody
>
Parameters
options
:
GetStatusOptions
= {}
Returns
Promise
<
StatusBody
>
Protected
send
Command
sendCommand
(
command
:
string
,
parameter
?:
any
)
:
Promise
<
any
>
Parameters
command
:
string
parameter
:
any
= "default"
Returns
Promise
<
any
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
_deps
_device
Id
Methods
_get
Path
create
Key
delete
Key
get
Hub
Device
Id
get
Status
send
Command
@lucadiba/switchbot-client
Loading...
Create a new passcode.