/ fm / liveswitch / ExternalNetworkInfo
Class: ExternalNetworkInfo
fm.liveswitch.ExternalNetworkInfo
External network information.
Hierarchy
-
↳ ExternalNetworkInfo
Table of contents
Constructors
Methods
- deserializeProperties
- getIPAddresses
- getPorts
- getPublicHostname
- getPublicIPAddress
- getTypeString
- serializeProperties
- setIPAddresses
- setPorts
- setPublicHostname
- setPublicIPAddress
- toJson
- fromJson
- toJson
Constructors
constructor
+ new ExternalNetworkInfo(): ExternalNetworkInfo
Returns: ExternalNetworkInfo
Inherited from: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:16
Methods
deserializeProperties
▸ Protected
deserializeProperties(key
: string, valueJson
: string): void
Deserializes the properties.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The key. |
valueJson |
string | The value in JSON format. |
Returns: void
Overrides: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:70
getIPAddresses
▸ getIPAddresses(): string[]
Gets the IP addresses.
Returns: string[]
Inherited from: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/NetworkInfo.ts:90
getPorts
▸ getPorts(): number[]
Gets the ports.
Returns: number[]
Inherited from: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/NetworkInfo.ts:102
getPublicHostname
▸ getPublicHostname(): string
Gets the public hostname.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:92
getPublicIPAddress
▸ getPublicIPAddress(): string
Gets the public IP address.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:104
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:10
serializeProperties
▸ Protected
serializeProperties(jsonObject
: Hash<string, string>): void
Serializes the properties.
Parameters:
Name | Type | Description |
---|---|---|
jsonObject |
Hash<string, string> | The JSON object. |
Returns: void
Overrides: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:117
setIPAddresses
▸ setIPAddresses(value
: string[]): void
Sets the IP addresses.
Parameters:
Name | Type |
---|---|
value |
string[] |
Returns: void
Inherited from: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/NetworkInfo.ts:132
setPorts
▸ setPorts(value
: number[]): void
Sets the ports.
Parameters:
Name | Type |
---|---|
value |
number[] |
Returns: void
Inherited from: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/NetworkInfo.ts:144
setPublicHostname
▸ setPublicHostname(value
: string): void
Sets the public hostname.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:135
setPublicIPAddress
▸ setPublicIPAddress(value
: string): void
Sets the public IP address.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:147
toJson
▸ toJson(): string
Serializes this instance to Json.
Returns: string
Inherited from: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/NetworkInfo.ts:156
fromJson
▸ Static
fromJson(networkInfoJson
: string): ExternalNetworkInfo
Deserializes Json to a ExternalNetworkInfo.
Parameters:
Name | Type | Description |
---|---|---|
networkInfoJson |
string | The serialized Json. |
Returns: ExternalNetworkInfo
The deserialized ExternalNetworkInfo.
Overrides: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:36
toJson
▸ Static
toJson(networkInfo
: ExternalNetworkInfo): string
Serializes an instance to Json.
Parameters:
Name | Type | Description |
---|---|---|
networkInfo |
ExternalNetworkInfo | The instance to serialize. |
Returns: string
Serialized Json.
Overrides: NetworkInfo
Defined in: Generated/TypeScript/fm.liveswitch/ExternalNetworkInfo.ts:54