HybridConnection interface
Description of hybrid connection resource.
- Extends
Properties
created |
The time the hybrid connection was created. NOTE: This property will not be serialized. It can only be populated by the server. |
listener |
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. NOTE: This property will not be serialized. It can only be populated by the server. |
requires |
Returns true if client authorization is needed for this hybrid connection; otherwise, false. |
updated |
The time the namespace was updated. NOTE: This property will not be serialized. It can only be populated by the server. |
user |
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored. |
Inherited Properties
id | Resource ID. NOTE: This property will not be serialized. It can only be populated by the server. |
name | Resource name. NOTE: This property will not be serialized. It can only be populated by the server. |
type | Resource type. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
createdAt
The time the hybrid connection was created. NOTE: This property will not be serialized. It can only be populated by the server.
createdAt?: Date
Property Value
Date
listenerCount
The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported. NOTE: This property will not be serialized. It can only be populated by the server.
listenerCount?: number
Property Value
number
requiresClientAuthorization
Returns true if client authorization is needed for this hybrid connection; otherwise, false.
requiresClientAuthorization?: boolean
Property Value
boolean
updatedAt
The time the namespace was updated. NOTE: This property will not be serialized. It can only be populated by the server.
updatedAt?: Date
Property Value
Date
userMetadata
The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
userMetadata?: string
Property Value
string
Inherited Property Details
id
Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From Resource.id
name
Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From Resource.name
type
Resource type. NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From Resource.type