DialOptions class Viam SDK
Describes the behavior for connecting to a robot
Constructors
Properties
- accessToken ↔ String?
-
Allows a pre-authenticated client to dial with
an authorization header. Direct dial will have the access token
appended to the "Authorization: Bearer" header. WebRTC dial will
append it to the signaling server communication
getter/setter pair
- attemptMdns ↔ bool
-
Wether an mDNS connection will be attempted
getter/setter pair
- authEntity ↔ String?
-
The entity to authenticate as
getter/setter pair
- credentials ↔ Credentials?
-
Used to authenticate the request.
getter/setter pair
- externalAuthAddress ↔ String?
-
The address to perform external auth at.
getter/setter pair
- externalAuthToEntity ↔ String?
-
The entity to authenticate for after externally authenticating.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- insecure ↔ bool
-
Whether the RPC connection is TLS based
getter/setter pair
- logOutput ↔ LogOutput?
-
If specified, a custom log output for dial logs.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- timeout ↔ Duration
-
Timeout is the timeout for dial.
getter/setter pair
- webRtcOptions ↔ DialWebRtcOptions?
-
Options to control how WebRTC is utilized in a dial attempt
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited