149 строки
7.9 KiB
YAML
149 строки
7.9 KiB
YAML
### YamlMime:JavaType
|
||
constructors:
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.IotHubConnectionString(String connectionString)
|
||
name: IotHubConnectionString(String connectionString)
|
||
nameWithType: IotHubConnectionString.IotHubConnectionString(String connectionString)
|
||
parameters:
|
||
- description: <p>is the iothub connection string to parse. </p>
|
||
name: connectionString
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
exceptions:
|
||
- type: <xref href="IllegalArgumentException?alt=IllegalArgumentException&text=IllegalArgumentException" data-throw-if-not-resolved="False"/>
|
||
description: >-
|
||
<p>if the provided connectionString is<code>null
|
||
|
||
</code> , empty, or not valid or if the hostName in the connection string is not a valid URI. </p>
|
||
summary: >-
|
||
<p>CONSTRUCTOR.</p>
|
||
|
||
<p></p>
|
||
syntax: public IotHubConnectionString(String connectionString)
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.IotHubConnectionString(String)
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.IotHubConnectionString(String hostName, String deviceId, String sharedAccessKey, String sharedAccessToken)
|
||
name: IotHubConnectionString(String hostName, String deviceId, String sharedAccessKey, String sharedAccessToken)
|
||
nameWithType: IotHubConnectionString.IotHubConnectionString(String hostName, String deviceId, String sharedAccessKey, String sharedAccessToken)
|
||
parameters:
|
||
- description: <p>the IoT Hub hostname. </p>
|
||
name: hostName
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
- description: <p>the device ID. </p>
|
||
name: deviceId
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
- description: <p>the device key. </p>
|
||
name: sharedAccessKey
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
- description: <p>the shared access token. </p>
|
||
name: sharedAccessToken
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
exceptions:
|
||
- type: <xref href="IllegalArgumentException?alt=IllegalArgumentException&text=IllegalArgumentException" data-throw-if-not-resolved="False"/>
|
||
description: <p>if the IoT Hub hostname does not contain a valid IoT Hub name as its prefix or if the IoT Hub hostname does not conform to RFC 3986. </p>
|
||
summary: >-
|
||
<p>Constructor.</p>
|
||
|
||
<p></p>
|
||
syntax: public IotHubConnectionString(String hostName, String deviceId, String sharedAccessKey, String sharedAccessToken)
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.IotHubConnectionString(String,String,String,String)
|
||
inheritances:
|
||
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
|
||
methods:
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getDeviceId()
|
||
name: getDeviceId()
|
||
nameWithType: IotHubConnectionString.getDeviceId()
|
||
returns:
|
||
description: <p>string with the deviceId in the connectionString </p>
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
summary: <p>Getter for the deviceId. </p>
|
||
syntax: public String getDeviceId()
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getDeviceId()
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getGatewayHostName()
|
||
name: getGatewayHostName()
|
||
nameWithType: IotHubConnectionString.getGatewayHostName()
|
||
returns:
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
syntax: public String getGatewayHostName()
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getGatewayHostName()
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getHostName()
|
||
name: getHostName()
|
||
nameWithType: IotHubConnectionString.getHostName()
|
||
returns:
|
||
description: <p>string with the hostName in the connectionString </p>
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
summary: <p>Getter for the hostName. </p>
|
||
syntax: public String getHostName()
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getHostName()
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getHubName()
|
||
name: getHubName()
|
||
nameWithType: IotHubConnectionString.getHubName()
|
||
returns:
|
||
description: <p>string with the hubName in the connectionString </p>
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
summary: <p>Getter for the hubName. </p>
|
||
syntax: public String getHubName()
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getHubName()
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getModuleId()
|
||
name: getModuleId()
|
||
nameWithType: IotHubConnectionString.getModuleId()
|
||
returns:
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
syntax: public String getModuleId()
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getModuleId()
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getSharedAccessKey()
|
||
name: getSharedAccessKey()
|
||
nameWithType: IotHubConnectionString.getSharedAccessKey()
|
||
returns:
|
||
description: >-
|
||
<p>string with the sharedAccessKey in the connectionString. It can be<code>null
|
||
|
||
</code> . </p>
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
summary: <p>Getter for the sharedAccessKey. </p>
|
||
syntax: public String getSharedAccessKey()
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getSharedAccessKey()
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getSharedAccessToken()
|
||
name: getSharedAccessToken()
|
||
nameWithType: IotHubConnectionString.getSharedAccessToken()
|
||
returns:
|
||
description: >-
|
||
<p>string with the sharedAccessToken in the connectionString. It can be<code>null
|
||
|
||
</code> . </p>
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
summary: <p>Getter for the sharedAccessToken. </p>
|
||
syntax: public String getSharedAccessToken()
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.getSharedAccessToken()
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.isUsingX509()
|
||
name: isUsingX509()
|
||
nameWithType: IotHubConnectionString.isUsingX509()
|
||
returns:
|
||
description: <p>The value of UsingX509 </p>
|
||
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
||
summary: >-
|
||
<p>Getter for UsingX509</p>
|
||
|
||
<p></p>
|
||
syntax: public boolean isUsingX509()
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.isUsingX509()
|
||
- fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.setSharedAccessToken(String sharedAccessToken)
|
||
name: setSharedAccessToken(String sharedAccessToken)
|
||
nameWithType: IotHubConnectionString.setSharedAccessToken(String sharedAccessToken)
|
||
parameters:
|
||
- description: <p>the new token value to set </p>
|
||
name: sharedAccessToken
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
exceptions:
|
||
- type: <xref href="IllegalArgumentException?alt=IllegalArgumentException&text=IllegalArgumentException" data-throw-if-not-resolved="False"/>
|
||
description: <p>if the provided value is null or empty </p>
|
||
summary: <p>Setter for the shared access token </p>
|
||
syntax: public void setSharedAccessToken(String sharedAccessToken)
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString.setSharedAccessToken(String)
|
||
nameWithType: IotHubConnectionString
|
||
syntax: public class IotHubConnectionString
|
||
type: class
|
||
uid: com.microsoft.azure.sdk.iot.device.IotHubConnectionString
|
||
fullName: com.microsoft.azure.sdk.iot.device.IotHubConnectionString
|
||
name: IotHubConnectionString
|
||
package: com.microsoft.azure.sdk.iot.device
|
||
summary: <p>Parser for the Iothub connection string. </p>
|
||
metadata: {}
|