NodeOPCUA API Documentation
Book
GitHub
Support
Preparing search index...
node-opcua-file-transfer
ClientFile
Class ClientFile
Implements
IClientFile
Index
Constructors
constructor
Properties
file
Handle
node
Id
session
use
Global
Method
Accessors
file
Node
Id
Methods
browse
Name
close
ensure
Initialized
extract
Methods
Ids
get
Position
open
open
Count
read
set
Position
size
write
Constructors
constructor
new
ClientFile
(
session
:
IBasicSessionAsync
,
nodeId
:
NodeId
)
:
ClientFile
Parameters
session
:
IBasicSessionAsync
nodeId
:
NodeId
Returns
ClientFile
Properties
file
Handle
fileHandle
:
number
= 0
Readonly
node
Id
nodeId
:
NodeId
session
session
:
IBasicSessionAsync
Static
use
Global
Method
useGlobalMethod
:
boolean
= false
Accessors
Protected
file
Node
Id
get
fileNodeId
()
:
NodeId
Returns
NodeId
Deprecated
use nodeId instead
Methods
browse
Name
browseName
()
:
Promise
<
QualifiedName
>
Returns
Promise
<
QualifiedName
>
close
close
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Protected
ensure
Initialized
ensureInitialized
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Protected
extract
Methods
Ids
extractMethodsIds
()
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Position
getPosition
()
:
Promise
<
UInt64
>
Returns
Promise
<
UInt64
>
open
open
(
mode
:
OpenFileMode
)
:
Promise
<
number
>
Parameters
mode
:
OpenFileMode
Returns
Promise
<
number
>
open
Count
openCount
()
:
Promise
<
number
>
Returns
Promise
<
number
>
read
read
(
bytesToRead
:
number
|
UInt64
|
Int64
)
:
Promise
<
Buffer
<
ArrayBufferLike
>
>
Parameters
bytesToRead
:
number
|
UInt64
|
Int64
Returns
Promise
<
Buffer
<
ArrayBufferLike
>
>
set
Position
setPosition
(
position
:
number
|
UInt64
)
:
Promise
<
void
>
Parameters
position
:
number
|
UInt64
Returns
Promise
<
void
>
size
size
()
:
Promise
<
UInt64
>
Returns
Promise
<
UInt64
>
write
write
(
data
:
Buffer
)
:
Promise
<
void
>
Parameters
data
:
Buffer
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
file
Handle
node
Id
session
use
Global
Method
Accessors
file
Node
Id
Methods
browse
Name
close
ensure
Initialized
extract
Methods
Ids
get
Position
open
open
Count
read
set
Position
size
write
Book
GitHub
Support
NodeOPCUA API Documentation
Loading...
Deprecated
use nodeId instead