Update Reference Content
This commit is contained in:
OpenPublishBuild
Родитель
e655e54e9c
Коммит
d6cb920632
|
|
@ -0,0 +1,213 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
id: _iot_hub_service_sas_token
|
||||
parent: com.microsoft.azure.iot.service.auth
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.expiryTime()
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.IotHubServiceSasToken(IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.keyName()
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.keyValue()
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.resourceUri()
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.token()
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.TOKEN_FORMAT()
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.toString()
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubServiceSasToken
|
||||
fullName: com.microsoft.azure.iot.service.auth.IotHubServiceSasToken
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 18
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: <p>Grants device access to an IoT Hub for the specified amount of time. </p>
|
||||
syntax:
|
||||
content: public class IotHubServiceSasToken
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.TOKEN_VALID_SECS()
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.expiryTime()
|
||||
id: expiryTime()
|
||||
parent: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: expiryTime
|
||||
fullName: final long com.microsoft.azure.iot.service.auth.IotHubServiceSasToken.expiryTime
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 37
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
syntax:
|
||||
content: protected final long expiryTime
|
||||
return:
|
||||
type: 4c60ae65
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.IotHubServiceSasToken(IotHubConnectionString)
|
||||
id: IotHubServiceSasToken(IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubServiceSasToken(IotHubConnectionString iotHubConnectionString)
|
||||
fullName: com.microsoft.azure.iot.service.auth.IotHubServiceSasToken.IotHubServiceSasToken(IotHubConnectionString iotHubConnectionString)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 49
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: >-
|
||||
<p>Constructor. Generates a SAS token that grants access to an IoT Hub for the specified amount of time. (1 year specified in TOKEN_VALID_SECS)</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubServiceSasToken(IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>Connection string object containing the connection parameters </p>
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.keyName()
|
||||
id: keyName()
|
||||
parent: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: keyName
|
||||
fullName: final String com.microsoft.azure.iot.service.auth.IotHubServiceSasToken.keyName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 39
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
syntax:
|
||||
content: protected final String keyName
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.keyValue()
|
||||
id: keyValue()
|
||||
parent: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: keyValue
|
||||
fullName: final String com.microsoft.azure.iot.service.auth.IotHubServiceSasToken.keyValue
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
syntax:
|
||||
content: protected final String keyValue
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.resourceUri()
|
||||
id: resourceUri()
|
||||
parent: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: resourceUri
|
||||
fullName: final String com.microsoft.azure.iot.service.auth.IotHubServiceSasToken.resourceUri
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 33
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
syntax:
|
||||
content: protected final String resourceUri
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.token()
|
||||
id: token()
|
||||
parent: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: token
|
||||
fullName: final String com.microsoft.azure.iot.service.auth.IotHubServiceSasToken.token
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 41
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
syntax:
|
||||
content: protected final String token
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.TOKEN_FORMAT()
|
||||
id: TOKEN_FORMAT()
|
||||
parent: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: TOKEN_FORMAT
|
||||
fullName: final String com.microsoft.azure.iot.service.auth.IotHubServiceSasToken.TOKEN_FORMAT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 30
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: '<p>The SAS token format. The parameters to be interpolated are, in order: the signature the resource URI the expiry time the key name Example:<programlisting><codeline><highlight class="normal">SharedAccessSignature<sp></sp>sr=IOTHUBURI&sig=SIGNATURE&se=EXPIRY&skn=SHAREDACCESSKEYNAME<sp></sp></highlight></codeline></programlisting></p>'
|
||||
syntax:
|
||||
content: public static final String TOKEN_FORMAT= "SharedAccessSignature sr=%s&sig=%s&se=%s&skn=%s"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iot.service.auth.IotHubServiceSasToken.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 128
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: >-
|
||||
<p>Returns the string representation of the SAS token.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The string representation of the SAS token. </p>
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 4c60ae65
|
||||
spec.java:
|
||||
- name: final long
|
||||
fullName: final long
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.TOKEN_VALID_SECS()
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
name: IotHubConnectionString
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString
|
||||
type: Class
|
||||
summary: <p>Expose all connections string properties and methods for user, device and connection string serialization. </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionString extends IotHubConnectionStringBuilder
|
||||
|
|
@ -0,0 +1,139 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
id: _symmetric_key
|
||||
parent: com.microsoft.azure.iot.service.auth
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.auth._symmetric_key.getPrimaryKey()
|
||||
- com.microsoft.azure.iot.service.auth._symmetric_key.getSecondaryKey()
|
||||
- com.microsoft.azure.iot.service.auth._symmetric_key.setPrimaryKey(String)
|
||||
- com.microsoft.azure.iot.service.auth._symmetric_key.setSecondaryKey(String)
|
||||
- com.microsoft.azure.iot.service.auth._symmetric_key.SymmetricKey()
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: SymmetricKey
|
||||
fullName: com.microsoft.azure.iot.service.auth.SymmetricKey
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/SymmetricKey.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/SymmetricKey.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: <p>Store primary and secondary keys Provide function for key length validation </p>
|
||||
syntax:
|
||||
content: public class SymmetricKey
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key.getPrimaryKey()
|
||||
id: getPrimaryKey()
|
||||
parent: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPrimaryKey()
|
||||
fullName: String com.microsoft.azure.iot.service.auth.SymmetricKey.getPrimaryKey()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/SymmetricKey.java
|
||||
startLine: 33
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: <p>Getter for primary key </p>
|
||||
syntax:
|
||||
content: public String getPrimaryKey()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>Primary key part of the symmetric key </p>
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key.getSecondaryKey()
|
||||
id: getSecondaryKey()
|
||||
parent: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: getSecondaryKey()
|
||||
fullName: String com.microsoft.azure.iot.service.auth.SymmetricKey.getSecondaryKey()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/SymmetricKey.java
|
||||
startLine: 56
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: <p>Getter for secondary key </p>
|
||||
syntax:
|
||||
content: public String getSecondaryKey()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>Secondary key part of the symmetric key </p>
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key.setPrimaryKey(String)
|
||||
id: setPrimaryKey(String)
|
||||
parent: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: setPrimaryKey(String primaryKey)
|
||||
fullName: void com.microsoft.azure.iot.service.auth.SymmetricKey.setPrimaryKey(String primaryKey)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/SymmetricKey.java
|
||||
startLine: 44
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: >-
|
||||
<p>Setter for primary key Validates the length of the key</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setPrimaryKey(String primaryKey)
|
||||
parameters:
|
||||
- id: primaryKey
|
||||
type: "26831127"
|
||||
description: <p>Primary key part of the symmetric key </p>
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key.setSecondaryKey(String)
|
||||
id: setSecondaryKey(String)
|
||||
parent: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: setSecondaryKey(String secondaryKey)
|
||||
fullName: void com.microsoft.azure.iot.service.auth.SymmetricKey.setSecondaryKey(String secondaryKey)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/SymmetricKey.java
|
||||
startLine: 67
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: >-
|
||||
<p>Setter for secondary key Validates the length of the key</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setSecondaryKey(String secondaryKey)
|
||||
parameters:
|
||||
- id: secondaryKey
|
||||
type: "26831127"
|
||||
description: <p>Secondary key part of the symmetric key </p>
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key.SymmetricKey()
|
||||
id: SymmetricKey()
|
||||
parent: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: SymmetricKey()
|
||||
fullName: com.microsoft.azure.iot.service.auth.SymmetricKey.SymmetricKey()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/SymmetricKey.java
|
||||
startLine: 23
|
||||
package: com.microsoft.azure.iot.service.auth
|
||||
summary: <p>Constructor for initialization </p>
|
||||
syntax:
|
||||
content: public SymmetricKey()
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.auth
|
||||
id: auth
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
- com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
href: com.microsoft.azure.iot.service.auth.yml
|
||||
langs:
|
||||
- java
|
||||
name: com.microsoft.azure.iot.service.auth
|
||||
fullName: com.microsoft.azure.iot.service.auth
|
||||
type: Namespace
|
||||
source:
|
||||
remote:
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/auth/IotHubServiceSasToken.java
|
||||
startLine: 5
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iot.service.auth
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token
|
||||
parent: com.microsoft.azure.iot.service.auth
|
||||
href: com.microsoft.azure.iot.service.auth._iot_hub_service_sas_token.yml
|
||||
name: IotHubServiceSasToken
|
||||
fullName: com.microsoft.azure.iot.service.auth.IotHubServiceSasToken
|
||||
type: Class
|
||||
summary: <p>Grants device access to an IoT Hub for the specified amount of time. </p>
|
||||
syntax:
|
||||
content: public class IotHubServiceSasToken
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
parent: com.microsoft.azure.iot.service.auth
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
name: SymmetricKey
|
||||
fullName: com.microsoft.azure.iot.service.auth.SymmetricKey
|
||||
type: Class
|
||||
summary: <p>Store primary and secondary keys Provide function for key length validation </p>
|
||||
syntax:
|
||||
content: public class SymmetricKey
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception
|
||||
id: _iot_hub_bad_format_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception.IotHubBadFormatException()
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubBadFormatException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubBadFormatException
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubBadFormatException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubBadFormatException.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Create bad message format exception </p>
|
||||
syntax:
|
||||
content: public class IotHubBadFormatException extends IotHubException
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception.IotHubBadFormatException()
|
||||
id: IotHubBadFormatException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubBadFormatException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubBadFormatException.IotHubBadFormatException()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubBadFormatException.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubBadFormatException()
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException()
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException()
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException(String message)
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException(String message)
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException(String message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
|
|
@ -0,0 +1,139 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
id: _iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubException.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Exception
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
id: IotHubException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubException.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubException()
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
id: IotHubException(String)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubException(String message)
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException(String message)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubException.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubException(String message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: "26831127"
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception.yml
|
||||
name: IotHubBadFormatException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubBadFormatException
|
||||
type: Class
|
||||
summary: <p>Create bad message format exception </p>
|
||||
syntax:
|
||||
content: public class IotHubBadFormatException extends IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception.yml
|
||||
name: IotHubInternalServerErrorException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubInternalServerErrorException
|
||||
type: Class
|
||||
summary: <p>Create internal server error exception </p>
|
||||
syntax:
|
||||
content: public class IotHubInternalServerErrorException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception.yml
|
||||
name: IotHubNotFoundException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubNotFoundException
|
||||
type: Class
|
||||
summary: <p>Create iot hub not found exception </p>
|
||||
syntax:
|
||||
content: public class IotHubNotFoundException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception.yml
|
||||
name: IotHubPreconditionFailedException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubPreconditionFailedException
|
||||
type: Class
|
||||
summary: <p>Create precondition failed exception </p>
|
||||
syntax:
|
||||
content: public class IotHubPreconditionFailedException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception.yml
|
||||
name: IotHubServerBusyException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubServerBusyException
|
||||
type: Class
|
||||
summary: <p>Create server busy exception </p>
|
||||
syntax:
|
||||
content: public class IotHubServerBusyException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception.yml
|
||||
name: IotHubTooManyDevicesException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyDevicesException
|
||||
type: Class
|
||||
summary: <p>Create too many devices exception </p>
|
||||
syntax:
|
||||
content: public class IotHubTooManyDevicesException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception.yml
|
||||
name: IotHubTooManyRequestsException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyRequestsException
|
||||
type: Class
|
||||
summary: <p>Create too many requests exception </p>
|
||||
syntax:
|
||||
content: public class IotHubTooManyRequestsException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception.yml
|
||||
name: IotHubUnathorizedException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubUnathorizedException
|
||||
type: Class
|
||||
summary: <p>Create unauthorized exception </p>
|
||||
syntax:
|
||||
content: public class IotHubUnathorizedException
|
||||
|
|
@ -0,0 +1,159 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception_manager
|
||||
id: _iot_hub_exception_manager
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception_manager.httpResponseVerification(HttpResponse)
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception_manager.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubExceptionManager
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubExceptionManager
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubExceptionManager.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubExceptionManager.java
|
||||
startLine: 19
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Provide static function to verify results and throw appropriate exception. </p>
|
||||
syntax:
|
||||
content: public class IotHubExceptionManager
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception_manager.httpResponseVerification(HttpResponse)
|
||||
id: httpResponseVerification(HttpResponse)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception_manager
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception_manager.yml
|
||||
langs:
|
||||
- java
|
||||
name: httpResponseVerification(HttpResponse httpResponse)
|
||||
fullName: static void com.microsoft.azure.iot.service.exceptions.IotHubExceptionManager.httpResponseVerification(HttpResponse httpResponse)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubExceptionManager.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: >-
|
||||
<p>Verify Http response using response status</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static void httpResponseVerification(HttpResponse httpResponse)
|
||||
parameters:
|
||||
- id: httpResponse
|
||||
type: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
description: <p>Http response object to verify </p>
|
||||
exceptions:
|
||||
- type: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception
|
||||
description: <p>This exception is thrown if the response status equal 400 </p>
|
||||
- type: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception
|
||||
description: <p>This exception is thrown if the response status equal 401 </p>
|
||||
- type: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception
|
||||
description: <p>This exception is thrown if the response status equal 403 </p>
|
||||
- type: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception
|
||||
description: <p>This exception is thrown if the response status equal 404 </p>
|
||||
- type: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception
|
||||
description: <p>This exception is thrown if the response status equal 412 </p>
|
||||
- type: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception
|
||||
description: <p>This exception is thrown if the response status equal 429 </p>
|
||||
- type: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception
|
||||
description: <p>This exception is thrown if the response status equal 500 </p>
|
||||
- type: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception
|
||||
description: <p>This exception is thrown if the response status equal 503 </p>
|
||||
- type: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
description: <p>This exception is thrown if the response status none of them above and greater then 300 </p>
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
name: HttpResponse
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpResponse
|
||||
type: Class
|
||||
summary: <p>An HTTPS response. Contains the status code, body, header fields, and error reason (if any). </p>
|
||||
syntax:
|
||||
content: public class HttpResponse
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception.yml
|
||||
name: IotHubBadFormatException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubBadFormatException
|
||||
type: Class
|
||||
summary: <p>Create bad message format exception </p>
|
||||
syntax:
|
||||
content: public class IotHubBadFormatException extends IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception.yml
|
||||
name: IotHubUnathorizedException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubUnathorizedException
|
||||
type: Class
|
||||
summary: <p>Create unauthorized exception </p>
|
||||
syntax:
|
||||
content: public class IotHubUnathorizedException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception.yml
|
||||
name: IotHubTooManyDevicesException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyDevicesException
|
||||
type: Class
|
||||
summary: <p>Create too many devices exception </p>
|
||||
syntax:
|
||||
content: public class IotHubTooManyDevicesException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception.yml
|
||||
name: IotHubPreconditionFailedException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubPreconditionFailedException
|
||||
type: Class
|
||||
summary: <p>Create precondition failed exception </p>
|
||||
syntax:
|
||||
content: public class IotHubPreconditionFailedException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception.yml
|
||||
name: IotHubTooManyRequestsException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyRequestsException
|
||||
type: Class
|
||||
summary: <p>Create too many requests exception </p>
|
||||
syntax:
|
||||
content: public class IotHubTooManyRequestsException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception.yml
|
||||
name: IotHubInternalServerErrorException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubInternalServerErrorException
|
||||
type: Class
|
||||
summary: <p>Create internal server error exception </p>
|
||||
syntax:
|
||||
content: public class IotHubInternalServerErrorException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception.yml
|
||||
name: IotHubServerBusyException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubServerBusyException
|
||||
type: Class
|
||||
summary: <p>Create server busy exception </p>
|
||||
syntax:
|
||||
content: public class IotHubServerBusyException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception.yml
|
||||
name: IotHubNotFoundException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubNotFoundException
|
||||
type: Class
|
||||
summary: <p>Create iot hub not found exception </p>
|
||||
syntax:
|
||||
content: public class IotHubNotFoundException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception
|
||||
id: _iot_hub_internal_server_error_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception.IotHubInternalServerErrorException()
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubInternalServerErrorException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubInternalServerErrorException
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubInternalServerErrorException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubInternalServerErrorException.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Create internal server error exception </p>
|
||||
syntax:
|
||||
content: public class IotHubInternalServerErrorException extends IotHubException
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception.IotHubInternalServerErrorException()
|
||||
id: IotHubInternalServerErrorException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubInternalServerErrorException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubInternalServerErrorException.IotHubInternalServerErrorException()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubInternalServerErrorException.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubInternalServerErrorException()
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException()
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException()
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException(String message)
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException(String message)
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException(String message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception
|
||||
id: _iot_hub_not_found_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception.IotHubNotFoundException()
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubNotFoundException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubNotFoundException
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubNotFoundException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubNotFoundException.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Create iot hub not found exception </p>
|
||||
syntax:
|
||||
content: public class IotHubNotFoundException extends IotHubException
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception.IotHubNotFoundException()
|
||||
id: IotHubNotFoundException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubNotFoundException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubNotFoundException.IotHubNotFoundException()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubNotFoundException.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubNotFoundException()
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException()
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException()
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException(String message)
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException(String message)
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException(String message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception
|
||||
id: _iot_hub_precondition_failed_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception.IotHubPreconditionFailedException()
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubPreconditionFailedException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubPreconditionFailedException
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubPreconditionFailedException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubPreconditionFailedException.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Create precondition failed exception </p>
|
||||
syntax:
|
||||
content: public class IotHubPreconditionFailedException extends IotHubException
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception.IotHubPreconditionFailedException()
|
||||
id: IotHubPreconditionFailedException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubPreconditionFailedException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubPreconditionFailedException.IotHubPreconditionFailedException()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubPreconditionFailedException.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubPreconditionFailedException()
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException()
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException()
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException(String message)
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException(String message)
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException(String message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception
|
||||
id: _iot_hub_server_busy_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception.IotHubServerBusyException()
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubServerBusyException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubServerBusyException
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubServerBusyException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubServerBusyException.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Create server busy exception </p>
|
||||
syntax:
|
||||
content: public class IotHubServerBusyException extends IotHubException
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception.IotHubServerBusyException()
|
||||
id: IotHubServerBusyException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubServerBusyException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubServerBusyException.IotHubServerBusyException()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubServerBusyException.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubServerBusyException()
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException()
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException()
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException(String message)
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException(String message)
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException(String message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception
|
||||
id: _iot_hub_too_many_devices_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception.IotHubTooManyDevicesException()
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubTooManyDevicesException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyDevicesException
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubTooManyDevicesException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubTooManyDevicesException.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Create too many devices exception </p>
|
||||
syntax:
|
||||
content: public class IotHubTooManyDevicesException extends IotHubException
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception.IotHubTooManyDevicesException()
|
||||
id: IotHubTooManyDevicesException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubTooManyDevicesException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyDevicesException.IotHubTooManyDevicesException()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubTooManyDevicesException.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubTooManyDevicesException()
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException()
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException()
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException(String message)
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException(String message)
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException(String message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception
|
||||
id: _iot_hub_too_many_requests_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception.IotHubTooManyRequestsException()
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubTooManyRequestsException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyRequestsException
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubTooManyRequestsException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubTooManyRequestsException.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Create too many requests exception </p>
|
||||
syntax:
|
||||
content: public class IotHubTooManyRequestsException extends IotHubException
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception.IotHubTooManyRequestsException()
|
||||
id: IotHubTooManyRequestsException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubTooManyRequestsException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyRequestsException.IotHubTooManyRequestsException()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubTooManyRequestsException.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubTooManyRequestsException()
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException()
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException()
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException(String message)
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException(String message)
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException(String message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception
|
||||
id: _iot_hub_unathorized_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception.IotHubUnathorizedException()
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubUnathorizedException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubUnathorizedException
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubUnathorizedException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubUnathorizedException.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
summary: <p>Create unauthorized exception </p>
|
||||
syntax:
|
||||
content: public class IotHubUnathorizedException extends IotHubException
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception.IotHubUnathorizedException()
|
||||
id: IotHubUnathorizedException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubUnathorizedException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubUnathorizedException.IotHubUnathorizedException()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubUnathorizedException.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.exceptions
|
||||
syntax:
|
||||
content: public IotHubUnathorizedException()
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException()
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException()
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException()
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException()
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.IotHubException(String)
|
||||
parent: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException(String message)
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException.IotHubException(String message)
|
||||
type: Constructor
|
||||
syntax:
|
||||
content: public IotHubException(String message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions
|
||||
id: exceptions
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_exception_manager
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception
|
||||
- com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception
|
||||
href: com.microsoft.azure.iot.service.exceptions.yml
|
||||
langs:
|
||||
- java
|
||||
name: com.microsoft.azure.iot.service.exceptions
|
||||
fullName: com.microsoft.azure.iot.service.exceptions
|
||||
type: Namespace
|
||||
source:
|
||||
remote:
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubBadFormatException.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/exceptions/IotHubBadFormatException.java
|
||||
startLine: 5
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iot.service.exceptions
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_bad_format_exception.yml
|
||||
name: IotHubBadFormatException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubBadFormatException
|
||||
type: Class
|
||||
summary: <p>Create bad message format exception </p>
|
||||
syntax:
|
||||
content: public class IotHubBadFormatException extends IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception.yml
|
||||
name: IotHubException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubException
|
||||
type: Class
|
||||
summary: <p>Super class for IotHub exceptions </p>
|
||||
syntax:
|
||||
content: public class IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_exception_manager
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_exception_manager.yml
|
||||
name: IotHubExceptionManager
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubExceptionManager
|
||||
type: Class
|
||||
summary: <p>Provide static function to verify results and throw appropriate exception. </p>
|
||||
syntax:
|
||||
content: public class IotHubExceptionManager
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_internal_server_error_exception.yml
|
||||
name: IotHubInternalServerErrorException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubInternalServerErrorException
|
||||
type: Class
|
||||
summary: <p>Create internal server error exception </p>
|
||||
syntax:
|
||||
content: public class IotHubInternalServerErrorException extends IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_not_found_exception.yml
|
||||
name: IotHubNotFoundException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubNotFoundException
|
||||
type: Class
|
||||
summary: <p>Create iot hub not found exception </p>
|
||||
syntax:
|
||||
content: public class IotHubNotFoundException extends IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_precondition_failed_exception.yml
|
||||
name: IotHubPreconditionFailedException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubPreconditionFailedException
|
||||
type: Class
|
||||
summary: <p>Create precondition failed exception </p>
|
||||
syntax:
|
||||
content: public class IotHubPreconditionFailedException extends IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_server_busy_exception.yml
|
||||
name: IotHubServerBusyException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubServerBusyException
|
||||
type: Class
|
||||
summary: <p>Create server busy exception </p>
|
||||
syntax:
|
||||
content: public class IotHubServerBusyException extends IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_devices_exception.yml
|
||||
name: IotHubTooManyDevicesException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyDevicesException
|
||||
type: Class
|
||||
summary: <p>Create too many devices exception </p>
|
||||
syntax:
|
||||
content: public class IotHubTooManyDevicesException extends IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_too_many_requests_exception.yml
|
||||
name: IotHubTooManyRequestsException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubTooManyRequestsException
|
||||
type: Class
|
||||
summary: <p>Create too many requests exception </p>
|
||||
syntax:
|
||||
content: public class IotHubTooManyRequestsException extends IotHubException
|
||||
- uid: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception
|
||||
parent: com.microsoft.azure.iot.service.exceptions
|
||||
href: com.microsoft.azure.iot.service.exceptions._iot_hub_unathorized_exception.yml
|
||||
name: IotHubUnathorizedException
|
||||
fullName: com.microsoft.azure.iot.service.exceptions.IotHubUnathorizedException
|
||||
type: Class
|
||||
summary: <p>Create unauthorized exception </p>
|
||||
syntax:
|
||||
content: public class IotHubUnathorizedException extends IotHubException
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_mechanism
|
||||
id: _authentication_mechanism
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_mechanism.AuthenticationMechanism(SymmetricKey)
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_mechanism.getSymmetricKey()
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_mechanism.yml
|
||||
langs:
|
||||
- java
|
||||
name: AuthenticationMechanism
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMechanism
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMechanism.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMechanism.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Authentication mechanism, used to store the device symmetric key. </p>
|
||||
syntax:
|
||||
content: public class AuthenticationMechanism
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_mechanism.AuthenticationMechanism(SymmetricKey)
|
||||
id: AuthenticationMechanism(SymmetricKey)
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_mechanism
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_mechanism.yml
|
||||
langs:
|
||||
- java
|
||||
name: AuthenticationMechanism(SymmetricKey symmetricKey)
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMechanism.AuthenticationMechanism(SymmetricKey symmetricKey)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMechanism.java
|
||||
startLine: 30
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Constructor for initialization. </p>
|
||||
syntax:
|
||||
content: public AuthenticationMechanism(SymmetricKey symmetricKey)
|
||||
parameters:
|
||||
- id: symmetricKey
|
||||
type: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_mechanism.getSymmetricKey()
|
||||
id: getSymmetricKey()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_mechanism
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_mechanism.yml
|
||||
langs:
|
||||
- java
|
||||
name: getSymmetricKey()
|
||||
fullName: SymmetricKey com.microsoft.azure.iot.service.sdk.AuthenticationMechanism.getSymmetricKey()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMechanism.java
|
||||
startLine: 22
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for symmetric key. </p>
|
||||
syntax:
|
||||
content: public SymmetricKey getSymmetricKey()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
description: <p>The symmetric key. </p>
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
parent: com.microsoft.azure.iot.service.auth
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
name: SymmetricKey
|
||||
fullName: com.microsoft.azure.iot.service.auth.SymmetricKey
|
||||
type: Class
|
||||
summary: <p>Store primary and secondary keys Provide function for key length validation </p>
|
||||
syntax:
|
||||
content: public class SymmetricKey
|
||||
|
|
@ -0,0 +1,152 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
id: _authentication_method
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.key()
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.policyName()
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.populate(IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.token()
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: AuthenticationMethod
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMethod
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMethod.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMethod.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Class used to abstract the different authentication methods used to use IoT Hub SDK. </p>
|
||||
syntax:
|
||||
content: public class AuthenticationMethod
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.key()
|
||||
id: key()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: key
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.AuthenticationMethod.key
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMethod.java
|
||||
startLine: 22
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Shared access policy key (if applies) </p>
|
||||
syntax:
|
||||
content: protected String key
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.policyName()
|
||||
id: policyName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: policyName
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.AuthenticationMethod.policyName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMethod.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Authentication policy name </p>
|
||||
syntax:
|
||||
content: protected String policyName
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.populate(IotHubConnectionString)
|
||||
id: populate(IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: populate(IotHubConnectionString iotHubConnectionStringBuilder)
|
||||
fullName: abstract IotHubConnectionString com.microsoft.azure.iot.service.sdk.AuthenticationMethod.populate(IotHubConnectionString iotHubConnectionStringBuilder)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMethod.java
|
||||
startLine: 39
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Abstract helper function to populate<programlisting><codeline><highlight class="normal">IotHubConnectionString<sp></sp></highlight></codeline></programlisting> class with proper authentication properties</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected abstract IotHubConnectionString populate(IotHubConnectionString iotHubConnectionStringBuilder)
|
||||
parameters:
|
||||
- id: iotHubConnectionStringBuilder
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> that is to be populated with the authentication properties. </p>
|
||||
return:
|
||||
type: 13c86962com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>An instance of <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> populated with the the authentication properties. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.token()
|
||||
id: token()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: token
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.AuthenticationMethod.token
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMethod.java
|
||||
startLine: 27
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Shared access policy token (if applies) </p>
|
||||
syntax:
|
||||
content: protected String token
|
||||
return:
|
||||
type: "26831127"
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 13c86962com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
spec.java:
|
||||
- name: 'abstract '
|
||||
fullName: 'abstract '
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
name: IotHubConnectionString
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyKey
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey
|
||||
type: Class
|
||||
summary: <p>Extend <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> class, provide getters for protected properties and implement populate function to set <xref href="com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key" data-throw-if-not-resolved="false"></xref> type policy on given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax:
|
||||
content: public class ServiceAuthenticationWithSharedAccessPolicyKey
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyToken
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken
|
||||
type: Class
|
||||
summary: <p>Extend <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> class, provide getters for protected properties and implement populate function to set <xref href="com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token" data-throw-if-not-resolved="false"></xref> type policy on given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax:
|
||||
content: public class ServiceAuthenticationWithSharedAccessPolicyToken
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
name: IotHubConnectionString
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString
|
||||
type: Class
|
||||
summary: <p>Expose all connections string properties and methods for user, device and connection string serialization. </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionString
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
id: _delivery_acknowledgement
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.Full()
|
||||
- com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.NegativeOnly()
|
||||
- com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.None()
|
||||
- com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.PositiveOnly()
|
||||
href: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeliveryAcknowledgement
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeliveryAcknowledgement
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeliveryAcknowledgement.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeliveryAcknowledgement.java
|
||||
startLine: 7
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public enum DeliveryAcknowledgement
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<DeliveryAcknowledgement>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.Full()
|
||||
id: Full()
|
||||
parent: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
href: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.yml
|
||||
langs:
|
||||
- java
|
||||
name: Full
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeliveryAcknowledgement.Full
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeliveryAcknowledgement.java
|
||||
startLine: 27
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>An acknowledgement is sent on delivery success or failure. </p>
|
||||
syntax:
|
||||
content: public Full
|
||||
- uid: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.NegativeOnly()
|
||||
id: NegativeOnly()
|
||||
parent: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
href: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.yml
|
||||
langs:
|
||||
- java
|
||||
name: NegativeOnly
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeliveryAcknowledgement.NegativeOnly
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeliveryAcknowledgement.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Acknowledgement is sent only if delivery fails. </p>
|
||||
syntax:
|
||||
content: public NegativeOnly
|
||||
- uid: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.None()
|
||||
id: None()
|
||||
parent: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
href: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.yml
|
||||
langs:
|
||||
- java
|
||||
name: None
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeliveryAcknowledgement.None
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeliveryAcknowledgement.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Acknowledgement is NOT sent on delivery or failure. </p>
|
||||
syntax:
|
||||
content: public None
|
||||
- uid: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.PositiveOnly()
|
||||
id: PositiveOnly()
|
||||
parent: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
href: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.yml
|
||||
langs:
|
||||
- java
|
||||
name: PositiveOnly
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeliveryAcknowledgement.PositiveOnly
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeliveryAcknowledgement.java
|
||||
startLine: 22
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Acknowledgement is sent only on delivery succeeds. </p>
|
||||
syntax:
|
||||
content: public PositiveOnly
|
||||
references: []
|
||||
|
|
@ -0,0 +1,812 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device
|
||||
id: _device
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._device.cloudToDeviceMessageCount()
|
||||
- com.microsoft.azure.iot.service.sdk._device.connectionState()
|
||||
- com.microsoft.azure.iot.service.sdk._device.connectionStateUpdatedTime()
|
||||
- com.microsoft.azure.iot.service.sdk._device.createFromId(String,DeviceStatus,SymmetricKey)
|
||||
- com.microsoft.azure.iot.service.sdk._device.Device(String,DeviceStatus,SymmetricKey)
|
||||
- com.microsoft.azure.iot.service.sdk._device.deviceId()
|
||||
- com.microsoft.azure.iot.service.sdk._device.encryptionMethod()
|
||||
- com.microsoft.azure.iot.service.sdk._device.eTag()
|
||||
- com.microsoft.azure.iot.service.sdk._device.generationId()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getCloudToDeviceMessageCount()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getConnectionState()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getConnectionStateUpdatedTime()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getDeviceId()
|
||||
- com.microsoft.azure.iot.service.sdk._device.geteTag()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getGenerationId()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getLastActivityTime()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getPrimaryKey()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getSecondaryKey()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getStatus()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getStatusReason()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getStatusUpdatedTime()
|
||||
- com.microsoft.azure.iot.service.sdk._device.getSymmetricKey()
|
||||
- com.microsoft.azure.iot.service.sdk._device.lastActivityTime()
|
||||
- com.microsoft.azure.iot.service.sdk._device.setForceUpdate(Boolean)
|
||||
- com.microsoft.azure.iot.service.sdk._device.setStatus(DeviceStatus)
|
||||
- com.microsoft.azure.iot.service.sdk._device.setSymmetricKey(SymmetricKey)
|
||||
- com.microsoft.azure.iot.service.sdk._device.status()
|
||||
- com.microsoft.azure.iot.service.sdk._device.statusReason()
|
||||
- com.microsoft.azure.iot.service.sdk._device.statusUpdatedTime()
|
||||
- com.microsoft.azure.iot.service.sdk._device.symmetricKey()
|
||||
- com.microsoft.azure.iot.service.sdk._device.utcTimeDefault()
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: Device
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Device
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 18
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>The <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class extends the <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class implementing constructors and serialization functionality. </p>
|
||||
syntax: &o1
|
||||
content: public class Device
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.cloudToDeviceMessageCount()
|
||||
id: cloudToDeviceMessageCount()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: cloudToDeviceMessageCount
|
||||
fullName: long com.microsoft.azure.iot.service.sdk.Device.cloudToDeviceMessageCount
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 304
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Number of messages received by the device </p>
|
||||
syntax:
|
||||
content: protected long cloudToDeviceMessageCount
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.connectionState()
|
||||
id: connectionState()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: connectionState
|
||||
fullName: DeviceConnectionState com.microsoft.azure.iot.service.sdk.Device.connectionState
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 259
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: '<p>Status of the device: {"connected" | "disconnected"} </p>'
|
||||
syntax:
|
||||
content: protected DeviceConnectionState connectionState
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._device_connection_state
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.connectionStateUpdatedTime()
|
||||
id: connectionStateUpdatedTime()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: connectionStateUpdatedTime
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.connectionStateUpdatedTime
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 274
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Datetime of last time the connection state was updated. </p>
|
||||
syntax:
|
||||
content: protected String connectionStateUpdatedTime
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.createFromId(String,DeviceStatus,SymmetricKey)
|
||||
id: createFromId(String,DeviceStatus,SymmetricKey)
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: createFromId(String deviceId, DeviceStatus status, SymmetricKey symmetricKey)
|
||||
fullName: static Device com.microsoft.azure.iot.service.sdk.Device.createFromId(String deviceId, DeviceStatus status, SymmetricKey symmetricKey)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Static create function Creates device object using the given name. If input device status and symmetric key are null then they will be auto generated.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static Device createFromId(String deviceId, DeviceStatus status, SymmetricKey symmetricKey)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>- String containing the device name </p>
|
||||
- id: status
|
||||
type: com.microsoft.azure.iot.service.sdk._device_status
|
||||
- id: symmetricKey
|
||||
type: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
description: <p>- <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> key. If parameter is null, then the key will be auto generated. </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._device
|
||||
description: >-
|
||||
<p>
|
||||
|
||||
<xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>This exception is thrown if<programlisting><codeline><highlight class="normal">deviceId<sp></sp></highlight></codeline></programlisting> is<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> or empty. </p>
|
||||
- type: 456eb9d1
|
||||
description: <p>This exception is thrown if the encryption method is not supported by the keyGenerator </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.Device(String,DeviceStatus,SymmetricKey)
|
||||
id: Device(String,DeviceStatus,SymmetricKey)
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: Device(String deviceId, DeviceStatus status, SymmetricKey symmetricKey)
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Device.Device(String deviceId, DeviceStatus status, SymmetricKey symmetricKey)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 58
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Create an <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> instance using the given device name</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected Device(String deviceId, DeviceStatus status, SymmetricKey symmetricKey)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>Name of the device (used as device id) </p>
|
||||
- id: status
|
||||
type: com.microsoft.azure.iot.service.sdk._device_status
|
||||
- id: symmetricKey
|
||||
type: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
description: <p>- <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> key. If parameter is null, then the key will be auto generated. </p>
|
||||
exceptions:
|
||||
- type: 456eb9d1
|
||||
description: <p>This exception is thrown if the encryption method is not supported by the keyGenerator </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.deviceId()
|
||||
id: deviceId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: deviceId
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.deviceId
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 107
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>
|
||||
|
||||
<xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars<itemizedlist><listitem><p>{'-', ':', '.', '+', '', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. </p></listitem></itemizedlist></p>
|
||||
syntax:
|
||||
content: protected String deviceId
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.encryptionMethod()
|
||||
id: encryptionMethod()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: encryptionMethod
|
||||
fullName: final String com.microsoft.azure.iot.service.sdk.Device.encryptionMethod
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected final String encryptionMethod= "AES"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.eTag()
|
||||
id: eTag()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: eTag
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.eTag
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 186
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>A string representing a weak ETAG version of this JSON description. This is a hash. </p>
|
||||
syntax:
|
||||
content: protected String eTag
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.generationId()
|
||||
id: generationId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: generationId
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.generationId
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 122
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>
|
||||
|
||||
<xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> generation Id </p>
|
||||
syntax:
|
||||
content: protected String generationId
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getCloudToDeviceMessageCount()
|
||||
id: getCloudToDeviceMessageCount()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getCloudToDeviceMessageCount()
|
||||
fullName: long com.microsoft.azure.iot.service.sdk.Device.getCloudToDeviceMessageCount()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 311
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for cloud to device message count</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public long getCloudToDeviceMessageCount()
|
||||
return:
|
||||
type: 0364520f
|
||||
description: <p>The string containing the time when the cloudToDeviceMessageCount parameter was updated </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getConnectionState()
|
||||
id: getConnectionState()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getConnectionState()
|
||||
fullName: DeviceConnectionState com.microsoft.azure.iot.service.sdk.Device.getConnectionState()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 266
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for connection state</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public DeviceConnectionState getConnectionState()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._device_connection_state
|
||||
description: <p>The connectionState string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getConnectionStateUpdatedTime()
|
||||
id: getConnectionStateUpdatedTime()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getConnectionStateUpdatedTime()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.getConnectionStateUpdatedTime()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 281
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for connection state updated time</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getConnectionStateUpdatedTime()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The string containing the time when the connectionState parameter was updated </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getDeviceId()
|
||||
id: getDeviceId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getDeviceId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.getDeviceId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 114
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for device name</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getDeviceId()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The deviceId string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.geteTag()
|
||||
id: geteTag()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: geteTag()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.geteTag()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 193
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for eTag</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String geteTag()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The eTag string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getGenerationId()
|
||||
id: getGenerationId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getGenerationId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.getGenerationId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 129
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for GenerationId</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getGenerationId()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The generationId string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getLastActivityTime()
|
||||
id: getLastActivityTime()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getLastActivityTime()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.getLastActivityTime()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 296
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for last activity time</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getLastActivityTime()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The string containing the time when the lastActivity parameter was updated </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getPrimaryKey()
|
||||
id: getPrimaryKey()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPrimaryKey()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.getPrimaryKey()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 166
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for PrimaryKey part of the SymmetricKey</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getPrimaryKey()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The primaryKey string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getSecondaryKey()
|
||||
id: getSecondaryKey()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getSecondaryKey()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.getSecondaryKey()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 176
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for SecondaryKey part of the SymmetricKey</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getSecondaryKey()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The secondaryKey string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getStatus()
|
||||
id: getStatus()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStatus()
|
||||
fullName: DeviceStatus com.microsoft.azure.iot.service.sdk.Device.getStatus()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 209
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for <xref href="com.microsoft.azure.iot.service.sdk._device_status" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
syntax:
|
||||
content: public DeviceStatus getStatus()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._device_status
|
||||
description: <p>The deviceStatus object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getStatusReason()
|
||||
id: getStatusReason()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStatusReason()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.getStatusReason()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 235
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for status reason</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getStatusReason()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The statusReason string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getStatusUpdatedTime()
|
||||
id: getStatusUpdatedTime()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStatusUpdatedTime()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.getStatusUpdatedTime()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 250
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for status updated time string</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getStatusUpdatedTime()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The string containing the time when the statusUpdated parameter was updated </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.getSymmetricKey()
|
||||
id: getSymmetricKey()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getSymmetricKey()
|
||||
fullName: SymmetricKey com.microsoft.azure.iot.service.sdk.Device.getSymmetricKey()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 146
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for SymmetricKey object</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public SymmetricKey getSymmetricKey()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
description: <p>The symmetricKey object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.lastActivityTime()
|
||||
id: lastActivityTime()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: lastActivityTime
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.lastActivityTime
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 289
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Datetime of last time the device authenticated, received, or sent a message. </p>
|
||||
syntax:
|
||||
content: protected String lastActivityTime
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.setForceUpdate(Boolean)
|
||||
id: setForceUpdate(Boolean)
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: setForceUpdate(Boolean forceUpdate)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Device.setForceUpdate(Boolean forceUpdate)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 326
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Setter for force update boolean</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setForceUpdate(Boolean forceUpdate)
|
||||
parameters:
|
||||
- id: forceUpdate
|
||||
type: 866c2227
|
||||
description: <p>- Boolean controlling if the update should be forced or not </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.setStatus(DeviceStatus)
|
||||
id: setStatus(DeviceStatus)
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: setStatus(DeviceStatus status)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Device.setStatus(DeviceStatus status)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 219
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Setter for <xref href="com.microsoft.azure.iot.service.sdk._device_status" data-throw-if-not-resolved="false"></xref> object</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setStatus(DeviceStatus status)
|
||||
parameters:
|
||||
- id: status
|
||||
type: com.microsoft.azure.iot.service.sdk._device_status
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.setSymmetricKey(SymmetricKey)
|
||||
id: setSymmetricKey(SymmetricKey)
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: setSymmetricKey(SymmetricKey symmetricKey)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Device.setSymmetricKey(SymmetricKey symmetricKey)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 156
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Setter for SymmetricKey object</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setSymmetricKey(SymmetricKey symmetricKey)
|
||||
parameters:
|
||||
- id: symmetricKey
|
||||
type: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.status()
|
||||
id: status()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: status
|
||||
fullName: DeviceStatus com.microsoft.azure.iot.service.sdk.Device.status
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 203
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>"Enabled", "Disabled". If "Enabled", this device is authorized to connect. If "Disabled" this device cannot receive or send messages, and statusReason must be set. </p>
|
||||
syntax:
|
||||
content: protected DeviceStatus status
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._device_status
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.statusReason()
|
||||
id: statusReason()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: statusReason
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.statusReason
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 228
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>A 128 char long string storing the reason of suspension. (all UTF-8 chars allowed). </p>
|
||||
syntax:
|
||||
content: protected String statusReason
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.statusUpdatedTime()
|
||||
id: statusUpdatedTime()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: statusUpdatedTime
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Device.statusUpdatedTime
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 243
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Datetime of last time the state was updated. </p>
|
||||
syntax:
|
||||
content: protected String statusUpdatedTime
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.symmetricKey()
|
||||
id: symmetricKey()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: symmetricKey
|
||||
fullName: transient SymmetricKey com.microsoft.azure.iot.service.sdk.Device.symmetricKey
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 139
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Symmetric key to be used to authorize this device. This can also be an array (up to 2) of keys to do key rollover. Format (same as device Id). </p>
|
||||
syntax:
|
||||
content: protected transient SymmetricKey symmetricKey
|
||||
return:
|
||||
type: 1e96ff01com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device.utcTimeDefault()
|
||||
id: utcTimeDefault()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
langs:
|
||||
- java
|
||||
name: utcTimeDefault
|
||||
fullName: final String com.microsoft.azure.iot.service.sdk.Device.utcTimeDefault
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Device.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected final String utcTimeDefault= "0001-01-01T00:00:00"
|
||||
return:
|
||||
type: 3d93591e
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 1e96ff01com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
spec.java:
|
||||
- name: 'transient '
|
||||
fullName: 'transient '
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
name: SymmetricKey
|
||||
fullName: com.microsoft.azure.iot.service.auth.SymmetricKey
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: 456eb9d1
|
||||
spec.java:
|
||||
- name: NoSuchAlgorithmException
|
||||
fullName: NoSuchAlgorithmException
|
||||
- uid: 866c2227
|
||||
spec.java:
|
||||
- name: Boolean
|
||||
fullName: Boolean
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
name: Device
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Device
|
||||
type: Class
|
||||
summary: <p>The <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class extends the <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class implementing constructors and serialization functionality. </p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iot.service.auth._symmetric_key
|
||||
parent: com.microsoft.azure.iot.service.auth
|
||||
href: com.microsoft.azure.iot.service.auth._symmetric_key.yml
|
||||
name: SymmetricKey
|
||||
fullName: com.microsoft.azure.iot.service.auth.SymmetricKey
|
||||
type: Class
|
||||
summary: <p>Store primary and secondary keys Provide function for key length validation </p>
|
||||
syntax:
|
||||
content: public class SymmetricKey
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_status
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device_status.yml
|
||||
name: DeviceStatus
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceStatus
|
||||
type: Enum
|
||||
summary: <p>Enum for device status </p>
|
||||
syntax:
|
||||
content: public enum DeviceStatus
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_connection_state
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device_connection_state.yml
|
||||
name: DeviceConnectionState
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceConnectionState
|
||||
type: Enum
|
||||
summary: <p>Enum for device connection state </p>
|
||||
syntax:
|
||||
content: public enum DeviceConnectionState
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_connection_state
|
||||
id: _device_connection_state
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._device_connection_state.Connected()
|
||||
- com.microsoft.azure.iot.service.sdk._device_connection_state.Disconnected()
|
||||
href: com.microsoft.azure.iot.service.sdk._device_connection_state.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceConnectionState
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceConnectionState
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceConnectionState.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceConnectionState.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Enum for device connection state </p>
|
||||
syntax:
|
||||
content: public enum DeviceConnectionState
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<DeviceConnectionState>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_connection_state.Connected()
|
||||
id: Connected()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device_connection_state
|
||||
href: com.microsoft.azure.iot.service.sdk._device_connection_state.yml
|
||||
langs:
|
||||
- java
|
||||
name: Connected
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceConnectionState.Connected
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceConnectionState.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Connected
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_connection_state.Disconnected()
|
||||
id: Disconnected()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device_connection_state
|
||||
href: com.microsoft.azure.iot.service.sdk._device_connection_state.yml
|
||||
langs:
|
||||
- java
|
||||
name: Disconnected
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceConnectionState.Disconnected
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceConnectionState.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Disconnected
|
||||
references: []
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_deserializer
|
||||
id: _device_deserializer
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._device_deserializer.deserialize(JsonElement,Type,JsonDeserializationContext)
|
||||
href: com.microsoft.azure.iot.service.sdk._device_deserializer.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceDeserializer
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceDeserializer
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceDeserializer.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceDeserializer.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public class DeviceDeserializer
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- com.fasterxml.jackson.databind.JsonDeserializer<Device>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_deserializer.deserialize(JsonElement,Type,JsonDeserializationContext)
|
||||
id: deserialize(JsonElement,Type,JsonDeserializationContext)
|
||||
parent: com.microsoft.azure.iot.service.sdk._device_deserializer
|
||||
href: com.microsoft.azure.iot.service.sdk._device_deserializer.yml
|
||||
langs:
|
||||
- java
|
||||
name: deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext)
|
||||
fullName: Device com.microsoft.azure.iot.service.sdk.DeviceDeserializer.deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceDeserializer.java
|
||||
startLine: 18
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Device deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext)
|
||||
parameters:
|
||||
- id: jsonElement
|
||||
type: 8585b2e7
|
||||
- id: type
|
||||
type: 7727faa1
|
||||
- id: jsonDeserializationContext
|
||||
type: 142b21e8
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._device
|
||||
references:
|
||||
- uid: 8585b2e7
|
||||
spec.java:
|
||||
- name: JsonElement
|
||||
fullName: JsonElement
|
||||
- uid: 7727faa1
|
||||
spec.java:
|
||||
- name: Type
|
||||
fullName: Type
|
||||
- uid: 142b21e8
|
||||
spec.java:
|
||||
- name: JsonDeserializationContext
|
||||
fullName: JsonDeserializationContext
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
name: Device
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Device
|
||||
type: Class
|
||||
summary: <p>The <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class extends the <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class implementing constructors and serialization functionality. </p>
|
||||
syntax:
|
||||
content: public class Device
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_serializer
|
||||
id: _device_serializer
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._device_serializer.serialize(Device,Type,JsonSerializationContext)
|
||||
href: com.microsoft.azure.iot.service.sdk._device_serializer.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceSerializer
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceSerializer
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceSerializer.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceSerializer.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public class DeviceSerializer
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- com.fasterxml.jackson.databind.JsonSerializer<Device>
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.sdk._device_serializer.gson()
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_serializer.serialize(Device,Type,JsonSerializationContext)
|
||||
id: serialize(Device,Type,JsonSerializationContext)
|
||||
parent: com.microsoft.azure.iot.service.sdk._device_serializer
|
||||
href: com.microsoft.azure.iot.service.sdk._device_serializer.yml
|
||||
langs:
|
||||
- java
|
||||
name: serialize(Device device, Type type, JsonSerializationContext jsonSerializationContext)
|
||||
fullName: JsonElement com.microsoft.azure.iot.service.sdk.DeviceSerializer.serialize(Device device, Type type, JsonSerializationContext jsonSerializationContext)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceSerializer.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public JsonElement serialize(Device device, Type type, JsonSerializationContext jsonSerializationContext)
|
||||
parameters:
|
||||
- id: device
|
||||
type: com.microsoft.azure.iot.service.sdk._device
|
||||
- id: type
|
||||
type: 7727faa1
|
||||
- id: jsonSerializationContext
|
||||
type: a8b4942d
|
||||
return:
|
||||
type: 8585b2e7
|
||||
references:
|
||||
- uid: 7727faa1
|
||||
spec.java:
|
||||
- name: Type
|
||||
fullName: Type
|
||||
- uid: a8b4942d
|
||||
spec.java:
|
||||
- name: JsonSerializationContext
|
||||
fullName: JsonSerializationContext
|
||||
- uid: 8585b2e7
|
||||
spec.java:
|
||||
- name: JsonElement
|
||||
fullName: JsonElement
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_serializer.gson()
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
name: Device
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Device
|
||||
type: Class
|
||||
summary: <p>The <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class extends the <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class implementing constructors and serialization functionality. </p>
|
||||
syntax:
|
||||
content: public class Device
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_status
|
||||
id: _device_status
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._device_status.SerializedName()
|
||||
href: com.microsoft.azure.iot.service.sdk._device_status.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceStatus
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceStatus
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceStatus.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceStatus.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Enum for device status </p>
|
||||
syntax:
|
||||
content: public enum DeviceStatus
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<DeviceStatus>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_status.SerializedName()
|
||||
id: SerializedName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._device_status
|
||||
href: com.microsoft.azure.iot.service.sdk._device_status.yml
|
||||
langs:
|
||||
- java
|
||||
name: SerializedName
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceStatus.SerializedName
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/DeviceStatus.java
|
||||
startLine: 14
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: >-
|
||||
public SerializedName=("enabled")
|
||||
Enabled
|
||||
references: []
|
||||
|
|
@ -0,0 +1,365 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
id: _export_import_device
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.equals(Object)
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.getAuthentication()
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.getETag()
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.getId()
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.getImportMode()
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.getStatus()
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.getStatusReason()
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.hashCode()
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.setAuthentication(AuthenticationMechanism)
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.setETag(String)
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.setId(String)
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.setImportMode(com.microsoft.azure.iot.service.sdk.ImportMode)
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.setStatus(DeviceStatus)
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device.setStatusReason(String)
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: ExportImportDevice
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ExportImportDevice
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public class ExportImportDevice
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.equals(Object)
|
||||
id: equals(Object)
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: equals(Object other)
|
||||
fullName: boolean com.microsoft.azure.iot.service.sdk.ExportImportDevice.equals(Object other)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 141
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public boolean equals(Object other)
|
||||
parameters:
|
||||
- id: other
|
||||
type: "79317049"
|
||||
return:
|
||||
type: 4fc6e284
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.getAuthentication()
|
||||
id: getAuthentication()
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getAuthentication()
|
||||
fullName: AuthenticationMechanism com.microsoft.azure.iot.service.sdk.ExportImportDevice.getAuthentication()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 126
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for device authentication mechanism. </p>
|
||||
syntax:
|
||||
content: public AuthenticationMechanism getAuthentication()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._authentication_mechanism
|
||||
description: <p>The device authentication mechanism. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.getETag()
|
||||
id: getETag()
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getETag()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.ExportImportDevice.getETag()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 54
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for device eTag. </p>
|
||||
syntax:
|
||||
content: public String getETag()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The device eTag. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.getId()
|
||||
id: getId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.ExportImportDevice.getId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 45
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for device id. </p>
|
||||
syntax:
|
||||
content: public String getId()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The device id. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.getImportMode()
|
||||
id: getImportMode()
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getImportMode()
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ImportMode com.microsoft.azure.iot.service.sdk.ExportImportDevice.getImportMode()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 72
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for device import mode. </p>
|
||||
syntax:
|
||||
content: public com.microsoft.azure.iot.service.sdk.ImportMode getImportMode()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._import_mode
|
||||
description: <p>The device import mode. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.getStatus()
|
||||
id: getStatus()
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStatus()
|
||||
fullName: DeviceStatus com.microsoft.azure.iot.service.sdk.ExportImportDevice.getStatus()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 90
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for device status. </p>
|
||||
syntax:
|
||||
content: public DeviceStatus getStatus()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._device_status
|
||||
description: <p>The device status. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.getStatusReason()
|
||||
id: getStatusReason()
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStatusReason()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.ExportImportDevice.getStatusReason()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 108
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for device status reason. </p>
|
||||
syntax:
|
||||
content: public String getStatusReason()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The device status reason. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.hashCode()
|
||||
id: hashCode()
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: hashCode()
|
||||
fullName: int com.microsoft.azure.iot.service.sdk.ExportImportDevice.hashCode()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 170
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public int hashCode()
|
||||
return:
|
||||
type: f75371fa
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.setAuthentication(AuthenticationMechanism)
|
||||
id: setAuthentication(AuthenticationMechanism)
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: setAuthentication(AuthenticationMechanism authentication)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ExportImportDevice.setAuthentication(AuthenticationMechanism authentication)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 135
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for device authentication mechanism. </p>
|
||||
syntax:
|
||||
content: public void setAuthentication(AuthenticationMechanism authentication)
|
||||
parameters:
|
||||
- id: authentication
|
||||
type: com.microsoft.azure.iot.service.sdk._authentication_mechanism
|
||||
description: <p>The device authentication mechanism. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.setETag(String)
|
||||
id: setETag(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: setETag(String ETag)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ExportImportDevice.setETag(String ETag)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 63
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for device eTag. </p>
|
||||
syntax:
|
||||
content: public void setETag(String ETag)
|
||||
parameters:
|
||||
- id: ETag
|
||||
type: "26831127"
|
||||
description: <p>The device eTag. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.setId(String)
|
||||
id: setId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: setId(String id)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ExportImportDevice.setId(String id)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 36
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for device id. </p>
|
||||
syntax:
|
||||
content: public void setId(String id)
|
||||
parameters:
|
||||
- id: id
|
||||
type: "26831127"
|
||||
description: <p>The device id. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.setImportMode(com.microsoft.azure.iot.service.sdk.ImportMode)
|
||||
id: ImportMode)
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: setImportMode(com.microsoft.azure.iot.service.sdk.ImportMode importMode)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ExportImportDevice.setImportMode(com.microsoft.azure.iot.service.sdk.ImportMode importMode)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 81
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for device import mode. </p>
|
||||
syntax:
|
||||
content: public void setImportMode(com.microsoft.azure.iot.service.sdk.ImportMode importMode)
|
||||
parameters:
|
||||
- id: importMode
|
||||
type: com.microsoft.azure.iot.service.sdk._import_mode
|
||||
description: <p>The device import mode. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.setStatus(DeviceStatus)
|
||||
id: setStatus(DeviceStatus)
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: setStatus(DeviceStatus status)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ExportImportDevice.setStatus(DeviceStatus status)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 99
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for device status. </p>
|
||||
syntax:
|
||||
content: public void setStatus(DeviceStatus status)
|
||||
parameters:
|
||||
- id: status
|
||||
type: com.microsoft.azure.iot.service.sdk._device_status
|
||||
description: <p>The device status. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device.setStatusReason(String)
|
||||
id: setStatusReason(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
langs:
|
||||
- java
|
||||
name: setStatusReason(String statusReason)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ExportImportDevice.setStatusReason(String statusReason)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ExportImportDevice.java
|
||||
startLine: 117
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for device status reason. </p>
|
||||
syntax:
|
||||
content: public void setStatusReason(String statusReason)
|
||||
parameters:
|
||||
- id: statusReason
|
||||
type: "26831127"
|
||||
description: <p>The device status reason. </p>
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: "79317049"
|
||||
spec.java:
|
||||
- name: Object
|
||||
fullName: Object
|
||||
- uid: 4fc6e284
|
||||
spec.java:
|
||||
- name: boolean
|
||||
fullName: boolean
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
- uid: com.microsoft.azure.iot.service.sdk._import_mode
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._import_mode.yml
|
||||
name: ImportMode
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ImportMode
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum ImportMode
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_status
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device_status.yml
|
||||
name: DeviceStatus
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceStatus
|
||||
type: Enum
|
||||
summary: <p>Enum for device status </p>
|
||||
syntax:
|
||||
content: public enum DeviceStatus
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_mechanism
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_mechanism.yml
|
||||
name: AuthenticationMechanism
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMechanism
|
||||
type: Class
|
||||
summary: <p>Authentication mechanism, used to store the device symmetric key. </p>
|
||||
syntax:
|
||||
content: public class AuthenticationMechanism
|
||||
|
|
@ -0,0 +1,208 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
id: _feedback_batch
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch.getEnqueuedTimeUtc()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch.getLockToken()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch.getRecords()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch.getUserId()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch.setEnqueuedTimeUtc(Instant)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch.setLockToken(String)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch.setRecords(ArrayList<FeedbackRecord>)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch.setUserId(String)
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
langs:
|
||||
- java
|
||||
name: FeedbackBatch
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatch
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
startLine: 14
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Data structure for feedback messages received in Json array Provide getters and setters for batch properties and messages </p>
|
||||
syntax:
|
||||
content: public class FeedbackBatch
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch.getEnqueuedTimeUtc()
|
||||
id: getEnqueuedTimeUtc()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
langs:
|
||||
- java
|
||||
name: getEnqueuedTimeUtc()
|
||||
fullName: Instant com.microsoft.azure.iot.service.sdk.FeedbackBatch.getEnqueuedTimeUtc()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
startLine: 18
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Instant getEnqueuedTimeUtc()
|
||||
return:
|
||||
type: 328f8254
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch.getLockToken()
|
||||
id: getLockToken()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
langs:
|
||||
- java
|
||||
name: getLockToken()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.FeedbackBatch.getLockToken()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
startLine: 42
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getLockToken()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch.getRecords()
|
||||
id: getRecords()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
langs:
|
||||
- java
|
||||
name: getRecords()
|
||||
fullName: ArrayList<FeedbackRecord> com.microsoft.azure.iot.service.sdk.FeedbackBatch.getRecords()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
startLine: 54
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public ArrayList<FeedbackRecord> getRecords()
|
||||
return:
|
||||
type: 573b1e0bcom.microsoft.azure.iot.service.sdk._feedback_recorda08ddfce
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch.getUserId()
|
||||
id: getUserId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
langs:
|
||||
- java
|
||||
name: getUserId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.FeedbackBatch.getUserId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
startLine: 30
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getUserId()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch.setEnqueuedTimeUtc(Instant)
|
||||
id: setEnqueuedTimeUtc(Instant)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
langs:
|
||||
- java
|
||||
name: setEnqueuedTimeUtc(Instant enqueuedTimeUtc)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackBatch.setEnqueuedTimeUtc(Instant enqueuedTimeUtc)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
startLine: 23
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setEnqueuedTimeUtc(Instant enqueuedTimeUtc)
|
||||
parameters:
|
||||
- id: enqueuedTimeUtc
|
||||
type: 328f8254
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch.setLockToken(String)
|
||||
id: setLockToken(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
langs:
|
||||
- java
|
||||
name: setLockToken(String lockToken)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackBatch.setLockToken(String lockToken)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
startLine: 47
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setLockToken(String lockToken)
|
||||
parameters:
|
||||
- id: lockToken
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch.setRecords(ArrayList<FeedbackRecord>)
|
||||
id: setRecords(ArrayList<FeedbackRecord>)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
langs:
|
||||
- java
|
||||
name: setRecords(ArrayList<FeedbackRecord> records)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackBatch.setRecords(ArrayList<FeedbackRecord> records)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
startLine: 59
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setRecords(ArrayList<FeedbackRecord> records)
|
||||
parameters:
|
||||
- id: records
|
||||
type: 573b1e0bcom.microsoft.azure.iot.service.sdk._feedback_recorda08ddfce
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch.setUserId(String)
|
||||
id: setUserId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
langs:
|
||||
- java
|
||||
name: setUserId(String userId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackBatch.setUserId(String userId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatch.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setUserId(String userId)
|
||||
parameters:
|
||||
- id: userId
|
||||
type: "26831127"
|
||||
references:
|
||||
- uid: 328f8254
|
||||
spec.java:
|
||||
- name: Instant
|
||||
fullName: Instant
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 573b1e0bcom.microsoft.azure.iot.service.sdk._feedback_recorda08ddfce
|
||||
spec.java:
|
||||
- name: ArrayList<
|
||||
fullName: ArrayList<
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
name: FeedbackRecord
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackRecord
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
- name: '>'
|
||||
fullName: '>'
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
name: FeedbackRecord
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackRecord
|
||||
type: Class
|
||||
summary: <p>Data structure for feedback record received Provide getters and setters for feedback record batch properties </p>
|
||||
syntax:
|
||||
content: public class FeedbackRecord
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch_message
|
||||
id: _feedback_batch_message
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch_message.parse(String)
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: FeedbackBatchMessage
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatchMessage
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatchMessage.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatchMessage.java
|
||||
startLine: 18
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Provide static function to parse Json string to <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax:
|
||||
content: public class FeedbackBatchMessage
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch_message.parse(String)
|
||||
id: parse(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_batch_message
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: parse(String jsonString)
|
||||
fullName: static FeedbackBatch com.microsoft.azure.iot.service.sdk.FeedbackBatchMessage.parse(String jsonString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackBatchMessage.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Parse received Json and create <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> object</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static FeedbackBatch parse(String jsonString)
|
||||
parameters:
|
||||
- id: jsonString
|
||||
type: "26831127"
|
||||
description: <p>Json string to parse </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
description: <p>The created <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref></p>
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
name: FeedbackBatch
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatch
|
||||
type: Class
|
||||
summary: <p>Data structure for feedback messages received in Json array Provide getters and setters for batch properties and messages </p>
|
||||
syntax:
|
||||
content: public class FeedbackBatch
|
||||
|
|
@ -0,0 +1,390 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
id: _feedback_receiver
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver.close()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver.closeAsync()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver.FeedbackReceiver(String,String,String,IotHubServiceClientProtocol,String)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver.open()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver.openAsync()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver.receive()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver.receive(long)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver.receiveAsync()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver.receiveAsync(long)
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: FeedbackReceiver
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackReceiver
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 18
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>
|
||||
|
||||
<xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver" data-throw-if-not-resolved="false"></xref> is a specialized receiver whose ReceiveAsync method returns a <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> instead of a <xref href="com.microsoft.azure.iot.service.sdk._message" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
syntax: &o4
|
||||
content: public class FeedbackReceiver extends Receiver
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- com.microsoft.azure.iot.service.sdk._receiver
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.close()
|
||||
id: close()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackReceiver.close()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 81
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Close AmqpReceive object</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o2
|
||||
content: public void close()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the input AmqpReceive object is null </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.closeAsync()
|
||||
id: closeAsync()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: closeAsync()
|
||||
fullName: CompletableFuture<Void> com.microsoft.azure.iot.service.sdk.FeedbackReceiver.closeAsync()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 152
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Async wrapper for <xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver.close()" data-throw-if-not-resolved="false"></xref> operation</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public CompletableFuture<Void> closeAsync()
|
||||
return:
|
||||
type: db03ee24
|
||||
description: <p>The future object for the requested operation </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.FeedbackReceiver(String,String,String,IotHubServiceClientProtocol,String)
|
||||
id: FeedbackReceiver(String,String,String,IotHubServiceClientProtocol,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, String deviceId)
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackReceiver.FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, String deviceId)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Constructor to verify initialization parameters Create instance of AmqpReceive</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, String deviceId)
|
||||
parameters:
|
||||
- id: hostName
|
||||
type: "26831127"
|
||||
description: <p>The iot hub host name </p>
|
||||
- id: userName
|
||||
type: "26831127"
|
||||
description: <p>The iot hub user name </p>
|
||||
- id: sasToken
|
||||
type: "26831127"
|
||||
description: <p>The iot hub SAS token for the given device </p>
|
||||
- id: iotHubServiceClientProtocol
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>The device id </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.open()
|
||||
id: open()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackReceiver.open()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 65
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Open AmqpReceive object</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o1
|
||||
content: public void open()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the input AmqpReceive object is null </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.openAsync()
|
||||
id: openAsync()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: openAsync()
|
||||
fullName: CompletableFuture<Void> com.microsoft.azure.iot.service.sdk.FeedbackReceiver.openAsync()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 129
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Async wrapper for <xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver.open()" data-throw-if-not-resolved="false"></xref> operation</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public CompletableFuture<Void> openAsync()
|
||||
return:
|
||||
type: db03ee24
|
||||
description: <p>The future object for the requested operation </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.receive()
|
||||
id: receive()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: receive()
|
||||
fullName: FeedbackBatch com.microsoft.azure.iot.service.sdk.FeedbackReceiver.receive()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 99
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Receive <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> with default timeout</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o3
|
||||
content: public FeedbackBatch receive()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
description: <p>The received <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the input AmqpReceive object is null </p>
|
||||
- type: 8256ba40
|
||||
description: <p>This exception is thrown if the receive process has been interrupted </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.receive(long)
|
||||
id: receive(long)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: receive(long timeoutMs)
|
||||
fullName: FeedbackBatch com.microsoft.azure.iot.service.sdk.FeedbackReceiver.receive(long timeoutMs)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 112
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Receive <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> with specific timeout </p>
|
||||
syntax:
|
||||
content: public FeedbackBatch receive(long timeoutMs)
|
||||
parameters:
|
||||
- id: timeoutMs
|
||||
type: 0364520f
|
||||
description: <p>The timeout in milliseconds </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
description: <p>The received <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the input AmqpReceive object is null </p>
|
||||
- type: 8256ba40
|
||||
description: <p>This exception is thrown if the receive process has been interrupted </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.receiveAsync()
|
||||
id: receiveAsync()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: receiveAsync()
|
||||
fullName: CompletableFuture<FeedbackBatch> com.microsoft.azure.iot.service.sdk.FeedbackReceiver.receiveAsync()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 175
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Async wrapper for <xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver.receive()" data-throw-if-not-resolved="false"></xref> operation with default timeout</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public CompletableFuture<FeedbackBatch> receiveAsync()
|
||||
return:
|
||||
type: 9cdf14d0com.microsoft.azure.iot.service.sdk._feedback_batcha08ddfce
|
||||
description: <p>The future object for the requested operation </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.receiveAsync(long)
|
||||
id: receiveAsync(long)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: receiveAsync(long timeoutMs)
|
||||
fullName: CompletableFuture<FeedbackBatch> com.microsoft.azure.iot.service.sdk.FeedbackReceiver.receiveAsync(long timeoutMs)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackReceiver.java
|
||||
startLine: 187
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Async wrapper for <xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver.receive()" data-throw-if-not-resolved="false"></xref> operation with specific timeout</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public CompletableFuture<FeedbackBatch> receiveAsync(long timeoutMs)
|
||||
parameters:
|
||||
- id: timeoutMs
|
||||
type: 0364520f
|
||||
return:
|
||||
type: 9cdf14d0com.microsoft.azure.iot.service.sdk._feedback_batcha08ddfce
|
||||
description: <p>The future object for the requested operation </p>
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: 8256ba40
|
||||
spec.java:
|
||||
- name: InterruptedException
|
||||
fullName: InterruptedException
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: db03ee24
|
||||
spec.java:
|
||||
- name: CompletableFuture<Void>
|
||||
fullName: CompletableFuture<Void>
|
||||
- uid: 9cdf14d0com.microsoft.azure.iot.service.sdk._feedback_batcha08ddfce
|
||||
spec.java:
|
||||
- name: CompletableFuture<
|
||||
fullName: CompletableFuture<
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
name: FeedbackBatch
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
- name: '>'
|
||||
fullName: '>'
|
||||
- uid: com.microsoft.azure.iot.service.sdk._receiver
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._receiver.yml
|
||||
name: Receiver
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Receiver
|
||||
type: Class
|
||||
summary: "<p>A receiver is a class abstracting the methods to receive messages, in order to use it for multiple endpoints, e.g. feedback endpoint, “alertsâ€\x9D (i.e. D2C). </p>"
|
||||
syntax:
|
||||
content: public class Receiver
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
name: AmqpReceive
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpReceive
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close methods and feedback received event. </p>
|
||||
syntax:
|
||||
content: public class AmqpReceive implements AmqpFeedbackReceivedEvent
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
type: Enum
|
||||
summary: <p>The application-layer protocol used by the service client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubServiceClientProtocol
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
name: FeedbackBatch
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatch
|
||||
type: Class
|
||||
summary: <p>Data structure for feedback messages received in Json array Provide getters and setters for batch properties and messages </p>
|
||||
syntax:
|
||||
content: public class FeedbackBatch
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.open()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackReceiver.open()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Open AmqpReceive object</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.close()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackReceiver.close()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Close AmqpReceive object</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o2
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver.receive()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
name: receive()
|
||||
fullName: FeedbackBatch com.microsoft.azure.iot.service.sdk.FeedbackReceiver.receive()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Receive <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> with default timeout</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o3
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
name: FeedbackReceiver
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackReceiver
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>
|
||||
|
||||
<xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver" data-throw-if-not-resolved="false"></xref> is a specialized receiver whose ReceiveAsync method returns a <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> instead of a <xref href="com.microsoft.azure.iot.service.sdk._message" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
syntax: *o4
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message
|
||||
type: Class
|
||||
summary: <p>IotHub specific message container </p>
|
||||
syntax:
|
||||
content: public class Message
|
||||
|
|
@ -0,0 +1,315 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
id: _feedback_record
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.getCorrelationId()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.getDescription()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.getDeviceGenerationId()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.getDeviceId()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.getEnqueuedTimeUtc()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.getOriginalMessageId()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.getStatusCode()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.setCorrelationId(String)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.setDescription(String)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.setDeviceGenerationId(String)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.setDeviceId(String)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.setEnqueuedTimeUtc(Instant)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.setOriginalMessageId(String)
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record.setStatusCode(FeedbackStatusCode)
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: FeedbackRecord
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackRecord
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Data structure for feedback record received Provide getters and setters for feedback record batch properties </p>
|
||||
syntax:
|
||||
content: public class FeedbackRecord
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.getCorrelationId()
|
||||
id: getCorrelationId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: getCorrelationId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.FeedbackRecord.getCorrelationId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 41
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getCorrelationId()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.getDescription()
|
||||
id: getDescription()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: getDescription()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.FeedbackRecord.getDescription()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 65
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getDescription()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.getDeviceGenerationId()
|
||||
id: getDeviceGenerationId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: getDeviceGenerationId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.FeedbackRecord.getDeviceGenerationId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 77
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getDeviceGenerationId()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.getDeviceId()
|
||||
id: getDeviceId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: getDeviceId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.FeedbackRecord.getDeviceId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 89
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getDeviceId()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.getEnqueuedTimeUtc()
|
||||
id: getEnqueuedTimeUtc()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: getEnqueuedTimeUtc()
|
||||
fullName: Instant com.microsoft.azure.iot.service.sdk.FeedbackRecord.getEnqueuedTimeUtc()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Instant getEnqueuedTimeUtc()
|
||||
return:
|
||||
type: 328f8254
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.getOriginalMessageId()
|
||||
id: getOriginalMessageId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: getOriginalMessageId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.FeedbackRecord.getOriginalMessageId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 29
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getOriginalMessageId()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.getStatusCode()
|
||||
id: getStatusCode()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStatusCode()
|
||||
fullName: FeedbackStatusCode com.microsoft.azure.iot.service.sdk.FeedbackRecord.getStatusCode()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 53
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public FeedbackStatusCode getStatusCode()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.setCorrelationId(String)
|
||||
id: setCorrelationId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: setCorrelationId(String correlationId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackRecord.setCorrelationId(String correlationId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 46
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setCorrelationId(String correlationId)
|
||||
parameters:
|
||||
- id: correlationId
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.setDescription(String)
|
||||
id: setDescription(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: setDescription(String description)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackRecord.setDescription(String description)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 70
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setDescription(String description)
|
||||
parameters:
|
||||
- id: description
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.setDeviceGenerationId(String)
|
||||
id: setDeviceGenerationId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: setDeviceGenerationId(String deviceGenerationId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackRecord.setDeviceGenerationId(String deviceGenerationId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 82
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setDeviceGenerationId(String deviceGenerationId)
|
||||
parameters:
|
||||
- id: deviceGenerationId
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.setDeviceId(String)
|
||||
id: setDeviceId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: setDeviceId(String deviceId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackRecord.setDeviceId(String deviceId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 94
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setDeviceId(String deviceId)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.setEnqueuedTimeUtc(Instant)
|
||||
id: setEnqueuedTimeUtc(Instant)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: setEnqueuedTimeUtc(Instant enqueuedTimeUtc)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackRecord.setEnqueuedTimeUtc(Instant enqueuedTimeUtc)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 22
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setEnqueuedTimeUtc(Instant enqueuedTimeUtc)
|
||||
parameters:
|
||||
- id: enqueuedTimeUtc
|
||||
type: 328f8254
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.setOriginalMessageId(String)
|
||||
id: setOriginalMessageId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: setOriginalMessageId(String originalMessageId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackRecord.setOriginalMessageId(String originalMessageId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 34
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setOriginalMessageId(String originalMessageId)
|
||||
parameters:
|
||||
- id: originalMessageId
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record.setStatusCode(FeedbackStatusCode)
|
||||
id: setStatusCode(FeedbackStatusCode)
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
langs:
|
||||
- java
|
||||
name: setStatusCode(FeedbackStatusCode statusCode)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.FeedbackRecord.setStatusCode(FeedbackStatusCode statusCode)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackRecord.java
|
||||
startLine: 58
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setStatusCode(FeedbackStatusCode statusCode)
|
||||
parameters:
|
||||
- id: statusCode
|
||||
type: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
references:
|
||||
- uid: 328f8254
|
||||
spec.java:
|
||||
- name: Instant
|
||||
fullName: Instant
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_status_code.yml
|
||||
name: FeedbackStatusCode
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackStatusCode
|
||||
type: Enum
|
||||
summary: <p>Enum for feedback status codes </p>
|
||||
syntax:
|
||||
content: public enum FeedbackStatusCode
|
||||
|
|
@ -0,0 +1,111 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
id: _feedback_status_code
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_status_code.deliveryCountExceeded()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_status_code.expired()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_status_code.rejected()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_status_code.success()
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_status_code.unknown()
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: FeedbackStatusCode
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackStatusCode
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackStatusCode.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackStatusCode.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Enum for feedback status codes </p>
|
||||
syntax:
|
||||
content: public enum FeedbackStatusCode
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<FeedbackStatusCode>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_status_code.deliveryCountExceeded()
|
||||
id: deliveryCountExceeded()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: deliveryCountExceeded
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackStatusCode.deliveryCountExceeded
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackStatusCode.java
|
||||
startLine: 14
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public deliveryCountExceeded
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_status_code.expired()
|
||||
id: expired()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: expired
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackStatusCode.expired
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackStatusCode.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public expired
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_status_code.rejected()
|
||||
id: rejected()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: rejected
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackStatusCode.rejected
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackStatusCode.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public rejected
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_status_code.success()
|
||||
id: success()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: success
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackStatusCode.success
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackStatusCode.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public success
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_status_code.unknown()
|
||||
id: unknown()
|
||||
parent: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: unknown
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackStatusCode.unknown
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/FeedbackStatusCode.java
|
||||
startLine: 16
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public unknown
|
||||
references: []
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._import_mode
|
||||
id: _import_mode
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._import_mode.SerializedName()
|
||||
href: com.microsoft.azure.iot.service.sdk._import_mode.yml
|
||||
langs:
|
||||
- java
|
||||
name: ImportMode
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ImportMode
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ImportMode.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ImportMode.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public enum ImportMode
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<ImportMode>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._import_mode.SerializedName()
|
||||
id: SerializedName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._import_mode
|
||||
href: com.microsoft.azure.iot.service.sdk._import_mode.yml
|
||||
langs:
|
||||
- java
|
||||
name: SerializedName
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ImportMode.SerializedName
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ImportMode.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: >-
|
||||
public SerializedName=("createOrUpdate")
|
||||
CreateOrUpdate
|
||||
references: []
|
||||
|
|
@ -0,0 +1,925 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
id: _iot_hub_connection_string
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.authenticationMethod()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getAuthenticationMethod()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getHostName()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getIotHubName()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getSharedAccessKey()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getSharedAccessKeyName()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getSharedAccessSignature()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlCreateExportImportJob()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlDevice(String)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlDeviceList(Integer)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlDeviceStatistics()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlImportExportJob(String)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUserString()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.HOST_NAME_PROPERTY_NAME()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.HOST_NAME_SEPARATOR()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.hostName()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.IotHubConnectionString()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.iotHubName()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.setSharedAccessKey(String)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.setSharedAccessKeyName(String)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.setSharedAccessSignature(String)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.SHARED_ACCESS_KEY_NAME_PROPERTY_NAME()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.SHARED_ACCESS_KEY_PROPERTY_NAME()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.SHARED_ACCESS_SIGNATURE_PROPERTY_NAME()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.sharedAccessKey()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.sharedAccessKeyName()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.sharedAccessSignature()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.toString()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.VALUE_PAIR_DELIMITER()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.VALUE_PAIR_SEPARATOR()
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubConnectionString
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 14
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Expose all connections string properties and methods for user, device and connection string serialization. </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionString extends IotHubConnectionStringBuilder
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.createConnectionString(String)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.createConnectionString(String,AuthenticationMethod)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.parse(String,IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.parseIotHubName(IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.setAuthenticationMethod(AuthenticationMethod,IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.setHostName(String,IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validate(IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validateFormat(String,String,String)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validateFormatIfSpecified(String,String,String)
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.authenticationMethod()
|
||||
id: authenticationMethod()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: authenticationMethod
|
||||
fullName: AuthenticationMethod com.microsoft.azure.iot.service.sdk.IotHubConnectionString.authenticationMethod
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 28
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected AuthenticationMethod authenticationMethod
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getAuthenticationMethod()
|
||||
id: getAuthenticationMethod()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getAuthenticationMethod()
|
||||
fullName: AuthenticationMethod com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getAuthenticationMethod()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 242
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for authenticationMethod</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public AuthenticationMethod getAuthenticationMethod()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
description: <p>The authenticationMethod object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getHostName()
|
||||
id: getHostName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getHostName()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getHostName()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 282
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for hostName</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getHostName()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The hostName string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getIotHubName()
|
||||
id: getIotHubName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getIotHubName()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getIotHubName()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 232
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for iotHubName</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getIotHubName()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The iot hub name string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getSharedAccessKey()
|
||||
id: getSharedAccessKey()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getSharedAccessKey()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getSharedAccessKey()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 262
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for sharedAccessKey</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getSharedAccessKey()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The sharedAccessKey string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getSharedAccessKeyName()
|
||||
id: getSharedAccessKeyName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getSharedAccessKeyName()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getSharedAccessKeyName()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 252
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for sharedAccessKeyName</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getSharedAccessKeyName()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The sharedAccessKeyName string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getSharedAccessSignature()
|
||||
id: getSharedAccessSignature()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getSharedAccessSignature()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getSharedAccessSignature()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 272
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Getter for sharedAccessSignature</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getSharedAccessSignature()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The sharedAccessSignature string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlCreateExportImportJob()
|
||||
id: getUrlCreateExportImportJob()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getUrlCreateExportImportJob()
|
||||
fullName: URL com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getUrlCreateExportImportJob()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 156
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Create url for processing a bulk import/export job</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public URL getUrlCreateExportImportJob()
|
||||
return:
|
||||
type: a891b3e6
|
||||
description: '<p>The import/export job URL in the following format: "https:hostname/jobs/create?api-version=201X-XX-XX" </p>'
|
||||
exceptions:
|
||||
- type: 7f45ead7
|
||||
description: <p>This exception is thrown if the URL creation failed due to malformed string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlDevice(String)
|
||||
id: getUrlDevice(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getUrlDevice(String deviceId)
|
||||
fullName: URL com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getUrlDevice(String deviceId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 73
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Create url for requesting device data</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public URL getUrlDevice(String deviceId)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>The name of the device </p>
|
||||
return:
|
||||
type: a891b3e6
|
||||
description: '<p>The device Url in the following format: "https:hostname/devices/deviceId?api-version=201X-XX-XX" </p>'
|
||||
exceptions:
|
||||
- type: 7f45ead7
|
||||
description: <p>This exception is thrown if the URL creation failed due to malformed string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlDeviceList(Integer)
|
||||
id: getUrlDeviceList(Integer)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getUrlDeviceList(Integer maxCount)
|
||||
fullName: URL com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getUrlDeviceList(Integer maxCount)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 103
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Create url for requesting device list</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public URL getUrlDeviceList(Integer maxCount)
|
||||
parameters:
|
||||
- id: maxCount
|
||||
type: 08effaa0
|
||||
description: <p>The number of requested devices </p>
|
||||
return:
|
||||
type: a891b3e6
|
||||
description: <p>URL string to get the device list from IotHub </p>
|
||||
exceptions:
|
||||
- type: 7f45ead7
|
||||
description: <p>This exception is thrown if the URL creation failed due to malformed string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlDeviceStatistics()
|
||||
id: getUrlDeviceStatistics()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getUrlDeviceStatistics()
|
||||
fullName: URL com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getUrlDeviceStatistics()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 134
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Create url for requesting device statistics</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public URL getUrlDeviceStatistics()
|
||||
return:
|
||||
type: a891b3e6
|
||||
description: '<p>The device statistics Url in the following format: "https:hostname/statistics/devices?api-version=201X-XX-XX" </p>'
|
||||
exceptions:
|
||||
- type: 7f45ead7
|
||||
description: <p>This exception is thrown if the URL creation failed due to malformed string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUrlImportExportJob(String)
|
||||
id: getUrlImportExportJob(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getUrlImportExportJob(String jobId)
|
||||
fullName: URL com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getUrlImportExportJob(String jobId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 178
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public URL getUrlImportExportJob(String jobId)
|
||||
parameters:
|
||||
- id: jobId
|
||||
type: "26831127"
|
||||
description: <p>Create url for retrieving a bulk import/export job </p>
|
||||
return:
|
||||
type: a891b3e6
|
||||
description: '<p>The import/export job URL in the following format: "https:hostname/jobs/jobId?api-version=201X-XX-XX" </p>'
|
||||
exceptions:
|
||||
- type: 7f45ead7
|
||||
description: <p>This exception is thrown if the URL creation failed due to malformed string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.getUserString()
|
||||
id: getUserString()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: getUserString()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.getUserString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 53
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Serialize user string</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getUserString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: '<p>The user string in the following format: "SharedAccessKeyName@sas.root.IotHubName" </p>'
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.HOST_NAME_PROPERTY_NAME()
|
||||
id: HOST_NAME_PROPERTY_NAME()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: HOST_NAME_PROPERTY_NAME
|
||||
fullName: final String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.HOST_NAME_PROPERTY_NAME
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected static final String HOST_NAME_PROPERTY_NAME= "HostName"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.HOST_NAME_SEPARATOR()
|
||||
id: HOST_NAME_SEPARATOR()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: HOST_NAME_SEPARATOR
|
||||
fullName: final String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.HOST_NAME_SEPARATOR
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 18
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected static final String HOST_NAME_SEPARATOR= "."
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.hostName()
|
||||
id: hostName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: hostName
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.hostName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected String hostName
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.IotHubConnectionString()
|
||||
id: IotHubConnectionString()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubConnectionString()
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString.IotHubConnectionString()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 46
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected IotHubConnectionString()
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.iotHubName()
|
||||
id: iotHubName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: iotHubName
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.iotHubName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 27
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected String iotHubName
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.setSharedAccessKey(String)
|
||||
id: setSharedAccessKey(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: setSharedAccessKey(String sharedAccessKey)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.IotHubConnectionString.setSharedAccessKey(String sharedAccessKey)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 302
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Setter for sharedAccessKey</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected void setSharedAccessKey(String sharedAccessKey)
|
||||
parameters:
|
||||
- id: sharedAccessKey
|
||||
type: "26831127"
|
||||
description: <p>The value of the signature to set </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.setSharedAccessKeyName(String)
|
||||
id: setSharedAccessKeyName(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: setSharedAccessKeyName(String sharedAccessKeyName)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.IotHubConnectionString.setSharedAccessKeyName(String sharedAccessKeyName)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 292
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Setter for sharedAccessKeyName</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected void setSharedAccessKeyName(String sharedAccessKeyName)
|
||||
parameters:
|
||||
- id: sharedAccessKeyName
|
||||
type: "26831127"
|
||||
description: <p>The value of the signature to set </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.setSharedAccessSignature(String)
|
||||
id: setSharedAccessSignature(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: setSharedAccessSignature(String sharedAccessSignature)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.IotHubConnectionString.setSharedAccessSignature(String sharedAccessSignature)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 312
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Setter for sharedAccessSignature</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected void setSharedAccessSignature(String sharedAccessSignature)
|
||||
parameters:
|
||||
- id: sharedAccessSignature
|
||||
type: "26831127"
|
||||
description: <p>The value of the signature to set </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.SHARED_ACCESS_KEY_NAME_PROPERTY_NAME()
|
||||
id: SHARED_ACCESS_KEY_NAME_PROPERTY_NAME()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: SHARED_ACCESS_KEY_NAME_PROPERTY_NAME
|
||||
fullName: final String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.SHARED_ACCESS_KEY_NAME_PROPERTY_NAME
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected static final String SHARED_ACCESS_KEY_NAME_PROPERTY_NAME= "SharedAccessKeyName"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.SHARED_ACCESS_KEY_PROPERTY_NAME()
|
||||
id: SHARED_ACCESS_KEY_PROPERTY_NAME()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: SHARED_ACCESS_KEY_PROPERTY_NAME
|
||||
fullName: final String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.SHARED_ACCESS_KEY_PROPERTY_NAME
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 22
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected static final String SHARED_ACCESS_KEY_PROPERTY_NAME= "SharedAccessKey"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.SHARED_ACCESS_SIGNATURE_PROPERTY_NAME()
|
||||
id: SHARED_ACCESS_SIGNATURE_PROPERTY_NAME()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: SHARED_ACCESS_SIGNATURE_PROPERTY_NAME
|
||||
fullName: final String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.SHARED_ACCESS_SIGNATURE_PROPERTY_NAME
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 23
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected static final String SHARED_ACCESS_SIGNATURE_PROPERTY_NAME= "SharedAccessSignature"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.sharedAccessKey()
|
||||
id: sharedAccessKey()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: sharedAccessKey
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.sharedAccessKey
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 30
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected String sharedAccessKey
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.sharedAccessKeyName()
|
||||
id: sharedAccessKeyName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: sharedAccessKeyName
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.sharedAccessKeyName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 29
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected String sharedAccessKeyName
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.sharedAccessSignature()
|
||||
id: sharedAccessSignature()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: sharedAccessSignature
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.sharedAccessSignature
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 31
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected String sharedAccessSignature
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 200
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Serialize connection string</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>Iot Hub connection string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.VALUE_PAIR_DELIMITER()
|
||||
id: VALUE_PAIR_DELIMITER()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: VALUE_PAIR_DELIMITER
|
||||
fullName: final String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.VALUE_PAIR_DELIMITER
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 16
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected static final String VALUE_PAIR_DELIMITER= ";"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.VALUE_PAIR_SEPARATOR()
|
||||
id: VALUE_PAIR_SEPARATOR()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
langs:
|
||||
- java
|
||||
name: VALUE_PAIR_SEPARATOR
|
||||
fullName: final String com.microsoft.azure.iot.service.sdk.IotHubConnectionString.VALUE_PAIR_SEPARATOR
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionString.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected static final String VALUE_PAIR_SEPARATOR= "="
|
||||
return:
|
||||
type: 3d93591e
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 7f45ead7
|
||||
spec.java:
|
||||
- name: MalformedURLException
|
||||
fullName: MalformedURLException
|
||||
- uid: a891b3e6
|
||||
spec.java:
|
||||
- name: URL
|
||||
fullName: URL
|
||||
- uid: 08effaa0
|
||||
spec.java:
|
||||
- name: Integer
|
||||
fullName: Integer
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.createConnectionString(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: createConnectionString(String connectionString)
|
||||
fullName: static IotHubConnectionString com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.createConnectionString(String connectionString)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Static constructor to create <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> deserialize the given string</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static IotHubConnectionString createConnectionString(String connectionString)
|
||||
parameters:
|
||||
- id: connectionString
|
||||
type: "26831127"
|
||||
description: <p>The serialized connection string </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.createConnectionString(String,AuthenticationMethod)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: createConnectionString(String hostName, AuthenticationMethod authenticationMethod)
|
||||
fullName: static IotHubConnectionString com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.createConnectionString(String hostName, AuthenticationMethod authenticationMethod)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Static constructor to create <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> from host name and authentication method</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static IotHubConnectionString createConnectionString(String hostName, AuthenticationMethod authenticationMethod)
|
||||
parameters:
|
||||
- id: hostName
|
||||
type: "26831127"
|
||||
description: <p>The hostName string </p>
|
||||
- id: authenticationMethod
|
||||
type: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
description: <p>The <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.parse(String,IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: parse(String connectionString, IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.parse(String connectionString, IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Deserialize connection string</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void parse(String connectionString, IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: connectionString
|
||||
type: "26831127"
|
||||
description: <p>The connection string to deserialize </p>
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The target object for deserialization </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.parseIotHubName(IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: parseIotHubName(IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static String com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.parseIotHubName(IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Parse the iot hub name part from the host name</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static String parseIotHubName(IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The source iotHubConnectionString containing the hostName </p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The substring of the host name until the first "." character </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.setAuthenticationMethod(AuthenticationMethod,IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: setAuthenticationMethod(AuthenticationMethod authenticationMethod, IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.setAuthenticationMethod(AuthenticationMethod authenticationMethod, IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Set authentication method to target <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void setAuthenticationMethod(AuthenticationMethod authenticationMethod, IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: authenticationMethod
|
||||
type: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
description: <p>value to set </p>
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>target <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.setHostName(String,IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: setHostName(String hostName, IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.setHostName(String hostName, IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Set host name value to target <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void setHostName(String hostName, IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: hostName
|
||||
type: "26831127"
|
||||
description: <p>host name string </p>
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>target <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validate(IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: validate(IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.validate(IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Validate <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> format</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void validate(IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The object to validate </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validateFormat(String,String,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: validateFormat(String value, String propertyName, String regex)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.validateFormat(String value, String propertyName, String regex)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Validate string property using given regex</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void validateFormat(String value, String propertyName, String regex)
|
||||
parameters:
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>The string value to validate </p>
|
||||
- id: propertyName
|
||||
type: "26831127"
|
||||
description: <p>The property name </p>
|
||||
- id: regex
|
||||
type: "26831127"
|
||||
description: <p>The regex used for validation </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validateFormatIfSpecified(String,String,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: validateFormatIfSpecified(String value, String propertyName, String regex)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.validateFormatIfSpecified(String value, String propertyName, String regex)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Validate string property using given regex if value is not null or empty</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void validateFormatIfSpecified(String value, String propertyName, String regex)
|
||||
parameters:
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>string value to validate </p>
|
||||
- id: propertyName
|
||||
type: "26831127"
|
||||
description: <p>property name </p>
|
||||
- id: regex
|
||||
type: "26831127"
|
||||
description: <p>regex used for validation </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: IotHubConnectionStringBuilder
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder
|
||||
type: Class
|
||||
summary: <p>Provide static constructors to create <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionStringBuilder
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: AuthenticationMethod
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMethod
|
||||
type: Class
|
||||
summary: <p>Class used to abstract the different authentication methods used to use IoT Hub SDK. </p>
|
||||
syntax:
|
||||
content: public class AuthenticationMethod
|
||||
|
|
@ -0,0 +1,325 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
id: _iot_hub_connection_string_builder
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.createConnectionString(String)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.createConnectionString(String,AuthenticationMethod)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.parse(String,IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.parseIotHubName(IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.setAuthenticationMethod(AuthenticationMethod,IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.setHostName(String,IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validate(IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validateFormat(String,String,String)
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validateFormatIfSpecified(String,String,String)
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubConnectionStringBuilder
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 14
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Provide static constructors to create <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionStringBuilder
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.createConnectionString(String)
|
||||
id: createConnectionString(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: createConnectionString(String connectionString)
|
||||
fullName: static IotHubConnectionString com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.createConnectionString(String connectionString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 31
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Static constructor to create <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> deserialize the given string</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static IotHubConnectionString createConnectionString(String connectionString)
|
||||
parameters:
|
||||
- id: connectionString
|
||||
type: "26831127"
|
||||
description: <p>The serialized connection string </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
exceptions:
|
||||
- type: 8a99d4b0
|
||||
description: <p>This exception is thrown if the object creation failed </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.createConnectionString(String,AuthenticationMethod)
|
||||
id: createConnectionString(String,AuthenticationMethod)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: createConnectionString(String hostName, AuthenticationMethod authenticationMethod)
|
||||
fullName: static IotHubConnectionString com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.createConnectionString(String hostName, AuthenticationMethod authenticationMethod)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 52
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Static constructor to create <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> from host name and authentication method</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static IotHubConnectionString createConnectionString(String hostName, AuthenticationMethod authenticationMethod)
|
||||
parameters:
|
||||
- id: hostName
|
||||
type: "26831127"
|
||||
description: <p>The hostName string </p>
|
||||
- id: authenticationMethod
|
||||
type: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
description: <p>The <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
exceptions:
|
||||
- type: 8a99d4b0
|
||||
description: <p>This exception is thrown if the object creation failed </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.parse(String,IotHubConnectionString)
|
||||
id: parse(String,IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: parse(String connectionString, IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.parse(String connectionString, IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 79
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Deserialize connection string</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void parse(String connectionString, IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: connectionString
|
||||
type: "26831127"
|
||||
description: <p>The connection string to deserialize </p>
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The target object for deserialization </p>
|
||||
exceptions:
|
||||
- type: 8a99d4b0
|
||||
description: <p>This exception is thrown if the parsing failed </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.parseIotHubName(IotHubConnectionString)
|
||||
id: parseIotHubName(IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: parseIotHubName(IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static String com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.parseIotHubName(IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 136
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Parse the iot hub name part from the host name</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static String parseIotHubName(IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The source iotHubConnectionString containing the hostName </p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The substring of the host name until the first "." character </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.setAuthenticationMethod(AuthenticationMethod,IotHubConnectionString)
|
||||
id: setAuthenticationMethod(AuthenticationMethod,IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: setAuthenticationMethod(AuthenticationMethod authenticationMethod, IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.setAuthenticationMethod(AuthenticationMethod authenticationMethod, IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 232
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Set authentication method to target <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void setAuthenticationMethod(AuthenticationMethod authenticationMethod, IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: authenticationMethod
|
||||
type: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
description: <p>value to set </p>
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>target <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.setHostName(String,IotHubConnectionString)
|
||||
id: setHostName(String,IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: setHostName(String hostName, IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.setHostName(String hostName, IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 217
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Set host name value to target <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void setHostName(String hostName, IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: hostName
|
||||
type: "26831127"
|
||||
description: <p>host name string </p>
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>target <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validate(IotHubConnectionString)
|
||||
id: validate(IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: validate(IotHubConnectionString iotHubConnectionString)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.validate(IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 157
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Validate <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> format</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void validate(IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The object to validate </p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>This exception is thrown if the input object is null </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validateFormat(String,String,String)
|
||||
id: validateFormat(String,String,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: validateFormat(String value, String propertyName, String regex)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.validateFormat(String value, String propertyName, String regex)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 184
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Validate string property using given regex</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void validateFormat(String value, String propertyName, String regex)
|
||||
parameters:
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>The string value to validate </p>
|
||||
- id: propertyName
|
||||
type: "26831127"
|
||||
description: <p>The property name </p>
|
||||
- id: regex
|
||||
type: "26831127"
|
||||
description: <p>The regex used for validation </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.validateFormatIfSpecified(String,String,String)
|
||||
id: validateFormatIfSpecified(String,String,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
langs:
|
||||
- java
|
||||
name: validateFormatIfSpecified(String value, String propertyName, String regex)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder.validateFormatIfSpecified(String value, String propertyName, String regex)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubConnectionStringBuilder.java
|
||||
startLine: 202
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Validate string property using given regex if value is not null or empty</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void validateFormatIfSpecified(String value, String propertyName, String regex)
|
||||
parameters:
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>string value to validate </p>
|
||||
- id: propertyName
|
||||
type: "26831127"
|
||||
description: <p>property name </p>
|
||||
- id: regex
|
||||
type: "26831127"
|
||||
description: <p>regex used for validation </p>
|
||||
references:
|
||||
- uid: 8a99d4b0
|
||||
spec.java:
|
||||
- name: Exception
|
||||
fullName: Exception
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
name: IotHubConnectionString
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString
|
||||
type: Class
|
||||
summary: <p>Expose all connections string properties and methods for user, device and connection string serialization. </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionString extends IotHubConnectionStringBuilder
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: AuthenticationMethod
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMethod
|
||||
type: Class
|
||||
summary: <p>Class used to abstract the different authentication methods used to use IoT Hub SDK. </p>
|
||||
syntax:
|
||||
content: public class AuthenticationMethod
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
id: _iot_hub_service_client_protocol
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.AMQPS()
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.AMQPS_WS()
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubServiceClientProtocol.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubServiceClientProtocol.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>The application-layer protocol used by the service client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubServiceClientProtocol
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<IotHubServiceClientProtocol>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.AMQPS()
|
||||
id: AMQPS()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
langs:
|
||||
- java
|
||||
name: AMQPS
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol.AMQPS
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubServiceClientProtocol.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public AMQPS
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.AMQPS_WS()
|
||||
id: AMQPS_WS()
|
||||
parent: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
langs:
|
||||
- java
|
||||
name: AMQPS_WS
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol.AMQPS_WS
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/IotHubServiceClientProtocol.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public AMQPS_WS
|
||||
references: []
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties._job_status
|
||||
id: _job_status
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties._job_status.SerializedName()
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties._job_status.yml
|
||||
langs:
|
||||
- java
|
||||
name: JobProperties.JobStatus
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties.JobStatus
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 174
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public enum JobStatus
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<JobProperties.JobStatus>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties._job_status.SerializedName()
|
||||
id: SerializedName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties._job_status
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties._job_status.yml
|
||||
langs:
|
||||
- java
|
||||
name: SerializedName
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties.JobStatus.SerializedName
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 176
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: >-
|
||||
public SerializedName=("unknown")
|
||||
UNKNOWN
|
||||
references: []
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties._job_type
|
||||
id: _job_type
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties._job_type.SerializedName()
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties._job_type.yml
|
||||
langs:
|
||||
- java
|
||||
name: JobProperties.JobType
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties.JobType
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 162
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public enum JobType
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<JobProperties.JobType>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties._job_type.SerializedName()
|
||||
id: SerializedName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties._job_type
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties._job_type.yml
|
||||
langs:
|
||||
- java
|
||||
name: SerializedName
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties.JobType.SerializedName
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 164
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: >-
|
||||
public SerializedName=("unknown")
|
||||
UNKNOWN
|
||||
references: []
|
||||
|
|
@ -0,0 +1,483 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
id: _job_properties
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getEndTimeUtc()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getExcludeKeysInExport()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getFailureReason()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getInputBlobContainerUri()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getJobId()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getOutputBlobContainerUri()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getProgress()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getStartTimeUtc()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getStatus()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.getType()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.JobProperties()
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setEndTimeUtc(Date)
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setExcludeKeysInExport(boolean)
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setFailureReason(String)
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setInputBlobContainerUri(String)
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setJobId(String)
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setOutputBlobContainerUri(String)
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setProgress(int)
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setStartTimeUtc(Date)
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setStatus(JobStatus)
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties.setType(JobType)
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: JobProperties
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public class JobProperties
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getEndTimeUtc()
|
||||
id: getEndTimeUtc()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getEndTimeUtc()
|
||||
fullName: Date com.microsoft.azure.iot.service.sdk.JobProperties.getEndTimeUtc()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 49
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Date getEndTimeUtc()
|
||||
return:
|
||||
type: "12977444"
|
||||
description: <p>the UTC job end time. Ignored at creation. Represents the time the job stopped processing. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getExcludeKeysInExport()
|
||||
id: getExcludeKeysInExport()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getExcludeKeysInExport()
|
||||
fullName: boolean com.microsoft.azure.iot.service.sdk.JobProperties.getExcludeKeysInExport()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 135
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public boolean getExcludeKeysInExport()
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: <p>whether the keys are included in export or not. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getFailureReason()
|
||||
id: getFailureReason()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getFailureReason()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.JobProperties.getFailureReason()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 151
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getFailureReason()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>System generated. Ignored at creation. If status == failure, this represents a string containing the reason. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getInputBlobContainerUri()
|
||||
id: getInputBlobContainerUri()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getInputBlobContainerUri()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.JobProperties.getInputBlobContainerUri()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 106
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getInputBlobContainerUri()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>URI containing SAS token to a blob container that contains registry data to sync. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getJobId()
|
||||
id: getJobId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getJobId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.JobProperties.getJobId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getJobId()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the system generated job id. Ignored at creation. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getOutputBlobContainerUri()
|
||||
id: getOutputBlobContainerUri()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getOutputBlobContainerUri()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.JobProperties.getOutputBlobContainerUri()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 121
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getOutputBlobContainerUri()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>URI containing SAS token to a blob container. This is used to output the status of the job and the results. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getProgress()
|
||||
id: getProgress()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getProgress()
|
||||
fullName: int com.microsoft.azure.iot.service.sdk.JobProperties.getProgress()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 92
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public int getProgress()
|
||||
return:
|
||||
type: f75371fa
|
||||
description: <p>the system generated job progress. Ignored at creation. Represents the completion percentage. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getStartTimeUtc()
|
||||
id: getStartTimeUtc()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStartTimeUtc()
|
||||
fullName: Date com.microsoft.azure.iot.service.sdk.JobProperties.getStartTimeUtc()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 34
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Date getStartTimeUtc()
|
||||
return:
|
||||
type: "12977444"
|
||||
description: <p>the system generated UTC job start time. Ignored at creation. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getStatus()
|
||||
id: getStatus()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStatus()
|
||||
fullName: JobStatus com.microsoft.azure.iot.service.sdk.JobProperties.getStatus()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 77
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public JobStatus getStatus()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._job_properties._job_status
|
||||
description: <p>the system generated job status. Ignored at creation. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.getType()
|
||||
id: getType()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: getType()
|
||||
fullName: JobType com.microsoft.azure.iot.service.sdk.JobProperties.getType()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 63
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public JobType getType()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._job_properties._job_type
|
||||
description: <p>the type of job to execute. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.JobProperties()
|
||||
id: JobProperties()
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: JobProperties()
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties.JobProperties()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public JobProperties()
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setEndTimeUtc(Date)
|
||||
id: setEndTimeUtc(Date)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setEndTimeUtc(Date endTimeUtc)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setEndTimeUtc(Date endTimeUtc)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 56
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setEndTimeUtc(Date endTimeUtc)
|
||||
parameters:
|
||||
- id: endTimeUtc
|
||||
type: "12977444"
|
||||
description: <p>the UTC job end time. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setExcludeKeysInExport(boolean)
|
||||
id: setExcludeKeysInExport(boolean)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setExcludeKeysInExport(boolean excludeKeysInExport)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setExcludeKeysInExport(boolean excludeKeysInExport)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 143
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setExcludeKeysInExport(boolean excludeKeysInExport)
|
||||
parameters:
|
||||
- id: excludeKeysInExport
|
||||
type: 4fc6e284
|
||||
description: '<p>optional for export jobs; ignored for other jobs. Default: false. If false, authorization keys are included in export output. Keys are exported as null otherwise. </p>'
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setFailureReason(String)
|
||||
id: setFailureReason(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setFailureReason(String failureReason)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setFailureReason(String failureReason)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 158
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setFailureReason(String failureReason)
|
||||
parameters:
|
||||
- id: failureReason
|
||||
type: "26831127"
|
||||
description: <p>the failure reason. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setInputBlobContainerUri(String)
|
||||
id: setInputBlobContainerUri(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setInputBlobContainerUri(String inputBlobContainerUri)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setInputBlobContainerUri(String inputBlobContainerUri)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 113
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setInputBlobContainerUri(String inputBlobContainerUri)
|
||||
parameters:
|
||||
- id: inputBlobContainerUri
|
||||
type: "26831127"
|
||||
description: <p>the input blob container URI. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setJobId(String)
|
||||
id: setJobId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setJobId(String jobId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setJobId(String jobId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 27
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setJobId(String jobId)
|
||||
parameters:
|
||||
- id: jobId
|
||||
type: "26831127"
|
||||
description: <p>the job id </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setOutputBlobContainerUri(String)
|
||||
id: setOutputBlobContainerUri(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setOutputBlobContainerUri(String outputBlobContainerUri)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setOutputBlobContainerUri(String outputBlobContainerUri)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 128
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setOutputBlobContainerUri(String outputBlobContainerUri)
|
||||
parameters:
|
||||
- id: outputBlobContainerUri
|
||||
type: "26831127"
|
||||
description: <p>the output blob container URI. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setProgress(int)
|
||||
id: setProgress(int)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setProgress(int progress)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setProgress(int progress)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 99
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setProgress(int progress)
|
||||
parameters:
|
||||
- id: progress
|
||||
type: f75371fa
|
||||
description: <p>the job progress. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setStartTimeUtc(Date)
|
||||
id: setStartTimeUtc(Date)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setStartTimeUtc(Date startTimeUtc)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setStartTimeUtc(Date startTimeUtc)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 41
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setStartTimeUtc(Date startTimeUtc)
|
||||
parameters:
|
||||
- id: startTimeUtc
|
||||
type: "12977444"
|
||||
description: <p>the UTC job start time. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setStatus(JobStatus)
|
||||
id: setStatus(JobStatus)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setStatus(JobStatus status)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setStatus(JobStatus status)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 84
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setStatus(JobStatus status)
|
||||
parameters:
|
||||
- id: status
|
||||
type: com.microsoft.azure.iot.service.sdk._job_properties._job_status
|
||||
description: <p>the job status. </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties.setType(JobType)
|
||||
id: setType(JobType)
|
||||
parent: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
langs:
|
||||
- java
|
||||
name: setType(JobType type)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.JobProperties.setType(JobType type)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/JobProperties.java
|
||||
startLine: 70
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setType(JobType type)
|
||||
parameters:
|
||||
- id: type
|
||||
type: com.microsoft.azure.iot.service.sdk._job_properties._job_type
|
||||
description: <p>the type of job to execute. </p>
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: "12977444"
|
||||
spec.java:
|
||||
- name: Date
|
||||
fullName: Date
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
- uid: 4fc6e284
|
||||
spec.java:
|
||||
- name: boolean
|
||||
fullName: boolean
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties._job_type
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties._job_type.yml
|
||||
name: JobProperties.JobType
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties.JobType
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum JobType
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties._job_status
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties._job_status.yml
|
||||
name: JobProperties.JobStatus
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties.JobStatus
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum JobStatus
|
||||
|
|
@ -0,0 +1,527 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message
|
||||
id: _message
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._message.clearCustomProperties()
|
||||
- com.microsoft.azure.iot.service.sdk._message.correlationId()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getBodyStream()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getBytes()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getCorrelationId()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getDeliveryAcknowledgement()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getExpiryTimeUtc()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getLockToken()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getMessageId()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getProperties()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getTo()
|
||||
- com.microsoft.azure.iot.service.sdk._message.getUserId()
|
||||
- com.microsoft.azure.iot.service.sdk._message.Message()
|
||||
- com.microsoft.azure.iot.service.sdk._message.Message(byte [])
|
||||
- com.microsoft.azure.iot.service.sdk._message.Message(ByteArrayInputStream)
|
||||
- com.microsoft.azure.iot.service.sdk._message.Message(String)
|
||||
- com.microsoft.azure.iot.service.sdk._message.setCorrelationId(String)
|
||||
- com.microsoft.azure.iot.service.sdk._message.setDeliveryAcknowledgement(DeliveryAcknowledgement)
|
||||
- com.microsoft.azure.iot.service.sdk._message.setExpiryTimeUtc(Date)
|
||||
- com.microsoft.azure.iot.service.sdk._message.setMessageId(String)
|
||||
- com.microsoft.azure.iot.service.sdk._message.setProperties(Map<String, String>)
|
||||
- com.microsoft.azure.iot.service.sdk._message.setTo(String)
|
||||
- com.microsoft.azure.iot.service.sdk._message.setUserId(String)
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>IotHub specific message container </p>
|
||||
syntax:
|
||||
content: public class Message
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.clearCustomProperties()
|
||||
id: clearCustomProperties()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: clearCustomProperties()
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Message.clearCustomProperties()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 264
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void clearCustomProperties()
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.correlationId()
|
||||
id: correlationId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: correlationId
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Message.correlationId
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 85
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Used in message responses and feedback </p>
|
||||
syntax:
|
||||
content: public String correlationId
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getBodyStream()
|
||||
id: getBodyStream()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getBodyStream()
|
||||
fullName: ByteArrayOutputStream com.microsoft.azure.iot.service.sdk.Message.getBodyStream()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 224
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>The stream content of the body. </p>
|
||||
syntax:
|
||||
content: public ByteArrayOutputStream getBodyStream()
|
||||
return:
|
||||
type: 73a378c9
|
||||
description: <p>The ByteArrayOutputStream object containing the message body </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getBytes()
|
||||
id: getBytes()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getBytes()
|
||||
fullName: byte [] com.microsoft.azure.iot.service.sdk.Message.getBytes()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 235
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>The byte content of the body. </p>
|
||||
syntax:
|
||||
content: public byte [] getBytes()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>The byte array of the message body </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getCorrelationId()
|
||||
id: getCorrelationId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getCorrelationId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Message.getCorrelationId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 87
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getCorrelationId()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getDeliveryAcknowledgement()
|
||||
id: getDeliveryAcknowledgement()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getDeliveryAcknowledgement()
|
||||
fullName: DeliveryAcknowledgement com.microsoft.azure.iot.service.sdk.Message.getDeliveryAcknowledgement()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 240
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public DeliveryAcknowledgement getDeliveryAcknowledgement()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getExpiryTimeUtc()
|
||||
id: getExpiryTimeUtc()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getExpiryTimeUtc()
|
||||
fullName: Date com.microsoft.azure.iot.service.sdk.Message.getExpiryTimeUtc()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 62
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Date getExpiryTimeUtc()
|
||||
return:
|
||||
type: "12977444"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getLockToken()
|
||||
id: getLockToken()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getLockToken()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Message.getLockToken()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 77
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getLockToken()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getMessageId()
|
||||
id: getMessageId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getMessageId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Message.getMessageId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 32
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getMessageId()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getProperties()
|
||||
id: getProperties()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getProperties()
|
||||
fullName: Map<String, String> com.microsoft.azure.iot.service.sdk.Message.getProperties()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 251
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Map<String, String> getProperties()
|
||||
return:
|
||||
type: 689c8cb5
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getTo()
|
||||
id: getTo()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getTo()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Message.getTo()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 47
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getTo()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.getUserId()
|
||||
id: getUserId()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getUserId()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.Message.getUserId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 103
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public String getUserId()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.Message()
|
||||
id: Message()
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message()
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message.Message()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 177
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Basic constructor </p>
|
||||
syntax:
|
||||
content: public Message()
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.Message(byte [])
|
||||
id: Message(byte [])
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message(byte[] byteArray)
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message.Message(byte[] byteArray)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 200
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: '<p>byteArray: a byte array containing the body of the message </p>'
|
||||
syntax:
|
||||
content: public Message(byte[] byteArray)
|
||||
parameters:
|
||||
- id: byteArray
|
||||
type: ccd9418d
|
||||
description: <p>The byte array containing the message body </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.Message(ByteArrayInputStream)
|
||||
id: Message(ByteArrayInputStream)
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message(ByteArrayInputStream stream)
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message.Message(ByteArrayInputStream stream)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 187
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: '<p>stream: a stream containing the body of the message </p>'
|
||||
syntax:
|
||||
content: public Message(ByteArrayInputStream stream)
|
||||
parameters:
|
||||
- id: stream
|
||||
type: f03846a9
|
||||
description: <p>The stream containing the message body </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.Message(String)
|
||||
id: Message(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message(String string)
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message.Message(String string)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 214
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public Message(String string)
|
||||
parameters:
|
||||
- id: string
|
||||
type: "26831127"
|
||||
description: '<p>- a string containing the body of the message. Important: If a string is passed, the HttpBatch.SerializeAsString is set to true, and the internal byte representation is serialized as UTF-8, with HttpBatch.Encoding set to UTF-8. </p>'
|
||||
exceptions:
|
||||
- type: d5427e37
|
||||
description: <p>This exception is thrown if unsupported encoding used </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.setCorrelationId(String)
|
||||
id: setCorrelationId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setCorrelationId(String correlationId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Message.setCorrelationId(String correlationId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 92
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setCorrelationId(String correlationId)
|
||||
parameters:
|
||||
- id: correlationId
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.setDeliveryAcknowledgement(DeliveryAcknowledgement)
|
||||
id: setDeliveryAcknowledgement(DeliveryAcknowledgement)
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setDeliveryAcknowledgement(DeliveryAcknowledgement deliveryAcknowledgement)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Message.setDeliveryAcknowledgement(DeliveryAcknowledgement deliveryAcknowledgement)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 245
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setDeliveryAcknowledgement(DeliveryAcknowledgement deliveryAcknowledgement)
|
||||
parameters:
|
||||
- id: deliveryAcknowledgement
|
||||
type: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.setExpiryTimeUtc(Date)
|
||||
id: setExpiryTimeUtc(Date)
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setExpiryTimeUtc(Date expiryTimeUtc)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Message.setExpiryTimeUtc(Date expiryTimeUtc)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 67
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setExpiryTimeUtc(Date expiryTimeUtc)
|
||||
parameters:
|
||||
- id: expiryTimeUtc
|
||||
type: "12977444"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.setMessageId(String)
|
||||
id: setMessageId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setMessageId(String messageId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Message.setMessageId(String messageId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 37
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setMessageId(String messageId)
|
||||
parameters:
|
||||
- id: messageId
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.setProperties(Map<String, String>)
|
||||
id: setProperties(Map<String, String>)
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setProperties(Map<String, String> properties)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Message.setProperties(Map<String, String> properties)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 256
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setProperties(Map<String, String> properties)
|
||||
parameters:
|
||||
- id: properties
|
||||
type: 689c8cb5
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.setTo(String)
|
||||
id: setTo(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setTo(String deviceId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Message.setTo(String deviceId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 52
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setTo(String deviceId)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message.setUserId(String)
|
||||
id: setUserId(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._message
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setUserId(String userId)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.Message.setUserId(String userId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Message.java
|
||||
startLine: 108
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setUserId(String userId)
|
||||
parameters:
|
||||
- id: userId
|
||||
type: "26831127"
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: "12977444"
|
||||
spec.java:
|
||||
- name: Date
|
||||
fullName: Date
|
||||
- uid: f03846a9
|
||||
spec.java:
|
||||
- name: ByteArrayInputStream
|
||||
fullName: ByteArrayInputStream
|
||||
- uid: ccd9418d
|
||||
spec.java:
|
||||
- name: byte []
|
||||
fullName: byte []
|
||||
- uid: d5427e37
|
||||
spec.java:
|
||||
- name: UnsupportedEncodingException
|
||||
fullName: UnsupportedEncodingException
|
||||
- uid: 73a378c9
|
||||
spec.java:
|
||||
- name: ByteArrayOutputStream
|
||||
fullName: ByteArrayOutputStream
|
||||
- uid: 689c8cb5
|
||||
spec.java:
|
||||
- name: Map<String, String>
|
||||
fullName: Map<String, String>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_status_code.yml
|
||||
name: FeedbackStatusCode
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackStatusCode
|
||||
type: Enum
|
||||
summary: <p>Enum for feedback status codes </p>
|
||||
syntax:
|
||||
content: public enum FeedbackStatusCode
|
||||
- uid: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.yml
|
||||
name: DeliveryAcknowledgement
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeliveryAcknowledgement
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum DeliveryAcknowledgement
|
||||
|
|
@ -0,0 +1,143 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._receiver
|
||||
id: _receiver
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._receiver.closeAsync()
|
||||
- com.microsoft.azure.iot.service.sdk._receiver.openAsync()
|
||||
- com.microsoft.azure.iot.service.sdk._receiver.receiveAsync()
|
||||
- com.microsoft.azure.iot.service.sdk._receiver.receiveAsync(long)
|
||||
href: com.microsoft.azure.iot.service.sdk._receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: Receiver
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Receiver
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Receiver.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Receiver.java
|
||||
startLine: 14
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: "<p>A receiver is a class abstracting the methods to receive messages, in order to use it for multiple endpoints, e.g. feedback endpoint, “alertsâ€\x9D (i.e. D2C). </p>"
|
||||
syntax:
|
||||
content: public class Receiver
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._receiver.closeAsync()
|
||||
id: closeAsync()
|
||||
parent: com.microsoft.azure.iot.service.sdk._receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: closeAsync()
|
||||
fullName: abstract CompletableFuture<Void> com.microsoft.azure.iot.service.sdk.Receiver.closeAsync()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Receiver.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected abstract CompletableFuture<Void> closeAsync()
|
||||
return:
|
||||
type: ee893aa6
|
||||
- uid: com.microsoft.azure.iot.service.sdk._receiver.openAsync()
|
||||
id: openAsync()
|
||||
parent: com.microsoft.azure.iot.service.sdk._receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: openAsync()
|
||||
fullName: abstract CompletableFuture<Void> com.microsoft.azure.iot.service.sdk.Receiver.openAsync()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Receiver.java
|
||||
startLine: 16
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected abstract CompletableFuture<Void> openAsync()
|
||||
return:
|
||||
type: ee893aa6
|
||||
- uid: com.microsoft.azure.iot.service.sdk._receiver.receiveAsync()
|
||||
id: receiveAsync()
|
||||
parent: com.microsoft.azure.iot.service.sdk._receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: receiveAsync()
|
||||
fullName: abstract CompletableFuture<FeedbackBatch> com.microsoft.azure.iot.service.sdk.Receiver.receiveAsync()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Receiver.java
|
||||
startLine: 19
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected abstract CompletableFuture<FeedbackBatch> receiveAsync()
|
||||
return:
|
||||
type: e4cf4b1ccom.microsoft.azure.iot.service.sdk._feedback_batcha08ddfce
|
||||
- uid: com.microsoft.azure.iot.service.sdk._receiver.receiveAsync(long)
|
||||
id: receiveAsync(long)
|
||||
parent: com.microsoft.azure.iot.service.sdk._receiver
|
||||
href: com.microsoft.azure.iot.service.sdk._receiver.yml
|
||||
langs:
|
||||
- java
|
||||
name: receiveAsync(long timeoutSeconds)
|
||||
fullName: abstract CompletableFuture<FeedbackBatch> com.microsoft.azure.iot.service.sdk.Receiver.receiveAsync(long timeoutSeconds)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Receiver.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected abstract CompletableFuture<FeedbackBatch> receiveAsync(long timeoutSeconds)
|
||||
parameters:
|
||||
- id: timeoutSeconds
|
||||
type: 0364520f
|
||||
return:
|
||||
type: e4cf4b1ccom.microsoft.azure.iot.service.sdk._feedback_batcha08ddfce
|
||||
references:
|
||||
- uid: ee893aa6
|
||||
spec.java:
|
||||
- name: abstract CompletableFuture<Void>
|
||||
fullName: abstract CompletableFuture<Void>
|
||||
- uid: e4cf4b1ccom.microsoft.azure.iot.service.sdk._feedback_batcha08ddfce
|
||||
spec.java:
|
||||
- name: abstract CompletableFuture<
|
||||
fullName: abstract CompletableFuture<
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
name: FeedbackBatch
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
- name: '>'
|
||||
fullName: '>'
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
name: FeedbackReceiver
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackReceiver
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>
|
||||
|
||||
<xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver" data-throw-if-not-resolved="false"></xref> is a specialized receiver whose ReceiveAsync method returns a <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> instead of a <xref href="com.microsoft.azure.iot.service.sdk._message" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
syntax:
|
||||
content: public class FeedbackReceiver extends Receiver
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
name: FeedbackBatch
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatch
|
||||
type: Class
|
||||
summary: <p>Data structure for feedback messages received in Json array Provide getters and setters for batch properties and messages </p>
|
||||
syntax:
|
||||
content: public class FeedbackBatch
|
||||
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
|
|
@ -0,0 +1,85 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._registry_statistics
|
||||
id: _registry_statistics
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._registry_statistics.disabledDeviceCount()
|
||||
- com.microsoft.azure.iot.service.sdk._registry_statistics.enabledDeviceCount()
|
||||
- com.microsoft.azure.iot.service.sdk._registry_statistics.totalDeviceCount()
|
||||
href: com.microsoft.azure.iot.service.sdk._registry_statistics.yml
|
||||
langs:
|
||||
- java
|
||||
name: RegistryStatistics
|
||||
fullName: com.microsoft.azure.iot.service.sdk.RegistryStatistics
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/RegistryStatistics.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/RegistryStatistics.java
|
||||
startLine: 7
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public class RegistryStatistics
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._registry_statistics.disabledDeviceCount()
|
||||
id: disabledDeviceCount()
|
||||
parent: com.microsoft.azure.iot.service.sdk._registry_statistics
|
||||
href: com.microsoft.azure.iot.service.sdk._registry_statistics.yml
|
||||
langs:
|
||||
- java
|
||||
name: disabledDeviceCount
|
||||
fullName: long com.microsoft.azure.iot.service.sdk.RegistryStatistics.disabledDeviceCount
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/RegistryStatistics.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected long disabledDeviceCount
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iot.service.sdk._registry_statistics.enabledDeviceCount()
|
||||
id: enabledDeviceCount()
|
||||
parent: com.microsoft.azure.iot.service.sdk._registry_statistics
|
||||
href: com.microsoft.azure.iot.service.sdk._registry_statistics.yml
|
||||
langs:
|
||||
- java
|
||||
name: enabledDeviceCount
|
||||
fullName: long com.microsoft.azure.iot.service.sdk.RegistryStatistics.enabledDeviceCount
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/RegistryStatistics.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected long enabledDeviceCount
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iot.service.sdk._registry_statistics.totalDeviceCount()
|
||||
id: totalDeviceCount()
|
||||
parent: com.microsoft.azure.iot.service.sdk._registry_statistics
|
||||
href: com.microsoft.azure.iot.service.sdk._registry_statistics.yml
|
||||
langs:
|
||||
- java
|
||||
name: totalDeviceCount
|
||||
fullName: long com.microsoft.azure.iot.service.sdk.RegistryStatistics.totalDeviceCount
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/RegistryStatistics.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected long totalDeviceCount
|
||||
return:
|
||||
type: 0364520f
|
||||
references:
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
|
|
@ -0,0 +1,235 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
id: _service_authentication_with_shared_access_policy_key
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.getKey()
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.getPolicyName()
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.populate(IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.ServiceAuthenticationWithSharedAccessPolicyKey(String,String)
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.setKey(String)
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.setPolicyName(String)
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyKey
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyKey.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyKey.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Extend <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> class, provide getters for protected properties and implement populate function to set <xref href="com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key" data-throw-if-not-resolved="false"></xref> type policy on given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax: &o1
|
||||
content: public class ServiceAuthenticationWithSharedAccessPolicyKey extends AuthenticationMethod
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.key()
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.policyName()
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.token()
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.getKey()
|
||||
id: getKey()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: getKey()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey.getKey()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyKey.java
|
||||
startLine: 77
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for policy key </p>
|
||||
syntax:
|
||||
content: public String getKey()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The policy key string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.getPolicyName()
|
||||
id: getPolicyName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPolicyName()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey.getPolicyName()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyKey.java
|
||||
startLine: 59
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for policy name </p>
|
||||
syntax:
|
||||
content: public String getPolicyName()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The policy name string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.populate(IotHubConnectionString)
|
||||
id: populate(IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: populate(IotHubConnectionString iotHubConnectionString)
|
||||
fullName: IotHubConnectionString com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey.populate(IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyKey.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Populate given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> with proper policy key authentication data</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected IotHubConnectionString populate(IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The iotHubConnectionString object to populate </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The populated <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.ServiceAuthenticationWithSharedAccessPolicyKey(String,String)
|
||||
id: ServiceAuthenticationWithSharedAccessPolicyKey(String,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyKey(String policyName, String key)
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey.ServiceAuthenticationWithSharedAccessPolicyKey(String policyName, String key)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyKey.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Constructor to create instance from policy name and policy key</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public ServiceAuthenticationWithSharedAccessPolicyKey(String policyName, String key)
|
||||
parameters:
|
||||
- id: policyName
|
||||
type: "26831127"
|
||||
description: <p>The policy name string </p>
|
||||
- id: key
|
||||
type: "26831127"
|
||||
description: <p>The policy key string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.setKey(String)
|
||||
id: setKey(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: setKey(String key)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey.setKey(String key)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyKey.java
|
||||
startLine: 86
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for policy key </p>
|
||||
syntax:
|
||||
content: protected void setKey(String key)
|
||||
parameters:
|
||||
- id: key
|
||||
type: "26831127"
|
||||
description: <p>The string value to set </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.setPolicyName(String)
|
||||
id: setPolicyName(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
langs:
|
||||
- java
|
||||
name: setPolicyName(String policyName)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey.setPolicyName(String policyName)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyKey.java
|
||||
startLine: 68
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for policy name </p>
|
||||
syntax:
|
||||
content: protected void setPolicyName(String policyName)
|
||||
parameters:
|
||||
- id: policyName
|
||||
type: "26831127"
|
||||
description: <p>The string value to set </p>
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.key()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: key
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.AuthenticationMethod.key
|
||||
type: Field
|
||||
summary: <p>Shared access policy key (if applies) </p>
|
||||
syntax:
|
||||
content: protected String key
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.policyName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: policyName
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.AuthenticationMethod.policyName
|
||||
type: Field
|
||||
summary: <p>Authentication policy name </p>
|
||||
syntax:
|
||||
content: protected String policyName
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.token()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: token
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.AuthenticationMethod.token
|
||||
type: Field
|
||||
summary: <p>Shared access policy token (if applies) </p>
|
||||
syntax:
|
||||
content: protected String token
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: AuthenticationMethod
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMethod
|
||||
type: Class
|
||||
summary: <p>Class used to abstract the different authentication methods used to use IoT Hub SDK. </p>
|
||||
syntax:
|
||||
content: public class AuthenticationMethod
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
name: IotHubConnectionString
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString
|
||||
type: Class
|
||||
summary: <p>Expose all connections string properties and methods for user, device and connection string serialization. </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionString extends IotHubConnectionStringBuilder
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyKey
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey
|
||||
type: Class
|
||||
summary: <p>Extend <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> class, provide getters for protected properties and implement populate function to set <xref href="com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key" data-throw-if-not-resolved="false"></xref> type policy on given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax: *o1
|
||||
|
|
@ -0,0 +1,235 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
id: _service_authentication_with_shared_access_policy_token
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.getPolicyName()
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.getToken()
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.populate(IotHubConnectionString)
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.ServiceAuthenticationWithSharedAccessPolicyToken(String,String)
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.setPolicyName(String)
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.setToken(String)
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyToken
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyToken.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyToken.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Extend <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> class, provide getters for protected properties and implement populate function to set <xref href="com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token" data-throw-if-not-resolved="false"></xref> type policy on given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax: &o1
|
||||
content: public class ServiceAuthenticationWithSharedAccessPolicyToken extends AuthenticationMethod
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.key()
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.policyName()
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method.token()
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.getPolicyName()
|
||||
id: getPolicyName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPolicyName()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken.getPolicyName()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyToken.java
|
||||
startLine: 59
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for policy name </p>
|
||||
syntax:
|
||||
content: public String getPolicyName()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The policy name string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.getToken()
|
||||
id: getToken()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: getToken()
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken.getToken()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyToken.java
|
||||
startLine: 77
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Getter for policy token </p>
|
||||
syntax:
|
||||
content: public String getToken()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The policy token string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.populate(IotHubConnectionString)
|
||||
id: populate(IotHubConnectionString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: populate(IotHubConnectionString iotHubConnectionString)
|
||||
fullName: IotHubConnectionString com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken.populate(IotHubConnectionString iotHubConnectionString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyToken.java
|
||||
startLine: 23
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Populate given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> with proper policy token authentication data</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected IotHubConnectionString populate(IotHubConnectionString iotHubConnectionString)
|
||||
parameters:
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The iotHubConnectionString object to populate </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The populated <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.ServiceAuthenticationWithSharedAccessPolicyToken(String,String)
|
||||
id: ServiceAuthenticationWithSharedAccessPolicyToken(String,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyToken(String policyName, String token)
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken.ServiceAuthenticationWithSharedAccessPolicyToken(String policyName, String token)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyToken.java
|
||||
startLine: 49
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Constructor to create instance from policy name and policy key</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public ServiceAuthenticationWithSharedAccessPolicyToken(String policyName, String token)
|
||||
parameters:
|
||||
- id: policyName
|
||||
type: "26831127"
|
||||
description: <p>The policy name string </p>
|
||||
- id: token
|
||||
type: "26831127"
|
||||
description: <p>The token string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.setPolicyName(String)
|
||||
id: setPolicyName(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: setPolicyName(String policyName)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken.setPolicyName(String policyName)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyToken.java
|
||||
startLine: 68
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for policy name </p>
|
||||
syntax:
|
||||
content: protected void setPolicyName(String policyName)
|
||||
parameters:
|
||||
- id: policyName
|
||||
type: "26831127"
|
||||
description: <p>The string value to set </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.setToken(String)
|
||||
id: setToken(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: setToken(String token)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken.setToken(String token)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceAuthenticationWithSharedAccessPolicyToken.java
|
||||
startLine: 86
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Setter for policy token </p>
|
||||
syntax:
|
||||
content: protected void setToken(String token)
|
||||
parameters:
|
||||
- id: token
|
||||
type: "26831127"
|
||||
description: <p>The string value to set </p>
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.key()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: key
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.AuthenticationMethod.key
|
||||
type: Field
|
||||
summary: <p>Shared access policy key (if applies) </p>
|
||||
syntax:
|
||||
content: protected String key
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.policyName()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: policyName
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.AuthenticationMethod.policyName
|
||||
type: Field
|
||||
summary: <p>Authentication policy name </p>
|
||||
syntax:
|
||||
content: protected String policyName
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method.token()
|
||||
parent: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: token
|
||||
fullName: String com.microsoft.azure.iot.service.sdk.AuthenticationMethod.token
|
||||
type: Field
|
||||
summary: <p>Shared access policy token (if applies) </p>
|
||||
syntax:
|
||||
content: protected String token
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: AuthenticationMethod
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMethod
|
||||
type: Class
|
||||
summary: <p>Class used to abstract the different authentication methods used to use IoT Hub SDK. </p>
|
||||
syntax:
|
||||
content: public class AuthenticationMethod
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
name: IotHubConnectionString
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString
|
||||
type: Class
|
||||
summary: <p>Expose all connections string properties and methods for user, device and connection string serialization. </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionString extends IotHubConnectionStringBuilder
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyToken
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken
|
||||
type: Class
|
||||
summary: <p>Extend <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> class, provide getters for protected properties and implement populate function to set <xref href="com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token" data-throw-if-not-resolved="false"></xref> type policy on given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax: *o1
|
||||
|
|
@ -0,0 +1,383 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client
|
||||
id: _service_client
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.close()
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.closeAsync()
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.createFromConnectionString(String,IotHubServiceClientProtocol)
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.getFeedbackReceiver(String)
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.iotHubConnectionString()
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.open()
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.openAsync()
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.send(String,Message)
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.sendAsync(String,Message)
|
||||
- com.microsoft.azure.iot.service.sdk._service_client.ServiceClient(IotHubConnectionString,IotHubServiceClientProtocol)
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: ServiceClient
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceClient
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 18
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Extend the <xref href="com.microsoft.azure.iot.service.sdk._service_client" data-throw-if-not-resolved="false"></xref> class and provide AMPQ specific implementation. </p>
|
||||
syntax: &o1
|
||||
content: public class ServiceClient
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.close()
|
||||
id: close()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceClient.close()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 98
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Close AMQP sender </p>
|
||||
syntax: &o3
|
||||
content: public void close()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the AmqpSender object is not initialized </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.closeAsync()
|
||||
id: closeAsync()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: closeAsync()
|
||||
fullName: CompletableFuture<Void> com.microsoft.azure.iot.service.sdk.ServiceClient.closeAsync()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 154
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Provide asynchronous access to <xref href="com.microsoft.azure.iot.service.sdk._service_client.close()" data-throw-if-not-resolved="false"></xref></p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public CompletableFuture<Void> closeAsync()
|
||||
return:
|
||||
type: db03ee24
|
||||
description: <p>The future object for the requested operation </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.createFromConnectionString(String,IotHubServiceClientProtocol)
|
||||
id: createFromConnectionString(String,IotHubServiceClientProtocol)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: createFromConnectionString(String connectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
fullName: static ServiceClient com.microsoft.azure.iot.service.sdk.ServiceClient.createFromConnectionString(String connectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 36
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Create <xref href="com.microsoft.azure.iot.service.sdk._service_client" data-throw-if-not-resolved="false"></xref> from the specified connection string</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static ServiceClient createFromConnectionString(String connectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
parameters:
|
||||
- id: connectionString
|
||||
type: "26831127"
|
||||
description: <p>The connection string for the IotHub </p>
|
||||
- id: iotHubServiceClientProtocol
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._service_client
|
||||
description: <p>The created <xref href="com.microsoft.azure.iot.service.sdk._service_client" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
exceptions:
|
||||
- type: 8a99d4b0
|
||||
description: <p>This exception is thrown if the object creation failed </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.getFeedbackReceiver(String)
|
||||
id: getFeedbackReceiver(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: getFeedbackReceiver(String deviceId)
|
||||
fullName: FeedbackReceiver com.microsoft.azure.iot.service.sdk.ServiceClient.getFeedbackReceiver(String deviceId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 201
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Get <xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver" data-throw-if-not-resolved="false"></xref> object</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public FeedbackReceiver getFeedbackReceiver(String deviceId)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>The device identifier for the target device </p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
description: <p>The instance of the <xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver" data-throw-if-not-resolved="false"></xref></p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.iotHubConnectionString()
|
||||
id: iotHubConnectionString()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: iotHubConnectionString
|
||||
fullName: IotHubConnectionString com.microsoft.azure.iot.service.sdk.ServiceClient.iotHubConnectionString
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: protected IotHubConnectionString iotHubConnectionString
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.open()
|
||||
id: open()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceClient.open()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 83
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Open AMQP sender </p>
|
||||
syntax: &o2
|
||||
content: public void open()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the AmqpSender object is not initialized </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.openAsync()
|
||||
id: openAsync()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: openAsync()
|
||||
fullName: CompletableFuture<Void> com.microsoft.azure.iot.service.sdk.ServiceClient.openAsync()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 132
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Provide asynchronous access to <xref href="com.microsoft.azure.iot.service.sdk._service_client.open()" data-throw-if-not-resolved="false"></xref></p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public CompletableFuture<Void> openAsync()
|
||||
return:
|
||||
type: db03ee24
|
||||
description: <p>The future object for the requested operation </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.send(String,Message)
|
||||
id: send(String,Message)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: send(String deviceId, Message message)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceClient.send(String deviceId, Message message)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 116
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Send a one-way message to the specified device</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o4
|
||||
content: public void send(String deviceId, Message message)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>The device identifier for the target device </p>
|
||||
- id: message
|
||||
type: com.microsoft.azure.iot.service.sdk._message
|
||||
description: <p>The message for the device </p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the AmqpSender object is not initialized </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.sendAsync(String,Message)
|
||||
id: sendAsync(String,Message)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: sendAsync(String deviceId, Message message)
|
||||
fullName: CompletableFuture<Void> com.microsoft.azure.iot.service.sdk.ServiceClient.sendAsync(String deviceId, Message message)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 178
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Provide asynchronous access to <xref href="com.microsoft.azure.iot.service.sdk._service_client.send(String,Message)" data-throw-if-not-resolved="false"></xref></p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public CompletableFuture<Void> sendAsync(String deviceId, Message message)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>The device identifier for the target device </p>
|
||||
- id: message
|
||||
type: com.microsoft.azure.iot.service.sdk._message
|
||||
description: <p>The message for the device </p>
|
||||
return:
|
||||
type: db03ee24
|
||||
description: <p>The future object for the requested operation </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.ServiceClient(IotHubConnectionString,IotHubServiceClientProtocol)
|
||||
id: ServiceClient(IotHubConnectionString,IotHubServiceClientProtocol)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: ServiceClient(IotHubConnectionString iotHubConnectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceClient.ServiceClient(IotHubConnectionString iotHubConnectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceClient.java
|
||||
startLine: 57
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Initialize AMQP sender using given connection string</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected ServiceClient(IotHubConnectionString iotHubConnectionString, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
parameters:
|
||||
- id: iotHubConnectionString
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
description: <p>The ConnectionString object for the IotHub </p>
|
||||
- id: iotHubServiceClientProtocol
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
references:
|
||||
- uid: 8a99d4b0
|
||||
spec.java:
|
||||
- name: Exception
|
||||
fullName: Exception
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: db03ee24
|
||||
spec.java:
|
||||
- name: CompletableFuture<Void>
|
||||
fullName: CompletableFuture<Void>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
name: AmqpSend
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpSend
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close and send methods. Initialize and use AmqpsSendHandler class for low level ampqs operations. </p>
|
||||
syntax:
|
||||
content: public class AmqpSend
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
type: Enum
|
||||
summary: <p>The application-layer protocol used by the service client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubServiceClientProtocol
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
name: IotHubConnectionString
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString
|
||||
type: Class
|
||||
summary: <p>Expose all connections string properties and methods for user, device and connection string serialization. </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionString extends IotHubConnectionStringBuilder
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
name: ServiceClient
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceClient
|
||||
type: Class
|
||||
summary: <p>Extend the <xref href="com.microsoft.azure.iot.service.sdk._service_client" data-throw-if-not-resolved="false"></xref> class and provide AMPQ specific implementation. </p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message
|
||||
type: Class
|
||||
summary: <p>IotHub specific message container </p>
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.open()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceClient.open()
|
||||
type: Method
|
||||
summary: <p>Open AMQP sender </p>
|
||||
syntax: *o2
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.close()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceClient.close()
|
||||
type: Method
|
||||
summary: <p>Close AMQP sender </p>
|
||||
syntax: *o3
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client.send(String,Message)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_client
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
name: send(String deviceId, Message message)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceClient.send(String deviceId, Message message)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Send a one-way message to the specified device</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o4
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
name: FeedbackReceiver
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackReceiver
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>
|
||||
|
||||
<xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver" data-throw-if-not-resolved="false"></xref> is a specialized receiver whose ReceiveAsync method returns a <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> instead of a <xref href="com.microsoft.azure.iot.service.sdk._message" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
syntax:
|
||||
content: public class FeedbackReceiver extends Receiver
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_statistics
|
||||
id: _service_statistics
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._service_statistics.getConnectedDeviceCount()
|
||||
- com.microsoft.azure.iot.service.sdk._service_statistics.setConnectedDeviceCount(long)
|
||||
href: com.microsoft.azure.iot.service.sdk._service_statistics.yml
|
||||
langs:
|
||||
- java
|
||||
name: ServiceStatistics
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceStatistics
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceStatistics.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceStatistics.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Data structure for service statistics received in Json array Provide getters and setters for statistics properties </p>
|
||||
syntax:
|
||||
content: public class ServiceStatistics
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_statistics.getConnectedDeviceCount()
|
||||
id: getConnectedDeviceCount()
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_statistics
|
||||
href: com.microsoft.azure.iot.service.sdk._service_statistics.yml
|
||||
langs:
|
||||
- java
|
||||
name: getConnectedDeviceCount()
|
||||
fullName: long com.microsoft.azure.iot.service.sdk.ServiceStatistics.getConnectedDeviceCount()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceStatistics.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public long getConnectedDeviceCount()
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_statistics.setConnectedDeviceCount(long)
|
||||
id: setConnectedDeviceCount(long)
|
||||
parent: com.microsoft.azure.iot.service.sdk._service_statistics
|
||||
href: com.microsoft.azure.iot.service.sdk._service_statistics.yml
|
||||
langs:
|
||||
- java
|
||||
name: setConnectedDeviceCount(long ConnectedDeviceCount)
|
||||
fullName: void com.microsoft.azure.iot.service.sdk.ServiceStatistics.setConnectedDeviceCount(long ConnectedDeviceCount)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/ServiceStatistics.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
syntax:
|
||||
content: public void setConnectedDeviceCount(long ConnectedDeviceCount)
|
||||
parameters:
|
||||
- id: ConnectedDeviceCount
|
||||
type: 0364520f
|
||||
references:
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
|
|
@ -0,0 +1,267 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._tools
|
||||
id: _tools
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._tools.appendJsonAttribute(StringBuilder,String,String,Boolean,Boolean)
|
||||
- com.microsoft.azure.iot.service.sdk._tools.getNumberValueFromJsonObject(JsonObject,String)
|
||||
- com.microsoft.azure.iot.service.sdk._tools.getValueFromJsonObject(JsonObject,String)
|
||||
- com.microsoft.azure.iot.service.sdk._tools.getValueFromJsonString(JsonString)
|
||||
- com.microsoft.azure.iot.service.sdk._tools.getValueStringByKey(Map,String)
|
||||
- com.microsoft.azure.iot.service.sdk._tools.isNullOrEmpty(String)
|
||||
- com.microsoft.azure.iot.service.sdk._tools.isNullOrWhiteSpace(String)
|
||||
href: com.microsoft.azure.iot.service.sdk._tools.yml
|
||||
langs:
|
||||
- java
|
||||
name: Tools
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Tools
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Tools.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Tools.java
|
||||
startLine: 16
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: <p>Collection of static helper functions </p>
|
||||
syntax:
|
||||
content: public class Tools
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.sdk._tools.appendJsonAttribute(StringBuilder,String,String,Boolean,Boolean)
|
||||
id: appendJsonAttribute(StringBuilder,String,String,Boolean,Boolean)
|
||||
parent: com.microsoft.azure.iot.service.sdk._tools
|
||||
href: com.microsoft.azure.iot.service.sdk._tools.yml
|
||||
langs:
|
||||
- java
|
||||
name: appendJsonAttribute(StringBuilder strBuilder, String name, String value, Boolean isQuoted, Boolean isLast)
|
||||
fullName: static void com.microsoft.azure.iot.service.sdk.Tools.appendJsonAttribute(StringBuilder strBuilder, String name, String value, Boolean isQuoted, Boolean isLast)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Tools.java
|
||||
startLine: 209
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Helper function to properly craft Json string of key-value pair</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static void appendJsonAttribute(StringBuilder strBuilder, String name, String value, Boolean isQuoted, Boolean isLast)
|
||||
parameters:
|
||||
- id: strBuilder
|
||||
type: 2483a40b
|
||||
description: <p>The StringBuilder to work on </p>
|
||||
- id: name
|
||||
type: "26831127"
|
||||
description: <p>The name of the key </p>
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>The value of the key </p>
|
||||
- id: isQuoted
|
||||
type: 866c2227
|
||||
description: <p>If true leading and trailing quotes will be added </p>
|
||||
- id: isLast
|
||||
type: 866c2227
|
||||
description: <p>If false trailing comma will added </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._tools.getNumberValueFromJsonObject(JsonObject,String)
|
||||
id: getNumberValueFromJsonObject(JsonObject,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._tools
|
||||
href: com.microsoft.azure.iot.service.sdk._tools.yml
|
||||
langs:
|
||||
- java
|
||||
name: getNumberValueFromJsonObject(JsonObject jsonObject, String key)
|
||||
fullName: static long com.microsoft.azure.iot.service.sdk.Tools.getNumberValueFromJsonObject(JsonObject jsonObject, String key)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Tools.java
|
||||
startLine: 165
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Helper function to get numeric value from a JsonObject</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static long getNumberValueFromJsonObject(JsonObject jsonObject, String key)
|
||||
parameters:
|
||||
- id: jsonObject
|
||||
type: bdcfe73e
|
||||
description: <p>The JsonObject object to get the value from </p>
|
||||
- id: key
|
||||
type: "26831127"
|
||||
description: <p>The name of the key </p>
|
||||
return:
|
||||
type: 0364520f
|
||||
description: <p>The numeric value </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._tools.getValueFromJsonObject(JsonObject,String)
|
||||
id: getValueFromJsonObject(JsonObject,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._tools
|
||||
href: com.microsoft.azure.iot.service.sdk._tools.yml
|
||||
langs:
|
||||
- java
|
||||
name: getValueFromJsonObject(JsonObject jsonObject, String key)
|
||||
fullName: static String com.microsoft.azure.iot.service.sdk.Tools.getValueFromJsonObject(JsonObject jsonObject, String key)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Tools.java
|
||||
startLine: 100
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Helper function to get a value from the given JsonObject if the key name exists</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static String getValueFromJsonObject(JsonObject jsonObject, String key)
|
||||
parameters:
|
||||
- id: jsonObject
|
||||
type: bdcfe73e
|
||||
description: <p>The JsonObject object to get the value from </p>
|
||||
- id: key
|
||||
type: "26831127"
|
||||
description: <p>The name of the key </p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The value of the given key if exists otherwise empty string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._tools.getValueFromJsonString(JsonString)
|
||||
id: getValueFromJsonString(JsonString)
|
||||
parent: com.microsoft.azure.iot.service.sdk._tools
|
||||
href: com.microsoft.azure.iot.service.sdk._tools.yml
|
||||
langs:
|
||||
- java
|
||||
name: getValueFromJsonString(JsonString jsonString)
|
||||
fullName: static String com.microsoft.azure.iot.service.sdk.Tools.getValueFromJsonString(JsonString jsonString)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Tools.java
|
||||
startLine: 133
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Helper function to get trim the leading and trailing parenthesis from a Json string if they exists</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static String getValueFromJsonString(JsonString jsonString)
|
||||
parameters:
|
||||
- id: jsonString
|
||||
type: bd82ee46
|
||||
description: <p>The JsonString to trim </p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The trimmed string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._tools.getValueStringByKey(Map,String)
|
||||
id: getValueStringByKey(Map,String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._tools
|
||||
href: com.microsoft.azure.iot.service.sdk._tools.yml
|
||||
langs:
|
||||
- java
|
||||
name: getValueStringByKey(Map map, String keyName)
|
||||
fullName: static String com.microsoft.azure.iot.service.sdk.Tools.getValueStringByKey(Map map, String keyName)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Tools.java
|
||||
startLine: 69
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Helper function to get a value from the given Map if the key name exists</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static String getValueStringByKey(Map map, String keyName)
|
||||
parameters:
|
||||
- id: map
|
||||
type: 05eaf346
|
||||
description: <p>The Map object to get the value from </p>
|
||||
- id: keyName
|
||||
type: "26831127"
|
||||
description: <p>The name of the key </p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The value of the given key if exists otherwise empty string </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._tools.isNullOrEmpty(String)
|
||||
id: isNullOrEmpty(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._tools
|
||||
href: com.microsoft.azure.iot.service.sdk._tools.yml
|
||||
langs:
|
||||
- java
|
||||
name: isNullOrEmpty(String value)
|
||||
fullName: static Boolean com.microsoft.azure.iot.service.sdk.Tools.isNullOrEmpty(String value)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Tools.java
|
||||
startLine: 24
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Helper function to check if the input string is null or empty</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static Boolean isNullOrEmpty(String value)
|
||||
parameters:
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>The string to check </p>
|
||||
return:
|
||||
type: 866c2227
|
||||
description: <p>The value true if the input string is empty or null </p>
|
||||
- uid: com.microsoft.azure.iot.service.sdk._tools.isNullOrWhiteSpace(String)
|
||||
id: isNullOrWhiteSpace(String)
|
||||
parent: com.microsoft.azure.iot.service.sdk._tools
|
||||
href: com.microsoft.azure.iot.service.sdk._tools.yml
|
||||
langs:
|
||||
- java
|
||||
name: isNullOrWhiteSpace(String value)
|
||||
fullName: static Boolean com.microsoft.azure.iot.service.sdk.Tools.isNullOrWhiteSpace(String value)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/Tools.java
|
||||
startLine: 45
|
||||
package: com.microsoft.azure.iot.service.sdk
|
||||
summary: >-
|
||||
<p>Helper function to check if the input string is null or contains only whitespace(s)</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static Boolean isNullOrWhiteSpace(String value)
|
||||
parameters:
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>The string to check </p>
|
||||
return:
|
||||
type: 866c2227
|
||||
description: <p>The value true if the input string is empty or contains only whitespace(s) </p>
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 866c2227
|
||||
spec.java:
|
||||
- name: Boolean
|
||||
fullName: Boolean
|
||||
- uid: 05eaf346
|
||||
spec.java:
|
||||
- name: Map
|
||||
fullName: Map
|
||||
- uid: bdcfe73e
|
||||
spec.java:
|
||||
- name: JsonObject
|
||||
fullName: JsonObject
|
||||
- uid: bd82ee46
|
||||
spec.java:
|
||||
- name: JsonString
|
||||
fullName: JsonString
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: 2483a40b
|
||||
spec.java:
|
||||
- name: StringBuilder
|
||||
fullName: StringBuilder
|
||||
|
|
@ -0,0 +1,314 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.sdk
|
||||
id: sdk
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_mechanism
|
||||
- com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
- com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
- com.microsoft.azure.iot.service.sdk._device
|
||||
- com.microsoft.azure.iot.service.sdk._device_connection_state
|
||||
- com.microsoft.azure.iot.service.sdk._device_deserializer
|
||||
- com.microsoft.azure.iot.service.sdk._device_serializer
|
||||
- com.microsoft.azure.iot.service.sdk._device_status
|
||||
- com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_batch_message
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
- com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
- com.microsoft.azure.iot.service.sdk._import_mode
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
- com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties._job_status
|
||||
- com.microsoft.azure.iot.service.sdk._job_properties._job_type
|
||||
- com.microsoft.azure.iot.service.sdk._message
|
||||
- com.microsoft.azure.iot.service.sdk._receiver
|
||||
- com.microsoft.azure.iot.service.sdk._registry_manager
|
||||
- com.microsoft.azure.iot.service.sdk._registry_statistics
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
- com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
- com.microsoft.azure.iot.service.sdk._service_client
|
||||
- com.microsoft.azure.iot.service.sdk._service_statistics
|
||||
- com.microsoft.azure.iot.service.sdk._tools
|
||||
href: com.microsoft.azure.iot.service.sdk.yml
|
||||
langs:
|
||||
- java
|
||||
name: com.microsoft.azure.iot.service.sdk
|
||||
fullName: com.microsoft.azure.iot.service.sdk
|
||||
type: Namespace
|
||||
source:
|
||||
remote:
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMechanism.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/sdk/AuthenticationMechanism.java
|
||||
startLine: 5
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iot.service.sdk
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_mechanism
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_mechanism.yml
|
||||
name: AuthenticationMechanism
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMechanism
|
||||
type: Class
|
||||
summary: <p>Authentication mechanism, used to store the device symmetric key. </p>
|
||||
syntax:
|
||||
content: public class AuthenticationMechanism
|
||||
- uid: com.microsoft.azure.iot.service.sdk._authentication_method
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._authentication_method.yml
|
||||
name: AuthenticationMethod
|
||||
fullName: com.microsoft.azure.iot.service.sdk.AuthenticationMethod
|
||||
type: Class
|
||||
summary: <p>Class used to abstract the different authentication methods used to use IoT Hub SDK. </p>
|
||||
syntax:
|
||||
content: public class AuthenticationMethod
|
||||
- uid: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._delivery_acknowledgement.yml
|
||||
name: DeliveryAcknowledgement
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeliveryAcknowledgement
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum DeliveryAcknowledgement
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device.yml
|
||||
name: Device
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Device
|
||||
type: Class
|
||||
summary: <p>The <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class extends the <xref href="com.microsoft.azure.iot.service.sdk._device" data-throw-if-not-resolved="false"></xref> class implementing constructors and serialization functionality. </p>
|
||||
syntax:
|
||||
content: public class Device
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_connection_state
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device_connection_state.yml
|
||||
name: DeviceConnectionState
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceConnectionState
|
||||
type: Enum
|
||||
summary: <p>Enum for device connection state </p>
|
||||
syntax:
|
||||
content: public enum DeviceConnectionState
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_deserializer
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device_deserializer.yml
|
||||
name: DeviceDeserializer
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceDeserializer
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class DeviceDeserializer
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_serializer
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device_serializer.yml
|
||||
name: DeviceSerializer
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceSerializer
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class DeviceSerializer
|
||||
- uid: com.microsoft.azure.iot.service.sdk._device_status
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._device_status.yml
|
||||
name: DeviceStatus
|
||||
fullName: com.microsoft.azure.iot.service.sdk.DeviceStatus
|
||||
type: Enum
|
||||
summary: <p>Enum for device status </p>
|
||||
syntax:
|
||||
content: public enum DeviceStatus
|
||||
- uid: com.microsoft.azure.iot.service.sdk._export_import_device
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._export_import_device.yml
|
||||
name: ExportImportDevice
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ExportImportDevice
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class ExportImportDevice
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
name: FeedbackBatch
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatch
|
||||
type: Class
|
||||
summary: <p>Data structure for feedback messages received in Json array Provide getters and setters for batch properties and messages </p>
|
||||
syntax:
|
||||
content: public class FeedbackBatch
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch_message
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch_message.yml
|
||||
name: FeedbackBatchMessage
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatchMessage
|
||||
type: Class
|
||||
summary: <p>Provide static function to parse Json string to <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax:
|
||||
content: public class FeedbackBatchMessage
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_receiver
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_receiver.yml
|
||||
name: FeedbackReceiver
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackReceiver
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>
|
||||
|
||||
<xref href="com.microsoft.azure.iot.service.sdk._feedback_receiver" data-throw-if-not-resolved="false"></xref> is a specialized receiver whose ReceiveAsync method returns a <xref href="com.microsoft.azure.iot.service.sdk._feedback_batch" data-throw-if-not-resolved="false"></xref> instead of a <xref href="com.microsoft.azure.iot.service.sdk._message" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
syntax:
|
||||
content: public class FeedbackReceiver extends Receiver
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_record
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_record.yml
|
||||
name: FeedbackRecord
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackRecord
|
||||
type: Class
|
||||
summary: <p>Data structure for feedback record received Provide getters and setters for feedback record batch properties </p>
|
||||
syntax:
|
||||
content: public class FeedbackRecord
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_status_code
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_status_code.yml
|
||||
name: FeedbackStatusCode
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackStatusCode
|
||||
type: Enum
|
||||
summary: <p>Enum for feedback status codes </p>
|
||||
syntax:
|
||||
content: public enum FeedbackStatusCode
|
||||
- uid: com.microsoft.azure.iot.service.sdk._import_mode
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._import_mode.yml
|
||||
name: ImportMode
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ImportMode
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum ImportMode
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string.yml
|
||||
name: IotHubConnectionString
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionString
|
||||
type: Class
|
||||
summary: <p>Expose all connections string properties and methods for user, device and connection string serialization. </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionString extends IotHubConnectionStringBuilder
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_connection_string_builder.yml
|
||||
name: IotHubConnectionStringBuilder
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubConnectionStringBuilder
|
||||
type: Class
|
||||
summary: <p>Provide static constructors to create <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object </p>
|
||||
syntax:
|
||||
content: public class IotHubConnectionStringBuilder
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
type: Enum
|
||||
summary: <p>The application-layer protocol used by the service client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubServiceClientProtocol
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties.yml
|
||||
name: JobProperties
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class JobProperties
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message
|
||||
type: Class
|
||||
summary: <p>IotHub specific message container </p>
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iot.service.sdk._receiver
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._receiver.yml
|
||||
name: Receiver
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Receiver
|
||||
type: Class
|
||||
summary: "<p>A receiver is a class abstracting the methods to receive messages, in order to use it for multiple endpoints, e.g. feedback endpoint, “alertsâ€\x9D (i.e. D2C). </p>"
|
||||
syntax:
|
||||
content: public class Receiver
|
||||
- uid: com.microsoft.azure.iot.service.sdk._registry_manager
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._registry_manager.yml
|
||||
name: RegistryManager
|
||||
fullName: com.microsoft.azure.iot.service.sdk.RegistryManager
|
||||
type: Class
|
||||
summary: <p>Use the <xref href="com.microsoft.azure.iot.service.sdk._registry_manager" data-throw-if-not-resolved="false"></xref> class to manage the identity registry in IoT Hubs. </p>
|
||||
syntax:
|
||||
content: public class RegistryManager
|
||||
- uid: com.microsoft.azure.iot.service.sdk._registry_statistics
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._registry_statistics.yml
|
||||
name: RegistryStatistics
|
||||
fullName: com.microsoft.azure.iot.service.sdk.RegistryStatistics
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class RegistryStatistics
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key.yml
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyKey
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyKey
|
||||
type: Class
|
||||
summary: <p>Extend <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> class, provide getters for protected properties and implement populate function to set <xref href="com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_key" data-throw-if-not-resolved="false"></xref> type policy on given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax:
|
||||
content: public class ServiceAuthenticationWithSharedAccessPolicyKey extends AuthenticationMethod
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token.yml
|
||||
name: ServiceAuthenticationWithSharedAccessPolicyToken
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceAuthenticationWithSharedAccessPolicyToken
|
||||
type: Class
|
||||
summary: <p>Extend <xref href="com.microsoft.azure.iot.service.sdk._authentication_method" data-throw-if-not-resolved="false"></xref> class, provide getters for protected properties and implement populate function to set <xref href="com.microsoft.azure.iot.service.sdk._service_authentication_with_shared_access_policy_token" data-throw-if-not-resolved="false"></xref> type policy on given <xref href="com.microsoft.azure.iot.service.sdk._iot_hub_connection_string" data-throw-if-not-resolved="false"></xref> object. </p>
|
||||
syntax:
|
||||
content: public class ServiceAuthenticationWithSharedAccessPolicyToken extends AuthenticationMethod
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_client
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._service_client.yml
|
||||
name: ServiceClient
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceClient
|
||||
type: Class
|
||||
summary: <p>Extend the <xref href="com.microsoft.azure.iot.service.sdk._service_client" data-throw-if-not-resolved="false"></xref> class and provide AMPQ specific implementation. </p>
|
||||
syntax:
|
||||
content: public class ServiceClient
|
||||
- uid: com.microsoft.azure.iot.service.sdk._service_statistics
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._service_statistics.yml
|
||||
name: ServiceStatistics
|
||||
fullName: com.microsoft.azure.iot.service.sdk.ServiceStatistics
|
||||
type: Class
|
||||
summary: <p>Data structure for service statistics received in Json array Provide getters and setters for statistics properties </p>
|
||||
syntax:
|
||||
content: public class ServiceStatistics
|
||||
- uid: com.microsoft.azure.iot.service.sdk._tools
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._tools.yml
|
||||
name: Tools
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Tools
|
||||
type: Class
|
||||
summary: <p>Collection of static helper functions </p>
|
||||
syntax:
|
||||
content: public class Tools
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties._job_status
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties._job_status.yml
|
||||
name: JobProperties.JobStatus
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties.JobStatus
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum JobStatus
|
||||
- uid: com.microsoft.azure.iot.service.sdk._job_properties._job_type
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._job_properties._job_type.yml
|
||||
name: JobProperties.JobType
|
||||
fullName: com.microsoft.azure.iot.service.sdk.JobProperties.JobType
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum JobType
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport._transport_utils
|
||||
id: _transport_utils
|
||||
parent: com.microsoft.azure.iot.service.transport
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport._transport_utils.javaServiceClientIdentifier()
|
||||
- com.microsoft.azure.iot.service.transport._transport_utils.serviceVersion()
|
||||
- com.microsoft.azure.iot.service.transport._transport_utils.versionIdentifierKey()
|
||||
href: com.microsoft.azure.iot.service.transport._transport_utils.yml
|
||||
langs:
|
||||
- java
|
||||
name: TransportUtils
|
||||
fullName: com.microsoft.azure.iot.service.transport.TransportUtils
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/TransportUtils.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/TransportUtils.java
|
||||
startLine: 5
|
||||
package: com.microsoft.azure.iot.service.transport
|
||||
syntax:
|
||||
content: public class TransportUtils
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.transport._transport_utils.javaServiceClientIdentifier()
|
||||
id: javaServiceClientIdentifier()
|
||||
parent: com.microsoft.azure.iot.service.transport._transport_utils
|
||||
href: com.microsoft.azure.iot.service.transport._transport_utils.yml
|
||||
langs:
|
||||
- java
|
||||
name: javaServiceClientIdentifier
|
||||
fullName: String com.microsoft.azure.iot.service.transport.TransportUtils.javaServiceClientIdentifier
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/TransportUtils.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iot.service.transport
|
||||
syntax:
|
||||
content: public static String javaServiceClientIdentifier= "com.microsoft.azure.iot.service.sdk/"
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.transport._transport_utils.serviceVersion()
|
||||
id: serviceVersion()
|
||||
parent: com.microsoft.azure.iot.service.transport._transport_utils
|
||||
href: com.microsoft.azure.iot.service.transport._transport_utils.yml
|
||||
langs:
|
||||
- java
|
||||
name: serviceVersion
|
||||
fullName: String com.microsoft.azure.iot.service.transport.TransportUtils.serviceVersion
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/TransportUtils.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.transport
|
||||
syntax:
|
||||
content: public static String serviceVersion= "1.0.11"
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.transport._transport_utils.versionIdentifierKey()
|
||||
id: versionIdentifierKey()
|
||||
parent: com.microsoft.azure.iot.service.transport._transport_utils
|
||||
href: com.microsoft.azure.iot.service.transport._transport_utils.yml
|
||||
langs:
|
||||
- java
|
||||
name: versionIdentifierKey
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.TransportUtils.versionIdentifierKey
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/TransportUtils.java
|
||||
startLine: 8
|
||||
package: com.microsoft.azure.iot.service.transport
|
||||
summary: <p>Version identifier key </p>
|
||||
syntax:
|
||||
content: public static final String versionIdentifierKey= "com.microsoft:client-version"
|
||||
return:
|
||||
type: 3d93591e
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event
|
||||
id: _amqp_feedback_received_event
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.onFeedbackReceived(String)
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpFeedbackReceivedEvent
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedEvent
|
||||
type: Interface
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedEvent.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedEvent.java
|
||||
startLine: 7
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public interface AmqpFeedbackReceivedEvent
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.onFeedbackReceived(String)
|
||||
id: onFeedbackReceived(String)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.yml
|
||||
langs:
|
||||
- java
|
||||
name: onFeedbackReceived(String feedbackJson)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedEvent.onFeedbackReceived(String feedbackJson)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedEvent.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public void onFeedbackReceived(String feedbackJson)
|
||||
parameters:
|
||||
- id: feedbackJson
|
||||
type: "26831127"
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
name: AmqpReceive
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpReceive
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close methods and feedback received event. </p>
|
||||
syntax:
|
||||
content: public class AmqpReceive
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.onFeedbackReceived(String)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
name: onFeedbackReceived(String feedbackJson)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpReceive.onFeedbackReceived(String feedbackJson)
|
||||
type: Method
|
||||
summary: <p>Handle on feedback received Proton event Parse received json and save result to a member variable Release semaphore for wait function </p>
|
||||
syntax:
|
||||
content: public void onFeedbackReceived(String feedbackJson)
|
||||
parameters:
|
||||
- id: feedbackJson
|
||||
type: "26831127"
|
||||
description: <p>Received Json string to process </p>
|
||||
|
|
@ -0,0 +1,330 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
id: _amqp_feedback_received_handler
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.AmqpFeedbackReceivedHandler(String,String,String,IotHubServiceClientProtocol,AmqpFeedbackReceivedEvent)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.ENDPOINT()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.iotHubServiceClientProtocol()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.onConnectionBound(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.onConnectionInit(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.onDelivery(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.onLinkInit(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.RECEIVE_TAG()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.SEND_PORT_AMQPS()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.SEND_PORT_AMQPS_WS()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.WEBSOCKET_PATH()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.WEBSOCKET_SUB_PROTOCOL()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.webSocketHostName()
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpFeedbackReceivedHandler
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 30
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class to override the events what are needed to handle the receive operation Contains and sets connection parameters (path, port, endpoint) Maintains the layers of AMQP protocol (Link, Session, Connection, Transport) Creates and sets SASL authentication for transport </p>
|
||||
syntax:
|
||||
content: public class AmqpFeedbackReceivedHandler
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- BaseHandler
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.AmqpFeedbackReceivedHandler(String,String,String,IotHubServiceClientProtocol,AmqpFeedbackReceivedEvent)
|
||||
id: AmqpFeedbackReceivedHandler(String,String,String,IotHubServiceClientProtocol,AmqpFeedbackReceivedEvent)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpFeedbackReceivedHandler(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, AmqpFeedbackReceivedEvent amqpFeedbackReceivedEvent)
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.AmqpFeedbackReceivedHandler(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, AmqpFeedbackReceivedEvent amqpFeedbackReceivedEvent)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 56
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Constructor to set up connection parameters and initialize handshaker and flow controller for transport </p>
|
||||
syntax:
|
||||
content: public AmqpFeedbackReceivedHandler(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, AmqpFeedbackReceivedEvent amqpFeedbackReceivedEvent)
|
||||
parameters:
|
||||
- id: hostName
|
||||
type: "26831127"
|
||||
description: '<p>The address string of the service (example: AAA.BBB.CCC) </p>'
|
||||
- id: userName
|
||||
type: "26831127"
|
||||
description: '<p>The username string to use SASL authentication (example: <ulink url="mailto:user@sas.service">user@sas.service</ulink>) </p>'
|
||||
- id: sasToken
|
||||
type: "26831127"
|
||||
description: <p>The SAS token string </p>
|
||||
- id: iotHubServiceClientProtocol
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
- id: amqpFeedbackReceivedEvent
|
||||
type: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event
|
||||
description: <p>callback to delegate the received message to the user API </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.ENDPOINT()
|
||||
id: ENDPOINT()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: ENDPOINT
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.ENDPOINT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String ENDPOINT= "/messages/servicebound/feedback"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.iotHubServiceClientProtocol()
|
||||
id: iotHubServiceClientProtocol()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: iotHubServiceClientProtocol
|
||||
fullName: final IotHubServiceClientProtocol com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.iotHubServiceClientProtocol
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 43
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final IotHubServiceClientProtocol iotHubServiceClientProtocol
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.onConnectionBound(Event)
|
||||
id: onConnectionBound(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: onConnectionBound(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.onConnectionBound(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 131
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public void onConnectionBound(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.onConnectionInit(Event)
|
||||
id: onConnectionInit(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: onConnectionInit(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.onConnectionInit(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 154
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public void onConnectionInit(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.onDelivery(Event)
|
||||
id: onDelivery(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: onDelivery(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.onDelivery(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 101
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Event handler for the on delivery event </p>
|
||||
syntax:
|
||||
content: public void onDelivery(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The proton event object </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.onLinkInit(Event)
|
||||
id: onLinkInit(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: onLinkInit(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.onLinkInit(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 186
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public void onLinkInit(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.RECEIVE_TAG()
|
||||
id: RECEIVE_TAG()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: RECEIVE_TAG
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.RECEIVE_TAG
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 32
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String RECEIVE_TAG= "receiver"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.SEND_PORT_AMQPS()
|
||||
id: SEND_PORT_AMQPS()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: SEND_PORT_AMQPS
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.SEND_PORT_AMQPS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 33
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String SEND_PORT_AMQPS= ":5671"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.SEND_PORT_AMQPS_WS()
|
||||
id: SEND_PORT_AMQPS_WS()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: SEND_PORT_AMQPS_WS
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.SEND_PORT_AMQPS_WS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 34
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String SEND_PORT_AMQPS_WS= ":443"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.WEBSOCKET_PATH()
|
||||
id: WEBSOCKET_PATH()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: WEBSOCKET_PATH
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.WEBSOCKET_PATH
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 36
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String WEBSOCKET_PATH= "/$iothub/websocket"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.WEBSOCKET_SUB_PROTOCOL()
|
||||
id: WEBSOCKET_SUB_PROTOCOL()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: WEBSOCKET_SUB_PROTOCOL
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.WEBSOCKET_SUB_PROTOCOL
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 37
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String WEBSOCKET_SUB_PROTOCOL= "AMQPWSB10"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.webSocketHostName()
|
||||
id: webSocketHostName()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: webSocketHostName
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler.webSocketHostName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedHandler.java
|
||||
startLine: 44
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final String webSocketHostName
|
||||
return:
|
||||
type: 3d93591e
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 93de0ef9com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 70fceca4
|
||||
spec.java:
|
||||
- name: Event
|
||||
fullName: Event
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.yml
|
||||
name: AmqpFeedbackReceivedEvent
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedEvent
|
||||
type: Interface
|
||||
syntax:
|
||||
content: public interface AmqpFeedbackReceivedEvent
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
type: Enum
|
||||
summary: <p>The application-layer protocol used by the service client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubServiceClientProtocol
|
||||
|
|
@ -0,0 +1,249 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
id: _amqp_receive
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_receive.AmqpReceive(String,String,String,IotHubServiceClientProtocol)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_receive.close()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_receive.onFeedbackReceived(String)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_receive.onReactorInit(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_receive.open()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_receive.receive(long)
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpReceive
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpReceive
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpReceive.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpReceive.java
|
||||
startLine: 24
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close methods and feedback received event. </p>
|
||||
syntax: &o1
|
||||
content: public class AmqpReceive implements AmqpFeedbackReceivedEvent
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- BaseHandler
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.AmqpReceive(String,String,String,IotHubServiceClientProtocol)
|
||||
id: AmqpReceive(String,String,String,IotHubServiceClientProtocol)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpReceive(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpReceive.AmqpReceive(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpReceive.java
|
||||
startLine: 41
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Constructor to set up connection parameters </p>
|
||||
syntax:
|
||||
content: public AmqpReceive(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
parameters:
|
||||
- id: hostName
|
||||
type: "26831127"
|
||||
description: '<p>The address string of the service (example: AAA.BBB.CCC) </p>'
|
||||
- id: userName
|
||||
type: "26831127"
|
||||
description: '<p>The username string to use SASL authentication (example: <ulink url="mailto:user@sas.service">user@sas.service</ulink>) </p>'
|
||||
- id: sasToken
|
||||
type: "26831127"
|
||||
description: <p>The SAS token string </p>
|
||||
- id: iotHubServiceClientProtocol
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.close()
|
||||
id: close()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
langs:
|
||||
- java
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpReceive.close()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpReceive.java
|
||||
startLine: 79
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Invalidate AmqpsReceiveHandler member variable </p>
|
||||
syntax:
|
||||
content: public void close()
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.onFeedbackReceived(String)
|
||||
id: onFeedbackReceived(String)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
langs:
|
||||
- java
|
||||
name: onFeedbackReceived(String feedbackJson)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpReceive.onFeedbackReceived(String feedbackJson)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpReceive.java
|
||||
startLine: 124
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Handle on feedback received Proton event Parse received json and save result to a member variable Release semaphore for wait function </p>
|
||||
syntax:
|
||||
content: public void onFeedbackReceived(String feedbackJson)
|
||||
parameters:
|
||||
- id: feedbackJson
|
||||
type: "26831127"
|
||||
description: <p>Received Json string to process </p>
|
||||
overridden: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.onFeedbackReceived(String)
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.onReactorInit(Event)
|
||||
id: onReactorInit(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
langs:
|
||||
- java
|
||||
name: onReactorInit(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpReceive.onReactorInit(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpReceive.java
|
||||
startLine: 55
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Event handler for the reactor init event </p>
|
||||
syntax:
|
||||
content: public void onReactorInit(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The proton event object </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.open()
|
||||
id: open()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
langs:
|
||||
- java
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpReceive.open()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpReceive.java
|
||||
startLine: 70
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Create AmqpsReceiveHandler and store it in a member variable </p>
|
||||
syntax:
|
||||
content: public void open()
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.receive(long)
|
||||
id: receive(long)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
langs:
|
||||
- java
|
||||
name: receive(long timeoutMs)
|
||||
fullName: synchronized FeedbackBatch com.microsoft.azure.iot.service.transport.amqps.AmqpReceive.receive(long timeoutMs)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpReceive.java
|
||||
startLine: 93
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Synchronized call to receive feedback batch Hide the event based receiving mechanism from the user API </p>
|
||||
syntax:
|
||||
content: public synchronized FeedbackBatch receive(long timeoutMs)
|
||||
parameters:
|
||||
- id: timeoutMs
|
||||
type: 0364520f
|
||||
description: <p>The timeout in milliseconds to wait for feedback </p>
|
||||
return:
|
||||
type: cffad4f2com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
description: <p>The received feedback batch </p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the input <xref href="com.microsoft.azure.iot.service.transport.amqps._amqp_receive" data-throw-if-not-resolved="false"></xref> object is null </p>
|
||||
- type: 8256ba40
|
||||
description: <p>This exception is thrown if the receive process has been interrupted </p>
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 70fceca4
|
||||
spec.java:
|
||||
- name: Event
|
||||
fullName: Event
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: 8256ba40
|
||||
spec.java:
|
||||
- name: InterruptedException
|
||||
fullName: InterruptedException
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: cffad4f2com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
spec.java:
|
||||
- name: 'synchronized '
|
||||
fullName: 'synchronized '
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
name: FeedbackBatch
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatch
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.yml
|
||||
name: AmqpFeedbackReceivedEvent
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedEvent
|
||||
type: Interface
|
||||
syntax:
|
||||
content: public interface AmqpFeedbackReceivedEvent
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
name: AmqpFeedbackReceivedHandler
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class to override the events what are needed to handle the receive operation Contains and sets connection parameters (path, port, endpoint) Maintains the layers of AMQP protocol (Link, Session, Connection, Transport) Creates and sets SASL authentication for transport </p>
|
||||
syntax:
|
||||
content: public class AmqpFeedbackReceivedHandler
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
type: Enum
|
||||
summary: <p>The application-layer protocol used by the service client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubServiceClientProtocol
|
||||
- uid: com.microsoft.azure.iot.service.sdk._feedback_batch
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._feedback_batch.yml
|
||||
name: FeedbackBatch
|
||||
fullName: com.microsoft.azure.iot.service.sdk.FeedbackBatch
|
||||
type: Class
|
||||
summary: <p>Data structure for feedback messages received in Json array Provide getters and setters for batch properties and messages </p>
|
||||
syntax:
|
||||
content: public class FeedbackBatch
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
name: AmqpReceive
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpReceive
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close methods and feedback received event. </p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.onFeedbackReceived(String)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.yml
|
||||
name: onFeedbackReceived(String feedbackJson)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedEvent.onFeedbackReceived(String feedbackJson)
|
||||
type: Method
|
||||
syntax:
|
||||
content: public void onFeedbackReceived(String feedbackJson)
|
||||
parameters:
|
||||
- id: feedbackJson
|
||||
type: "26831127"
|
||||
|
|
@ -0,0 +1,311 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
id: _amqp_send
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.AmqpSend(String,String,String,IotHubServiceClientProtocol)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.amqpSendHandler()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.close()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.hostName()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.iotHubServiceClientProtocol()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.onReactorInit(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.open()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.reactor()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.sasToken()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.send(String,Message)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send.userName()
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpSend
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpSend
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 23
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close and send methods. Initialize and use AmqpsSendHandler class for low level ampqs operations. </p>
|
||||
syntax: &o1
|
||||
content: public class AmqpSend
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- BaseHandler
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.AmqpSend(String,String,String,IotHubServiceClientProtocol)
|
||||
id: AmqpSend(String,String,String,IotHubServiceClientProtocol)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpSend(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpSend.AmqpSend(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 38
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Constructor to set up connection parameters </p>
|
||||
syntax:
|
||||
content: public AmqpSend(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
parameters:
|
||||
- id: hostName
|
||||
type: "26831127"
|
||||
description: '<p>The address string of the service (example: AAA.BBB.CCC) </p>'
|
||||
- id: userName
|
||||
type: "26831127"
|
||||
description: '<p>The username string to use SASL authentication (example: <ulink url="mailto:user@sas.service">user@sas.service</ulink>) </p>'
|
||||
- id: sasToken
|
||||
type: "26831127"
|
||||
description: <p>The SAS token string </p>
|
||||
- id: iotHubServiceClientProtocol
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.amqpSendHandler()
|
||||
id: amqpSendHandler()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: amqpSendHandler
|
||||
fullName: AmqpSendHandler com.microsoft.azure.iot.service.transport.amqps.AmqpSend.amqpSendHandler
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 29
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected AmqpSendHandler amqpSendHandler
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.close()
|
||||
id: close()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpSend.close()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 90
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Invalidate AmqpsSendHandler member variable </p>
|
||||
syntax:
|
||||
content: public void close()
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.hostName()
|
||||
id: hostName()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: hostName
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSend.hostName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 25
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final String hostName
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.iotHubServiceClientProtocol()
|
||||
id: iotHubServiceClientProtocol()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: iotHubServiceClientProtocol
|
||||
fullName: IotHubServiceClientProtocol com.microsoft.azure.iot.service.transport.amqps.AmqpSend.iotHubServiceClientProtocol
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 30
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected IotHubServiceClientProtocol iotHubServiceClientProtocol
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.onReactorInit(Event)
|
||||
id: onReactorInit(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: onReactorInit(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpSend.onReactorInit(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 66
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Event handler for the reactor init event </p>
|
||||
syntax:
|
||||
content: public void onReactorInit(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The proton event object </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.open()
|
||||
id: open()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpSend.open()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 81
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Create AmqpsSendHandler and store it in a member variable </p>
|
||||
syntax:
|
||||
content: public void open()
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.reactor()
|
||||
id: reactor()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: reactor
|
||||
fullName: Reactor com.microsoft.azure.iot.service.transport.amqps.AmqpSend.reactor
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 28
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected Reactor reactor= null
|
||||
return:
|
||||
type: 5f183614
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.sasToken()
|
||||
id: sasToken()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: sasToken
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSend.sasToken
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 27
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final String sasToken
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.send(String,Message)
|
||||
id: send(String,Message)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: send(String deviceId, Message message)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpSend.send(String deviceId, Message message)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 104
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Create binary message Initialize and start Proton reactor Send the created message </p>
|
||||
syntax:
|
||||
content: public void send(String deviceId, Message message)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>The device name string </p>
|
||||
- id: message
|
||||
type: com.microsoft.azure.iot.service.sdk._message
|
||||
description: <p>The message to be sent </p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the <xref href="com.microsoft.azure.iot.service.transport.amqps._amqp_send" data-throw-if-not-resolved="false"></xref> object is not initialized </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send.userName()
|
||||
id: userName()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
langs:
|
||||
- java
|
||||
name: userName
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSend.userName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSend.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final String userName
|
||||
return:
|
||||
type: 3d93591e
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 5f183614
|
||||
spec.java:
|
||||
- name: Reactor
|
||||
fullName: Reactor
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 70fceca4
|
||||
spec.java:
|
||||
- name: Event
|
||||
fullName: Event
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
name: AmqpSendHandler
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class to override the events what are needed to handle the send operation Contains and sets connection parameters (path, port, endpoint) Maintains the layers of AMQP protocol (Link, Session, Connection, Transport) Creates and sets SASL authentication for transport </p>
|
||||
syntax:
|
||||
content: public class AmqpSendHandler
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
type: Enum
|
||||
summary: <p>The application-layer protocol used by the service client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubServiceClientProtocol
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message
|
||||
type: Class
|
||||
summary: <p>IotHub specific message container </p>
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
name: AmqpSend
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpSend
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close and send methods. Initialize and use AmqpsSendHandler class for low level ampqs operations. </p>
|
||||
syntax: *o1
|
||||
|
|
@ -0,0 +1,461 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
id: _amqp_send_handler
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.AmqpSendHandler(String,String,String,IotHubServiceClientProtocol)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.createProtonMessage(String,Message)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.DEVICE_PATH_FORMAT()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.ENDPOINT()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.hostName()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.iotHubServiceClientProtocol()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.onConnectionBound(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.onConnectionInit(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.onLinkFlow(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.onLinkInit(Event)
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.protonMessage()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.sasToken()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.SEND_PORT_AMQPS()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.SEND_PORT_AMQPS_WS()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.SEND_TAG()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.userName()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.WEBSOCKET_PATH()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.WEBSOCKET_SUB_PROTOCOL()
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.webSocketHostName()
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpSendHandler
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 33
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class to override the events what are needed to handle the send operation Contains and sets connection parameters (path, port, endpoint) Maintains the layers of AMQP protocol (Link, Session, Connection, Transport) Creates and sets SASL authentication for transport </p>
|
||||
syntax:
|
||||
content: public class AmqpSendHandler
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- BaseHandler
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.AmqpSendHandler(String,String,String,IotHubServiceClientProtocol)
|
||||
id: AmqpSendHandler(String,String,String,IotHubServiceClientProtocol)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpSendHandler(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.AmqpSendHandler(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 59
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: >-
|
||||
<p>Constructor to set up connection parameters and initialize handshaker for transport</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public AmqpSendHandler(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)
|
||||
parameters:
|
||||
- id: hostName
|
||||
type: "26831127"
|
||||
description: '<p>The address string of the service (example: AAA.BBB.CCC) </p>'
|
||||
- id: userName
|
||||
type: "26831127"
|
||||
description: '<p>The username string to use SASL authentication (example: <ulink url="mailto:user@sas.service">user@sas.service</ulink>) </p>'
|
||||
- id: sasToken
|
||||
type: "26831127"
|
||||
description: <p>The SAS token string </p>
|
||||
- id: iotHubServiceClientProtocol
|
||||
type: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.createProtonMessage(String,Message)
|
||||
id: createProtonMessage(String,Message)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: createProtonMessage(String deviceId, Message message)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.createProtonMessage(String deviceId, Message message)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 111
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Create Proton message from deviceId and content string </p>
|
||||
syntax:
|
||||
content: public void createProtonMessage(String deviceId, Message message)
|
||||
parameters:
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>The device name string </p>
|
||||
- id: message
|
||||
type: com.microsoft.azure.iot.service.sdk._message
|
||||
description: <p>The message to be sent </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.DEVICE_PATH_FORMAT()
|
||||
id: DEVICE_PATH_FORMAT()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: DEVICE_PATH_FORMAT
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.DEVICE_PATH_FORMAT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 39
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String DEVICE_PATH_FORMAT= "/devices/%s/messages/devicebound"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.ENDPOINT()
|
||||
id: ENDPOINT()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: ENDPOINT
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.ENDPOINT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 38
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String ENDPOINT= "/messages/devicebound"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.hostName()
|
||||
id: hostName()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: hostName
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.hostName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 43
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final String hostName
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.iotHubServiceClientProtocol()
|
||||
id: iotHubServiceClientProtocol()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: iotHubServiceClientProtocol
|
||||
fullName: final IotHubServiceClientProtocol com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.iotHubServiceClientProtocol
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 49
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final IotHubServiceClientProtocol iotHubServiceClientProtocol
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.onConnectionBound(Event)
|
||||
id: onConnectionBound(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: onConnectionBound(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.onConnectionBound(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 169
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Event handler for the connection bound event </p>
|
||||
syntax:
|
||||
content: public void onConnectionBound(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The proton event object </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.onConnectionInit(Event)
|
||||
id: onConnectionInit(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: onConnectionInit(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.onConnectionInit(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 198
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Event handler for the connection init event </p>
|
||||
syntax:
|
||||
content: public void onConnectionInit(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The proton event object </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.onLinkFlow(Event)
|
||||
id: onLinkFlow(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: onLinkFlow(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.onLinkFlow(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 249
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Event handler for the link flow event </p>
|
||||
syntax:
|
||||
content: public void onLinkFlow(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The proton event object </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.onLinkInit(Event)
|
||||
id: onLinkInit(Event)
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: onLinkInit(Event event)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.onLinkInit(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 234
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
summary: <p>Event handler for the link init event </p>
|
||||
syntax:
|
||||
content: public void onLinkInit(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The proton event object </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.protonMessage()
|
||||
id: protonMessage()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: protonMessage
|
||||
fullName: org.apache.qpid.proton.message.Message com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.protonMessage
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 46
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected org.apache.qpid.proton.message.Message protonMessage
|
||||
return:
|
||||
type: a06b47b9
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.sasToken()
|
||||
id: sasToken()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: sasToken
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.sasToken
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 45
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final String sasToken
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.SEND_PORT_AMQPS()
|
||||
id: SEND_PORT_AMQPS()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: SEND_PORT_AMQPS
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.SEND_PORT_AMQPS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 36
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String SEND_PORT_AMQPS= ":5671"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.SEND_PORT_AMQPS_WS()
|
||||
id: SEND_PORT_AMQPS_WS()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: SEND_PORT_AMQPS_WS
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.SEND_PORT_AMQPS_WS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 37
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String SEND_PORT_AMQPS_WS= ":443"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.SEND_TAG()
|
||||
id: SEND_TAG()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: SEND_TAG
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.SEND_TAG
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String SEND_TAG= "sender"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.userName()
|
||||
id: userName()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: userName
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.userName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 44
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final String userName
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.WEBSOCKET_PATH()
|
||||
id: WEBSOCKET_PATH()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: WEBSOCKET_PATH
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.WEBSOCKET_PATH
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 40
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String WEBSOCKET_PATH= "/$iothub/websocket"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.WEBSOCKET_SUB_PROTOCOL()
|
||||
id: WEBSOCKET_SUB_PROTOCOL()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: WEBSOCKET_SUB_PROTOCOL
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.WEBSOCKET_SUB_PROTOCOL
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 41
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: public static final String WEBSOCKET_SUB_PROTOCOL= "AMQPWSB10"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.webSocketHostName()
|
||||
id: webSocketHostName()
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
langs:
|
||||
- java
|
||||
name: webSocketHostName
|
||||
fullName: final String com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler.webSocketHostName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpSendHandler.java
|
||||
startLine: 50
|
||||
package: com.microsoft.azure.iot.service.transport.amqps
|
||||
syntax:
|
||||
content: protected final String webSocketHostName
|
||||
return:
|
||||
type: 3d93591e
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: a06b47b9
|
||||
spec.java:
|
||||
- name: org.apache.qpid.proton.message.Message
|
||||
fullName: org.apache.qpid.proton.message.Message
|
||||
- uid: 93de0ef9com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 70fceca4
|
||||
spec.java:
|
||||
- name: Event
|
||||
fullName: Event
|
||||
- uid: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._iot_hub_service_client_protocol.yml
|
||||
name: IotHubServiceClientProtocol
|
||||
fullName: com.microsoft.azure.iot.service.sdk.IotHubServiceClientProtocol
|
||||
type: Enum
|
||||
summary: <p>The application-layer protocol used by the service client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubServiceClientProtocol
|
||||
- uid: com.microsoft.azure.iot.service.sdk._message
|
||||
parent: com.microsoft.azure.iot.service.sdk
|
||||
href: com.microsoft.azure.iot.service.sdk._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iot.service.sdk.Message
|
||||
type: Class
|
||||
summary: <p>IotHub specific message container </p>
|
||||
syntax:
|
||||
content: public class Message
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps
|
||||
id: amqps
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
- com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
href: com.microsoft.azure.iot.service.transport.amqps.yml
|
||||
langs:
|
||||
- java
|
||||
name: com.microsoft.azure.iot.service.transport.amqps
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps
|
||||
type: Namespace
|
||||
source:
|
||||
remote:
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedEvent.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/amqps/AmqpFeedbackReceivedEvent.java
|
||||
startLine: 5
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iot.service.transport.amqps
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_event.yml
|
||||
name: AmqpFeedbackReceivedEvent
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedEvent
|
||||
type: Interface
|
||||
syntax:
|
||||
content: public interface AmqpFeedbackReceivedEvent
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_feedback_received_handler.yml
|
||||
name: AmqpFeedbackReceivedHandler
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpFeedbackReceivedHandler
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class to override the events what are needed to handle the receive operation Contains and sets connection parameters (path, port, endpoint) Maintains the layers of AMQP protocol (Link, Session, Connection, Transport) Creates and sets SASL authentication for transport </p>
|
||||
syntax:
|
||||
content: public class AmqpFeedbackReceivedHandler
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_receive
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_receive.yml
|
||||
name: AmqpReceive
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpReceive
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close methods and feedback received event. </p>
|
||||
syntax:
|
||||
content: public class AmqpReceive implements AmqpFeedbackReceivedEvent
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send.yml
|
||||
name: AmqpSend
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpSend
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close and send methods. Initialize and use AmqpsSendHandler class for low level ampqs operations. </p>
|
||||
syntax:
|
||||
content: public class AmqpSend
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler
|
||||
parent: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps._amqp_send_handler.yml
|
||||
name: AmqpSendHandler
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps.AmqpSendHandler
|
||||
type: Class
|
||||
summary: <p>Instance of the QPID-Proton-J BaseHandler class to override the events what are needed to handle the send operation Contains and sets connection parameters (path, port, endpoint) Maintains the layers of AMQP protocol (Link, Session, Connection, Transport) Creates and sets SASL authentication for transport </p>
|
||||
syntax:
|
||||
content: public class AmqpSendHandler
|
||||
|
|
@ -0,0 +1,444 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
id: _http_connection
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.body()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.connect()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.connection()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.getResponseHeaders()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.getResponseStatus()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.HttpConnection()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.HttpConnection(URL,HttpMethod)
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.readError()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.readInput()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.readInputStream(InputStream)
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.setReadTimeoutMillis(int)
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.setRequestHeader(String,String)
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.setRequestMethod(HttpMethod)
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection.writeOutput(byte [])
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpConnection
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpConnection
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 28
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>A wrapper for the Java SE class HttpsURLConnection. Used to avoid compatibility issues when testing with the mocking framework JMockit, as well as to avoid some undocumented side effects when using HttpsURLConnection. </p>
|
||||
|
||||
<p>The underlying HttpsURLConnection is transparently managed by Java. To reuse connections, for each time <xref href="com.microsoft.azure.iot.service.transport.http._http_connection.connect()" data-throw-if-not-resolved="false"></xref> is called, the input streams (input stream or error stream, if input stream is not accessible) must be completely read. Otherwise, the data remains in the stream and the connection will not be reusable. </p>
|
||||
syntax:
|
||||
content: public class HttpConnection
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.body()
|
||||
id: body()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: body
|
||||
fullName: byte [] com.microsoft.azure.iot.service.transport.http.HttpConnection.body
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 38
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: <p>The body. HttpsURLConnection silently calls <xref href="com.microsoft.azure.iot.service.transport.http._http_connection.connect()" data-throw-if-not-resolved="false"></xref> when the output stream is written to. We buffer the body and defer writing to the output stream until <xref href="com.microsoft.azure.iot.service.transport.http._http_connection.connect()" data-throw-if-not-resolved="false"></xref> is called. </p>
|
||||
syntax:
|
||||
content: protected byte [] body
|
||||
return:
|
||||
type: ccd9418d
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.connect()
|
||||
id: connect()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: connect()
|
||||
fullName: void com.microsoft.azure.iot.service.transport.http.HttpConnection.connect()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 75
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Sends the request to the URL given in the constructor.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o1
|
||||
content: public void connect()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception thrown if the connection could not be established, or the server responded with a bad status code. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.connection()
|
||||
id: connection()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: connection
|
||||
fullName: final HttpsURLConnection com.microsoft.azure.iot.service.transport.http.HttpConnection.connection
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 31
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: <p>The underlying HTTPS connection. </p>
|
||||
syntax:
|
||||
content: protected final HttpsURLConnection connection
|
||||
return:
|
||||
type: 9d854a40
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.getResponseHeaders()
|
||||
id: getResponseHeaders()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: getResponseHeaders()
|
||||
fullName: Map<String, List<String>> com.microsoft.azure.iot.service.transport.http.HttpConnection.getResponseHeaders()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 247
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Returns the response headers as a Map, where the key is the header field name and the values are the values associated with the header field name.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public Map<String, List<String>> getResponseHeaders()
|
||||
return:
|
||||
type: b2319095
|
||||
description: <p>the response headers.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception thrown if no response was received. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.getResponseStatus()
|
||||
id: getResponseStatus()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: getResponseStatus()
|
||||
fullName: int com.microsoft.azure.iot.service.transport.http.HttpConnection.getResponseStatus()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 231
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Returns the response status code.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public int getResponseStatus()
|
||||
return:
|
||||
type: f75371fa
|
||||
description: <p>The response status code.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception thrown if no response was received. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.HttpConnection()
|
||||
id: HttpConnection()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpConnection()
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpConnection.HttpConnection()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 285
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: protected HttpConnection()
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.HttpConnection(URL,HttpMethod)
|
||||
id: HttpConnection(URL,HttpMethod)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpConnection(URL url, HttpMethod method)
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpConnection.HttpConnection(URL url, HttpMethod method)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 48
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Constructor. Opens a connection to the given URL.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public HttpConnection(URL url, HttpMethod method)
|
||||
parameters:
|
||||
- id: url
|
||||
type: a891b3e6
|
||||
description: <p>The URL for the HTTPS connection. </p>
|
||||
- id: method
|
||||
type: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
description: <p>The HTTPS method (i.e. GET).</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception is thrown if the connection was unable to be opened. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.readError()
|
||||
id: readError()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: readError()
|
||||
fullName: byte [] com.microsoft.azure.iot.service.transport.http.HttpConnection.readError()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 206
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Reads from the error stream and returns the error reason.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public byte [] readError()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>The error reason.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception thrown if the input stream could not be accessed, for example if the server could not be reached. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.readInput()
|
||||
id: readInput()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: readInput()
|
||||
fullName: byte [] com.microsoft.azure.iot.service.transport.http.HttpConnection.readInput()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 186
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Reads from the input stream (response stream) and returns the response.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public byte [] readInput()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>The response body.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception thrown if the input stream could not be accessed, for example if the server could not be reached. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.readInputStream(InputStream)
|
||||
id: readInputStream(InputStream)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: readInputStream(InputStream stream)
|
||||
fullName: static byte [] com.microsoft.azure.iot.service.transport.http.HttpConnection.readInputStream(InputStream stream)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 263
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Reads the input stream until the stream is empty.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static byte [] readInputStream(InputStream stream)
|
||||
parameters:
|
||||
- id: stream
|
||||
type: 76fcb9b7
|
||||
description: <p>The input stream.</p>
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>The content of the input stream.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception thrown if the input stream could not be read from. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.setReadTimeoutMillis(int)
|
||||
id: setReadTimeoutMillis(int)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: setReadTimeoutMillis(int timeout)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.http.HttpConnection.setReadTimeoutMillis(int timeout)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 141
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Sets the read timeout in milliseconds. The read timeout is the number of milliseconds after the server receives a request and before the server sends data back.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setReadTimeoutMillis(int timeout)
|
||||
parameters:
|
||||
- id: timeout
|
||||
type: f75371fa
|
||||
description: <p>The read timeout. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.setRequestHeader(String,String)
|
||||
id: setRequestHeader(String,String)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: setRequestHeader(String field, String value)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.http.HttpConnection.setRequestHeader(String field, String value)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 128
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Sets the request header field to the given value.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setRequestHeader(String field, String value)
|
||||
parameters:
|
||||
- id: field
|
||||
type: "26831127"
|
||||
description: <p>The header field name. </p>
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>The header field value. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.setRequestMethod(HttpMethod)
|
||||
id: setRequestMethod(HttpMethod)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: setRequestMethod(HttpMethod method)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.http.HttpConnection.setRequestMethod(HttpMethod method)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 98
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Sets the request method (i.e. POST).</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setRequestMethod(HttpMethod method)
|
||||
parameters:
|
||||
- id: method
|
||||
type: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
description: <p>The request method.</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>This exception thrown if the request currently has a non-empty body and the new method is not a POST or a PUT. This is because Java's HttpsURLConnection silently converts the HTTPS method to POST or PUT if a body is written to the request. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.writeOutput(byte [])
|
||||
id: writeOutput(byte [])
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: writeOutput(byte[] body)
|
||||
fullName: void com.microsoft.azure.iot.service.transport.http.HttpConnection.writeOutput(byte[] body)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 157
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Saves the body to be sent with the request.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void writeOutput(byte[] body)
|
||||
parameters:
|
||||
- id: body
|
||||
type: ccd9418d
|
||||
description: <p>The request body.</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if the request does not currently use method POST or PUT and the body is non-empty. This is because Java's HttpsURLConnection silently converts the HTTPS method to POST or PUT if a body is written to the request. </p>
|
||||
references:
|
||||
- uid: 9d854a40
|
||||
spec.java:
|
||||
- name: final HttpsURLConnection
|
||||
fullName: final HttpsURLConnection
|
||||
- uid: ccd9418d
|
||||
spec.java:
|
||||
- name: byte []
|
||||
fullName: byte []
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: a891b3e6
|
||||
spec.java:
|
||||
- name: URL
|
||||
fullName: URL
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
- uid: b2319095
|
||||
spec.java:
|
||||
- name: Map<String, List<String>>
|
||||
fullName: Map<String, List<String>>
|
||||
- uid: 76fcb9b7
|
||||
spec.java:
|
||||
- name: InputStream
|
||||
fullName: InputStream
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection.connect()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
name: connect()
|
||||
fullName: void com.microsoft.azure.iot.service.transport.http.HttpConnection.connect()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Sends the request to the URL given in the constructor.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_method.yml
|
||||
name: HttpMethod
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMethod
|
||||
type: Enum
|
||||
summary: <p>The HTTPS request method (i.e. GET). </p>
|
||||
syntax:
|
||||
content: public enum HttpMethod
|
||||
|
|
@ -0,0 +1,93 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_message
|
||||
id: _http_message
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.http._http_message.getBody()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_message.getContentType()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_message.HTTPS_APP_PROPERTY_PREFIX()
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpMessage
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMessage
|
||||
type: Interface
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMessage.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMessage.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: <p>An HTTPS message. An HTTPS message is distinguished from a plain IoT Hub message by its property names, which are prefixed with 'iothub-app-'; and by the explicit specification of a content-type. </p>
|
||||
syntax:
|
||||
content: public interface HttpMessage
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_message.getBody()
|
||||
id: getBody()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_message
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getBody()
|
||||
fullName: byte [] com.microsoft.azure.iot.service.transport.http.HttpMessage.getBody()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMessage.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: <p>Gets the message body. </p>
|
||||
syntax:
|
||||
content: public byte [] getBody()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>The message body. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_message.getContentType()
|
||||
id: getContentType()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_message
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getContentType()
|
||||
fullName: String com.microsoft.azure.iot.service.transport.http.HttpMessage.getContentType()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMessage.java
|
||||
startLine: 27
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: <p>Gets the content type string. </p>
|
||||
syntax:
|
||||
content: public String getContentType()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The message content-type. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_message.HTTPS_APP_PROPERTY_PREFIX()
|
||||
id: HTTPS_APP_PROPERTY_PREFIX()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_message
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: HTTPS_APP_PROPERTY_PREFIX
|
||||
fullName: String com.microsoft.azure.iot.service.transport.http.HttpMessage.HTTPS_APP_PROPERTY_PREFIX
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMessage.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: <p>The prefix to be added to an HTTPS application-defined property. </p>
|
||||
syntax:
|
||||
content: public String HTTPS_APP_PROPERTY_PREFIX= "iothub-app-"
|
||||
return:
|
||||
type: "26831127"
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: ccd9418d
|
||||
spec.java:
|
||||
- name: byte []
|
||||
fullName: byte []
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
id: _http_method
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.http._http_method.DELETE()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_method.GET()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_method.POST()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_method.PUT()
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpMethod
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMethod
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMethod.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMethod.java
|
||||
startLine: 8
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: <p>The HTTPS request method (i.e. GET). </p>
|
||||
syntax:
|
||||
content: public enum HttpMethod
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<HttpMethod>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_method.DELETE()
|
||||
id: DELETE()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: DELETE
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMethod.DELETE
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMethod.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: public DELETE
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_method.GET()
|
||||
id: GET()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: GET
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMethod.GET
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMethod.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: public GET
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_method.POST()
|
||||
id: POST()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: POST
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMethod.POST
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMethod.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: public POST
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_method.PUT()
|
||||
id: PUT()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_method.yml
|
||||
langs:
|
||||
- java
|
||||
name: PUT
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMethod.PUT
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpMethod.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: public PUT
|
||||
references: []
|
||||
|
|
@ -0,0 +1,252 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
id: _http_request
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.http._http_request.connection()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_request.HttpRequest()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_request.HttpRequest(URL,HttpMethod,byte [])
|
||||
- com.microsoft.azure.iot.service.transport.http._http_request.send()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_request.setHeaderField(String,String)
|
||||
- com.microsoft.azure.iot.service.transport.http._http_request.setReadTimeoutMillis(int)
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_request.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpRequest
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpRequest
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpRequest.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpRequest.java
|
||||
startLine: 14
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax: &o1
|
||||
content: public class HttpRequest
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_request.connection()
|
||||
id: connection()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_request.yml
|
||||
langs:
|
||||
- java
|
||||
name: connection
|
||||
fullName: final HttpConnection com.microsoft.azure.iot.service.transport.http.HttpRequest.connection
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpRequest.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: <p>The underlying HTTPS connection stream. </p>
|
||||
syntax:
|
||||
content: protected final HttpConnection connection
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_request.HttpRequest()
|
||||
id: HttpRequest()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_request.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpRequest()
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpRequest.HttpRequest()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpRequest.java
|
||||
startLine: 120
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: protected HttpRequest()
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_request.HttpRequest(URL,HttpMethod,byte [])
|
||||
id: HttpRequest(URL,HttpMethod,byte [])
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_request.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpRequest(URL url, HttpMethod method, byte[] body)
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpRequest.HttpRequest(URL url, HttpMethod method, byte[] body)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpRequest.java
|
||||
startLine: 32
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Constructor. Takes a URL as an argument and returns an HTTPS request that is ready to be sent.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public HttpRequest(URL url, HttpMethod method, byte[] body)
|
||||
parameters:
|
||||
- id: url
|
||||
type: a891b3e6
|
||||
description: <p>The URL for the request. </p>
|
||||
- id: method
|
||||
type: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
description: <p>The HTTPS request method (i.e. GET). </p>
|
||||
- id: body
|
||||
type: ccd9418d
|
||||
description: <p>The request body. Must be an array of size 0 if the request method is GET or DELETE.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception thrown if an IOException occurs in setting up the HTTPS connection. </p>
|
||||
- type: 3c87bd19
|
||||
description: <p>This exception thrown if the endpoint given does not use the HTTPS protocol. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_request.send()
|
||||
id: send()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_request.yml
|
||||
langs:
|
||||
- java
|
||||
name: send()
|
||||
fullName: HttpResponse com.microsoft.azure.iot.service.transport.http.HttpRequest.send()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpRequest.java
|
||||
startLine: 51
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Executes the HTTPS request.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public HttpResponse send()
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
description: <p>The HTTPS response.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>This exception thrown if the connection could not be established, or the input/output streams could not be accessed. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_request.setHeaderField(String,String)
|
||||
id: setHeaderField(String,String)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_request.yml
|
||||
langs:
|
||||
- java
|
||||
name: setHeaderField(String field, String value)
|
||||
fullName: HttpRequest com.microsoft.azure.iot.service.transport.http.HttpRequest.setHeaderField(String field, String value)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpRequest.java
|
||||
startLine: 97
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Sets the header field to the given value.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public HttpRequest setHeaderField(String field, String value)
|
||||
parameters:
|
||||
- id: field
|
||||
type: "26831127"
|
||||
description: <p>The header field name. </p>
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>The header field value.</p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
description: <p>The object itself, for fluent setting. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_request.setReadTimeoutMillis(int)
|
||||
id: setReadTimeoutMillis(int)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_request.yml
|
||||
langs:
|
||||
- java
|
||||
name: setReadTimeoutMillis(int timeout)
|
||||
fullName: HttpRequest com.microsoft.azure.iot.service.transport.http.HttpRequest.setReadTimeoutMillis(int timeout)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpRequest.java
|
||||
startLine: 113
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Sets the read timeout, in milliseconds, for the request. The read timeout is the number of milliseconds after the server receives a request and before the server sends data back.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public HttpRequest setReadTimeoutMillis(int timeout)
|
||||
parameters:
|
||||
- id: timeout
|
||||
type: f75371fa
|
||||
description: <p>The read timeout.</p>
|
||||
return:
|
||||
type: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
description: <p>The object itself, for fluent setting. </p>
|
||||
references:
|
||||
- uid: 93de0ef9com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
name: HttpConnection
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpConnection
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: a891b3e6
|
||||
spec.java:
|
||||
- name: URL
|
||||
fullName: URL
|
||||
- uid: ccd9418d
|
||||
spec.java:
|
||||
- name: byte []
|
||||
fullName: byte []
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
name: HttpConnection
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpConnection
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>A wrapper for the Java SE class HttpsURLConnection. Used to avoid compatibility issues when testing with the mocking framework JMockit, as well as to avoid some undocumented side effects when using HttpsURLConnection. </p>
|
||||
|
||||
<p>The underlying HttpsURLConnection is transparently managed by Java. To reuse connections, for each time <xref href="com.microsoft.azure.iot.service.transport.http._http_connection.connect()" data-throw-if-not-resolved="false"></xref> is called, the input streams (input stream or error stream, if input stream is not accessible) must be completely read. Otherwise, the data remains in the stream and the connection will not be reusable. </p>
|
||||
syntax:
|
||||
content: public class HttpConnection
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_method.yml
|
||||
name: HttpMethod
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMethod
|
||||
type: Enum
|
||||
summary: <p>The HTTPS request method (i.e. GET). </p>
|
||||
syntax:
|
||||
content: public enum HttpMethod
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
name: HttpResponse
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpResponse
|
||||
type: Class
|
||||
summary: <p>An HTTPS response. Contains the status code, body, header fields, and error reason (if any). </p>
|
||||
syntax:
|
||||
content: public class HttpResponse
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_request.yml
|
||||
name: HttpRequest
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpRequest
|
||||
type: Class
|
||||
syntax: *o1
|
||||
|
|
@ -0,0 +1,363 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
id: _http_response
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.body()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.canonicalizeFieldName(String)
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.errorReason()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.flattenValuesList(List<String>)
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.getBody()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.getErrorReason()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.getHeaderField(String)
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.getHeaderFields()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.getStatus()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.headerFields()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.HttpResponse()
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.HttpResponse(int,byte [],Map<String, List<String>>,byte [])
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response.status()
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpResponse
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpResponse
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 16
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: <p>An HTTPS response. Contains the status code, body, header fields, and error reason (if any). </p>
|
||||
syntax:
|
||||
content: public class HttpResponse
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.body()
|
||||
id: body()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: body
|
||||
fullName: final byte [] com.microsoft.azure.iot.service.transport.http.HttpResponse.body
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 19
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: protected final byte [] body
|
||||
return:
|
||||
type: f549433f
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.canonicalizeFieldName(String)
|
||||
id: canonicalizeFieldName(String)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: canonicalizeFieldName(String field)
|
||||
fullName: static String com.microsoft.azure.iot.service.transport.http.HttpResponse.canonicalizeFieldName(String field)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 132
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: protected static String canonicalizeFieldName(String field)
|
||||
parameters:
|
||||
- id: field
|
||||
type: "26831127"
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.errorReason()
|
||||
id: errorReason()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: errorReason
|
||||
fullName: final byte [] com.microsoft.azure.iot.service.transport.http.HttpResponse.errorReason
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: protected final byte [] errorReason
|
||||
return:
|
||||
type: f549433f
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.flattenValuesList(List<String>)
|
||||
id: flattenValuesList(List<String>)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: flattenValuesList(List<String> values)
|
||||
fullName: static String com.microsoft.azure.iot.service.transport.http.HttpResponse.flattenValuesList(List<String> values)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 143
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: protected static String flattenValuesList(List<String> values)
|
||||
parameters:
|
||||
- id: values
|
||||
type: 7d60c20e
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.getBody()
|
||||
id: getBody()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: getBody()
|
||||
fullName: byte [] com.microsoft.azure.iot.service.transport.http.HttpResponse.getBody()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 70
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Getter for the response body.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public byte [] getBody()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>The response body. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.getErrorReason()
|
||||
id: getErrorReason()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: getErrorReason()
|
||||
fullName: byte [] com.microsoft.azure.iot.service.transport.http.HttpResponse.getErrorReason()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 126
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Getter for the error reason.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public byte [] getErrorReason()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>The error reason. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.getHeaderField(String)
|
||||
id: getHeaderField(String)
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: getHeaderField(String field)
|
||||
fullName: String com.microsoft.azure.iot.service.transport.http.HttpResponse.getHeaderField(String field)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 87
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Getter for a header field.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getHeaderField(String field)
|
||||
parameters:
|
||||
- id: field
|
||||
type: "26831127"
|
||||
description: <p>the header field name.</p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the header field value. If multiple values are present, they are returned as a comma-separated list according to RFC2616.</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if no value exists for the given field name. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.getHeaderFields()
|
||||
id: getHeaderFields()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: getHeaderFields()
|
||||
fullName: Map<String, String> com.microsoft.azure.iot.service.transport.http.HttpResponse.getHeaderFields()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 110
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Getter for the header fields.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public Map<String, String> getHeaderFields()
|
||||
return:
|
||||
type: 689c8cb5
|
||||
description: <p>The copy of the header fields for this response. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.getStatus()
|
||||
id: getStatus()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStatus()
|
||||
fullName: int com.microsoft.azure.iot.service.transport.http.HttpResponse.getStatus()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 59
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Getter for the HTTPS status code.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public int getStatus()
|
||||
return:
|
||||
type: f75371fa
|
||||
description: <p>The HTTPS status code. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.headerFields()
|
||||
id: headerFields()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: headerFields
|
||||
fullName: final Map<String, String> com.microsoft.azure.iot.service.transport.http.HttpResponse.headerFields
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: protected final Map<String, String> headerFields
|
||||
return:
|
||||
type: 15b3ef59
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.HttpResponse()
|
||||
id: HttpResponse()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpResponse()
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpResponse.HttpResponse()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 157
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: protected HttpResponse()
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.HttpResponse(int,byte [],Map<String, List<String>>,byte [])
|
||||
id: HttpResponse(int,byte [],Map<String, List<String>>,byte [])
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpResponse(int status, byte[] body, Map<String, List<String>> headerFields, byte[] errorReason)
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpResponse.HttpResponse(int status, byte[] body, Map<String, List<String>> headerFields, byte[] errorReason)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 31
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
summary: >-
|
||||
<p>Constructor.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public HttpResponse(int status, byte[] body, Map<String, List<String>> headerFields, byte[] errorReason)
|
||||
parameters:
|
||||
- id: status
|
||||
type: f75371fa
|
||||
description: <p>The HTTPS status code. </p>
|
||||
- id: body
|
||||
type: ccd9418d
|
||||
description: <p>The response body. </p>
|
||||
- id: headerFields
|
||||
type: b2319095
|
||||
description: <p>The map of header field names and the values associated with the field name. </p>
|
||||
- id: errorReason
|
||||
type: ccd9418d
|
||||
description: <p>The error reason. </p>
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response.status()
|
||||
id: status()
|
||||
parent: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
langs:
|
||||
- java
|
||||
name: status
|
||||
fullName: final int com.microsoft.azure.iot.service.transport.http.HttpResponse.status
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpResponse.java
|
||||
startLine: 18
|
||||
package: com.microsoft.azure.iot.service.transport.http
|
||||
syntax:
|
||||
content: protected final int status
|
||||
return:
|
||||
type: cd225469
|
||||
references:
|
||||
- uid: cd225469
|
||||
spec.java:
|
||||
- name: final int
|
||||
fullName: final int
|
||||
- uid: f549433f
|
||||
spec.java:
|
||||
- name: final byte []
|
||||
fullName: final byte []
|
||||
- uid: 15b3ef59
|
||||
spec.java:
|
||||
- name: final Map<String, String>
|
||||
fullName: final Map<String, String>
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
- uid: ccd9418d
|
||||
spec.java:
|
||||
- name: byte []
|
||||
fullName: byte []
|
||||
- uid: b2319095
|
||||
spec.java:
|
||||
- name: Map<String, List<String>>
|
||||
fullName: Map<String, List<String>>
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 689c8cb5
|
||||
spec.java:
|
||||
- name: Map<String, String>
|
||||
fullName: Map<String, String>
|
||||
- uid: 7d60c20e
|
||||
spec.java:
|
||||
- name: List<String>
|
||||
fullName: List<String>
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport.http
|
||||
id: http
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
- com.microsoft.azure.iot.service.transport.http._http_message
|
||||
- com.microsoft.azure.iot.service.transport.http._http_method
|
||||
- com.microsoft.azure.iot.service.transport.http._http_request
|
||||
- com.microsoft.azure.iot.service.transport.http._http_response
|
||||
href: com.microsoft.azure.iot.service.transport.http.yml
|
||||
langs:
|
||||
- java
|
||||
name: com.microsoft.azure.iot.service.transport.http
|
||||
fullName: com.microsoft.azure.iot.service.transport.http
|
||||
type: Namespace
|
||||
source:
|
||||
remote:
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: service/iothub-service-sdk/src/main/java/com/microsoft/azure/iot/service/transport/http/HttpConnection.java
|
||||
startLine: 5
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iot.service.transport.http
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_connection
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_connection.yml
|
||||
name: HttpConnection
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpConnection
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>A wrapper for the Java SE class HttpsURLConnection. Used to avoid compatibility issues when testing with the mocking framework JMockit, as well as to avoid some undocumented side effects when using HttpsURLConnection. </p>
|
||||
|
||||
<p>The underlying HttpsURLConnection is transparently managed by Java. To reuse connections, for each time <xref href="com.microsoft.azure.iot.service.transport.http._http_connection.connect()" data-throw-if-not-resolved="false"></xref> is called, the input streams (input stream or error stream, if input stream is not accessible) must be completely read. Otherwise, the data remains in the stream and the connection will not be reusable. </p>
|
||||
syntax:
|
||||
content: public class HttpConnection
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_message
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_message.yml
|
||||
name: HttpMessage
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMessage
|
||||
type: Interface
|
||||
summary: <p>An HTTPS message. An HTTPS message is distinguished from a plain IoT Hub message by its property names, which are prefixed with 'iothub-app-'; and by the explicit specification of a content-type. </p>
|
||||
syntax:
|
||||
content: public interface HttpMessage
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_method
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_method.yml
|
||||
name: HttpMethod
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpMethod
|
||||
type: Enum
|
||||
summary: <p>The HTTPS request method (i.e. GET). </p>
|
||||
syntax:
|
||||
content: public enum HttpMethod
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_request
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_request.yml
|
||||
name: HttpRequest
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpRequest
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class HttpRequest
|
||||
- uid: com.microsoft.azure.iot.service.transport.http._http_response
|
||||
parent: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http._http_response.yml
|
||||
name: HttpResponse
|
||||
fullName: com.microsoft.azure.iot.service.transport.http.HttpResponse
|
||||
type: Class
|
||||
summary: <p>An HTTPS response. Contains the status code, body, header fields, and error reason (if any). </p>
|
||||
syntax:
|
||||
content: public class HttpResponse
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iot.service.transport
|
||||
id: transport
|
||||
children:
|
||||
- com.microsoft.azure.iot.service.transport._transport_utils
|
||||
href: com.microsoft.azure.iot.service.transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: com.microsoft.azure.iot.service.transport
|
||||
fullName: com.microsoft.azure.iot.service.transport
|
||||
type: Namespace
|
||||
source:
|
||||
remote:
|
||||
path: '[generated]'
|
||||
path: '[generated]'
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iot.service.transport
|
||||
references:
|
||||
- uid: com.microsoft.azure.iot.service.transport.amqps
|
||||
href: com.microsoft.azure.iot.service.transport.amqps.yml
|
||||
name: com.microsoft.azure.iot.service.transport.amqps
|
||||
fullName: com.microsoft.azure.iot.service.transport.amqps
|
||||
type: Namespace
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iot.service.transport.amqps
|
||||
- uid: com.microsoft.azure.iot.service.transport.http
|
||||
href: com.microsoft.azure.iot.service.transport.http.yml
|
||||
name: com.microsoft.azure.iot.service.transport.http
|
||||
fullName: com.microsoft.azure.iot.service.transport.http
|
||||
type: Namespace
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iot.service.transport.http
|
||||
- uid: com.microsoft.azure.iot.service.transport._transport_utils
|
||||
parent: com.microsoft.azure.iot.service.transport
|
||||
href: com.microsoft.azure.iot.service.transport._transport_utils.yml
|
||||
name: TransportUtils
|
||||
fullName: com.microsoft.azure.iot.service.transport.TransportUtils
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class TransportUtils
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._default_certificate
|
||||
id: _default_certificate
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._default_certificate.DefaultCertificate()
|
||||
- com.microsoft.azure.iothub._default_certificate.getDefaultCertificate()
|
||||
href: com.microsoft.azure.iothub._default_certificate.yml
|
||||
langs:
|
||||
- java
|
||||
name: DefaultCertificate
|
||||
fullName: com.microsoft.azure.iothub.DefaultCertificate
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DefaultCertificate.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DefaultCertificate.java
|
||||
startLine: 7
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public class DefaultCertificate
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub._default_certificate.DefaultCertificate()
|
||||
id: DefaultCertificate()
|
||||
parent: com.microsoft.azure.iothub._default_certificate
|
||||
href: com.microsoft.azure.iothub._default_certificate.yml
|
||||
langs:
|
||||
- java
|
||||
name: DefaultCertificate()
|
||||
fullName: com.microsoft.azure.iothub.DefaultCertificate.DefaultCertificate()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DefaultCertificate.java
|
||||
startLine: 32
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public DefaultCertificate()
|
||||
- uid: com.microsoft.azure.iothub._default_certificate.getDefaultCertificate()
|
||||
id: getDefaultCertificate()
|
||||
parent: com.microsoft.azure.iothub._default_certificate
|
||||
href: com.microsoft.azure.iothub._default_certificate.yml
|
||||
langs:
|
||||
- java
|
||||
name: getDefaultCertificate()
|
||||
fullName: String com.microsoft.azure.iothub.DefaultCertificate.getDefaultCertificate()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DefaultCertificate.java
|
||||
startLine: 37
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public String getDefaultCertificate()
|
||||
return:
|
||||
type: "26831127"
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._device_client._iot_hub_client_state
|
||||
id: _iot_hub_client_state
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._device_client._iot_hub_client_state.CLOSED()
|
||||
- com.microsoft.azure.iothub._device_client._iot_hub_client_state.OPEN()
|
||||
href: com.microsoft.azure.iothub._device_client._iot_hub_client_state.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceClient.IotHubClientState
|
||||
fullName: com.microsoft.azure.iothub.DeviceClient.IotHubClientState
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 45
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The state of the IoT Hub client's connection with the IoT Hub. </p>
|
||||
syntax:
|
||||
content: protected enum IotHubClientState
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<DeviceClient.IotHubClientState>
|
||||
- uid: com.microsoft.azure.iothub._device_client._iot_hub_client_state.CLOSED()
|
||||
id: CLOSED()
|
||||
parent: com.microsoft.azure.iothub._device_client._iot_hub_client_state
|
||||
href: com.microsoft.azure.iothub._device_client._iot_hub_client_state.yml
|
||||
langs:
|
||||
- java
|
||||
name: CLOSED
|
||||
fullName: com.microsoft.azure.iothub.DeviceClient.IotHubClientState.CLOSED
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 47
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public CLOSED
|
||||
- uid: com.microsoft.azure.iothub._device_client._iot_hub_client_state.OPEN()
|
||||
id: OPEN()
|
||||
parent: com.microsoft.azure.iothub._device_client._iot_hub_client_state
|
||||
href: com.microsoft.azure.iothub._device_client._iot_hub_client_state.yml
|
||||
langs:
|
||||
- java
|
||||
name: OPEN
|
||||
fullName: com.microsoft.azure.iothub.DeviceClient.IotHubClientState.OPEN
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 47
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public OPEN
|
||||
references: []
|
||||
|
|
@ -0,0 +1,727 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._device_client
|
||||
id: _device_client
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._device_client.close()
|
||||
- com.microsoft.azure.iothub._device_client.config()
|
||||
- com.microsoft.azure.iothub._device_client.CONNECTION_STRING_CHARSET()
|
||||
- com.microsoft.azure.iothub._device_client.DEVICE_ID_ATTRIBUTE()
|
||||
- com.microsoft.azure.iothub._device_client.DeviceClient()
|
||||
- com.microsoft.azure.iothub._device_client.DeviceClient(String,IotHubClientProtocol)
|
||||
- com.microsoft.azure.iothub._device_client.HOSTNAME_ATTRIBUTE()
|
||||
- com.microsoft.azure.iothub._device_client.initIotHubClient(String,String,String,String,IotHubClientProtocol)
|
||||
- com.microsoft.azure.iothub._device_client.open()
|
||||
- com.microsoft.azure.iothub._device_client.RECEIVE_PERIOD_MILLIS()
|
||||
- com.microsoft.azure.iothub._device_client.RECEIVE_PERIOD_MILLIS_AMQPS()
|
||||
- com.microsoft.azure.iothub._device_client.RECEIVE_PERIOD_MILLIS_HTTPS()
|
||||
- com.microsoft.azure.iothub._device_client.RECEIVE_PERIOD_MILLIS_MQTT()
|
||||
- com.microsoft.azure.iothub._device_client.SEND_PERIOD_MILLIS()
|
||||
- com.microsoft.azure.iothub._device_client.sendEventAsync(Message,IotHubEventCallback,Object)
|
||||
- com.microsoft.azure.iothub._device_client.SET_CERTIFICATE_PATH()
|
||||
- com.microsoft.azure.iothub._device_client.SET_MINIMUM_POLLING_INTERVAL()
|
||||
- com.microsoft.azure.iothub._device_client.SET_SAS_TOKEN_EXPIRY_TIME()
|
||||
- com.microsoft.azure.iothub._device_client.setMessageCallback(MessageCallback,Object)
|
||||
- com.microsoft.azure.iothub._device_client.setOption(String,Object)
|
||||
- com.microsoft.azure.iothub._device_client.SHARED_ACCESS_KEY_ATTRIBUTE()
|
||||
- com.microsoft.azure.iothub._device_client.SHARED_ACCESS_TOKEN_ATTRIBUTE()
|
||||
- com.microsoft.azure.iothub._device_client.state()
|
||||
- com.microsoft.azure.iothub._device_client.taskScheduler()
|
||||
- com.microsoft.azure.iothub._device_client.transport()
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceClient
|
||||
fullName: com.microsoft.azure.iothub.DeviceClient
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 42
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>The public-facing API. Allows a single logical or physical device to connect to an IoT Hub. The IoT Hub client supports sending events to and receiving messages from an IoT Hub. </p>
|
||||
|
||||
<p>To support these workflows, the client library will provide the following abstractions: a message, with its payload and associated properties; and a client, which sends and receives messages. </p>
|
||||
|
||||
<p>The client buffers messages while the network is down, and re-sends them when the network comes back online. It also batches messages to improve communication efficiency (HTTPS only). </p>
|
||||
|
||||
<p>The client supports HTTPS 1.1 and AMQPS 1.0 transports. </p>
|
||||
syntax: &o1
|
||||
content: public class DeviceClient
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Closeable
|
||||
- uid: com.microsoft.azure.iothub._device_client.close()
|
||||
id: close()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iothub.DeviceClient.close()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 202
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Completes all current outstanding requests and closes the IoT Hub client. Must be called to terminate the background thread that is sending data to IoT Hub. After<programlisting><codeline><highlight class="normal">close()<sp></sp></highlight></codeline></programlisting> is called, the IoT Hub client is no longer usable. If the client is already closed, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void close()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the connection to an IoT Hub cannot be closed. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client.config()
|
||||
id: config()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: config
|
||||
fullName: DeviceClientConfig com.microsoft.azure.iothub.DeviceClient.config
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 82
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected DeviceClientConfig config
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._device_client_config
|
||||
- uid: com.microsoft.azure.iothub._device_client.CONNECTION_STRING_CHARSET()
|
||||
id: CONNECTION_STRING_CHARSET()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: CONNECTION_STRING_CHARSET
|
||||
fullName: final Charset com.microsoft.azure.iothub.DeviceClient.CONNECTION_STRING_CHARSET
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 80
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The charset used for URL-encoding the device ID in the connection string. </p>
|
||||
syntax:
|
||||
content: public static final Charset CONNECTION_STRING_CHARSET= StandardCharsets.UTF_8
|
||||
return:
|
||||
type: d07b5f81
|
||||
- uid: com.microsoft.azure.iothub._device_client.DEVICE_ID_ATTRIBUTE()
|
||||
id: DEVICE_ID_ATTRIBUTE()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: DEVICE_ID_ATTRIBUTE
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClient.DEVICE_ID_ATTRIBUTE
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 70
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The device ID attribute name in a connection string. </p>
|
||||
syntax:
|
||||
content: public static final String DEVICE_ID_ATTRIBUTE= "DeviceId="
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client.DeviceClient()
|
||||
id: DeviceClient()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceClient()
|
||||
fullName: com.microsoft.azure.iothub.DeviceClient.DeviceClient()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 369
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected DeviceClient()
|
||||
- uid: com.microsoft.azure.iothub._device_client.DeviceClient(String,IotHubClientProtocol)
|
||||
id: DeviceClient(String,IotHubClientProtocol)
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceClient(String connString, IotHubClientProtocol protocol)
|
||||
fullName: com.microsoft.azure.iothub.DeviceClient.DeviceClient(String connString, IotHubClientProtocol protocol)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 105
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Constructor that takes a connection string as an argument.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public DeviceClient(String connString, IotHubClientProtocol protocol)
|
||||
parameters:
|
||||
- id: connString
|
||||
type: "26831127"
|
||||
description: '<p>the connection string. The connection string is a set of key-value pairs that are separated by '';'', with the keys and values separated by ''=''. It should contain values for the following keys: <programlisting><codeline><highlight class="normal">HostName<sp></sp></highlight></codeline></programlisting> ,<programlisting><codeline><highlight class="normal">DeviceId<sp></sp></highlight></codeline></programlisting> , and<programlisting><codeline><highlight class="normal">SharedAccessKey<sp></sp></highlight></codeline></programlisting> . </p>'
|
||||
- id: protocol
|
||||
type: com.microsoft.azure.iothub._iot_hub_client_protocol
|
||||
description: <p>the communication protocol used (i.e. HTTPS).</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if any of<programlisting><codeline><highlight class="normal">connString<sp></sp></highlight></codeline></programlisting> or <programlisting><codeline><highlight class="normal">protocol<sp></sp></highlight></codeline></programlisting> are<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> ; or if<programlisting><codeline><highlight class="normal">connString<sp></sp></highlight></codeline></programlisting> is missing one of the following attributes:<programlisting><codeline><highlight class="normal">HostName<sp></sp></highlight></codeline></programlisting> ,<programlisting><codeline><highlight class="normal">DeviceId<sp></sp></highlight></codeline></programlisting> , or <programlisting><codeline><highlight class="normal">SharedAccessKey<sp></sp></highlight></codeline></programlisting> . </p>
|
||||
- type: "44102508"
|
||||
description: <p>if the IoT hub hostname does not conform to RFC 3986. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client.HOSTNAME_ATTRIBUTE()
|
||||
id: HOSTNAME_ATTRIBUTE()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: HOSTNAME_ATTRIBUTE
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClient.HOSTNAME_ATTRIBUTE
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 68
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The hostname attribute name in a connection string. </p>
|
||||
syntax:
|
||||
content: public static final String HOSTNAME_ATTRIBUTE= "HostName="
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client.initIotHubClient(String,String,String,String,IotHubClientProtocol)
|
||||
id: initIotHubClient(String,String,String,String,IotHubClientProtocol)
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: initIotHubClient(String iotHubHostname, String deviceId, String deviceKey, String sharedAccessToken, IotHubClientProtocol protocol)
|
||||
fullName: void com.microsoft.azure.iothub.DeviceClient.initIotHubClient(String iotHubHostname, String deviceId, String deviceKey, String sharedAccessToken, IotHubClientProtocol protocol)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 300
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Initializes an IoT Hub device client with the given parameters.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected void initIotHubClient(String iotHubHostname, String deviceId, String deviceKey, String sharedAccessToken, IotHubClientProtocol protocol)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub hostname. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- id: deviceKey
|
||||
type: "26831127"
|
||||
description: <p>the device key. </p>
|
||||
- id: sharedAccessToken
|
||||
type: "26831127"
|
||||
- id: protocol
|
||||
type: com.microsoft.azure.iothub._iot_hub_client_protocol
|
||||
description: <p>the communication protocol used (i.e. HTTPS).</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if any of<programlisting><codeline><highlight class="normal">iotHubHostname<sp></sp></highlight></codeline></programlisting> ,<programlisting><codeline><highlight class="normal">deviceId<sp></sp></highlight></codeline></programlisting> , <programlisting><codeline><highlight class="normal">deviceKey<sp></sp></highlight></codeline></programlisting> , or<programlisting><codeline><highlight class="normal">protocol<sp></sp></highlight></codeline></programlisting> are<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> ; or if<programlisting><codeline><highlight class="normal">iotHubHostname<sp></sp></highlight></codeline></programlisting> does not contain a valid IoT Hub name as its prefix. </p>
|
||||
- type: "44102508"
|
||||
description: <p>if the IoT Hub hostname does not conform to RFC 3986. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client.open()
|
||||
id: open()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iothub.DeviceClient.open()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 164
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Starts asynchronously sending and receiving messages from an IoT Hub. If the client is already open, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void open()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if a connection to an IoT Hub is cannot be established. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client.RECEIVE_PERIOD_MILLIS()
|
||||
id: RECEIVE_PERIOD_MILLIS()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: RECEIVE_PERIOD_MILLIS
|
||||
fullName: long com.microsoft.azure.iothub.DeviceClient.RECEIVE_PERIOD_MILLIS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 87
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected long RECEIVE_PERIOD_MILLIS
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iothub._device_client.RECEIVE_PERIOD_MILLIS_AMQPS()
|
||||
id: RECEIVE_PERIOD_MILLIS_AMQPS()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: RECEIVE_PERIOD_MILLIS_AMQPS
|
||||
fullName: long com.microsoft.azure.iothub.DeviceClient.RECEIVE_PERIOD_MILLIS_AMQPS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 63
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The number of milliseconds the transport will wait between polling for messages. </p>
|
||||
syntax:
|
||||
content: public static long RECEIVE_PERIOD_MILLIS_AMQPS= 10l
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iothub._device_client.RECEIVE_PERIOD_MILLIS_HTTPS()
|
||||
id: RECEIVE_PERIOD_MILLIS_HTTPS()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: RECEIVE_PERIOD_MILLIS_HTTPS
|
||||
fullName: long com.microsoft.azure.iothub.DeviceClient.RECEIVE_PERIOD_MILLIS_HTTPS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 65
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public static long RECEIVE_PERIOD_MILLIS_HTTPS= 25*60*1000
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iothub._device_client.RECEIVE_PERIOD_MILLIS_MQTT()
|
||||
id: RECEIVE_PERIOD_MILLIS_MQTT()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: RECEIVE_PERIOD_MILLIS_MQTT
|
||||
fullName: long com.microsoft.azure.iothub.DeviceClient.RECEIVE_PERIOD_MILLIS_MQTT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 64
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public static long RECEIVE_PERIOD_MILLIS_MQTT= 10l
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iothub._device_client.SEND_PERIOD_MILLIS()
|
||||
id: SEND_PERIOD_MILLIS()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: SEND_PERIOD_MILLIS
|
||||
fullName: long com.microsoft.azure.iothub.DeviceClient.SEND_PERIOD_MILLIS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 58
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The number of milliseconds the transport will wait between sending out messages. </p>
|
||||
syntax:
|
||||
content: public static long SEND_PERIOD_MILLIS= 10l
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iothub._device_client.sendEventAsync(Message,IotHubEventCallback,Object)
|
||||
id: sendEventAsync(Message,IotHubEventCallback,Object)
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: sendEventAsync(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
fullName: void com.microsoft.azure.iothub.DeviceClient.sendEventAsync(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 235
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Asynchronously sends an event message to the IoT Hub.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void sendEventAsync(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message to be sent. </p>
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback to be invoked when a response is received. Can be<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> . </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>a context to be passed to the callback. Can be <programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> if no callback is provided.</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if the message provided is<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> . </p>
|
||||
- type: 12fe80de
|
||||
description: <p>if the client has not been opened yet or is already closed. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client.SET_CERTIFICATE_PATH()
|
||||
id: SET_CERTIFICATE_PATH()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: SET_CERTIFICATE_PATH
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClient.SET_CERTIFICATE_PATH
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 51
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected static final String SET_CERTIFICATE_PATH= "SetCertificatePath"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client.SET_MINIMUM_POLLING_INTERVAL()
|
||||
id: SET_MINIMUM_POLLING_INTERVAL()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: SET_MINIMUM_POLLING_INTERVAL
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClient.SET_MINIMUM_POLLING_INTERVAL
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 50
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected static final String SET_MINIMUM_POLLING_INTERVAL= "SetMinimumPollingInterval"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client.SET_SAS_TOKEN_EXPIRY_TIME()
|
||||
id: SET_SAS_TOKEN_EXPIRY_TIME()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: SET_SAS_TOKEN_EXPIRY_TIME
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClient.SET_SAS_TOKEN_EXPIRY_TIME
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 52
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected static final String SET_SAS_TOKEN_EXPIRY_TIME= "SetSASTokenExpiryTime"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client.setMessageCallback(MessageCallback,Object)
|
||||
id: setMessageCallback(MessageCallback,Object)
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: setMessageCallback(MessageCallback callback, Object context)
|
||||
fullName: DeviceClient com.microsoft.azure.iothub.DeviceClient.setMessageCallback(MessageCallback callback, Object context)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 270
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Sets the message callback.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public DeviceClient setMessageCallback(MessageCallback callback, Object context)
|
||||
parameters:
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._message_callback
|
||||
description: <p>the message callback. Can be<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> . </p>
|
||||
- id: context
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed to the callback. Can be<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> .</p>
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._device_client
|
||||
description: <p>itself, for fluent setting.</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if the callback is<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> but a context is passed in. </p>
|
||||
- type: 12fe80de
|
||||
description: <p>if the callback is set after the client is closed. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client.setOption(String,Object)
|
||||
id: setOption(String,Object)
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: setOption(String optionName, Object value)
|
||||
fullName: void com.microsoft.azure.iothub.DeviceClient.setOption(String optionName, Object value)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 488
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Sets a runtime option identified by parameter<programlisting><codeline><highlight class="normal">optionName<sp></sp></highlight></codeline></programlisting> to<programlisting><codeline><highlight class="normal">value<sp></sp></highlight></codeline></programlisting> .</p>
|
||||
|
||||
<p>The options that can be set via this API are:<itemizedlist><listitem><p><bold>SetMinimumPollingInterval</bold> - this option is applicable only when the transport configured with this client is HTTP. This option specifies the interval in milliseconds between calls to the service checking for availability of new messages. The value is expected to be of type<programlisting><codeline><highlight class="normal">long<sp></sp></highlight></codeline></programlisting> .</p></listitem><listitem><p><bold>SetCertificatePath</bold> - this option is applicable only when the transport configured with this client is AMQP. This option specifies the path to the certificate used to verify peer. The value is expected to be of type<programlisting><codeline><highlight class="normal">String<sp></sp></highlight></codeline></programlisting> .</p></listitem><listitem><p><bold>SetSASTokenExpiryTime</bold> - this option is applicable for HTTP/ AMQP/MQTT. This option specifies the interval in seconds after which SASToken expires. If the transport is already open then setting this option will restart the transport with the updated expiry time. The value is expected to be of type<programlisting><codeline><highlight class="normal">long<sp></sp></highlight></codeline></programlisting> .</p></listitem></itemizedlist></p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setOption(String optionName, Object value)
|
||||
parameters:
|
||||
- id: optionName
|
||||
type: "26831127"
|
||||
description: <p>the option name to modify </p>
|
||||
- id: value
|
||||
type: "79317049"
|
||||
description: <p>an object of the appropriate type for the option's value </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client.SHARED_ACCESS_KEY_ATTRIBUTE()
|
||||
id: SHARED_ACCESS_KEY_ATTRIBUTE()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: SHARED_ACCESS_KEY_ATTRIBUTE
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClient.SHARED_ACCESS_KEY_ATTRIBUTE
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 72
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The shared access key attribute name in a connection string. </p>
|
||||
syntax:
|
||||
content: public static final String SHARED_ACCESS_KEY_ATTRIBUTE= "SharedAccessKey="
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client.SHARED_ACCESS_TOKEN_ATTRIBUTE()
|
||||
id: SHARED_ACCESS_TOKEN_ATTRIBUTE()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: SHARED_ACCESS_TOKEN_ATTRIBUTE
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClient.SHARED_ACCESS_TOKEN_ATTRIBUTE
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 74
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The shared access signature attribute name in a connection string. </p>
|
||||
syntax:
|
||||
content: public static final String SHARED_ACCESS_TOKEN_ATTRIBUTE= "SharedAccessSignature="
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client.state()
|
||||
id: state()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: state
|
||||
fullName: IotHubClientState com.microsoft.azure.iothub.DeviceClient.state
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 86
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected IotHubClientState state
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._device_client._iot_hub_client_state
|
||||
- uid: com.microsoft.azure.iothub._device_client.taskScheduler()
|
||||
id: taskScheduler()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: taskScheduler
|
||||
fullName: ScheduledExecutorService com.microsoft.azure.iothub.DeviceClient.taskScheduler
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 85
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected ScheduledExecutorService taskScheduler
|
||||
return:
|
||||
type: cd415bf4
|
||||
- uid: com.microsoft.azure.iothub._device_client.transport()
|
||||
id: transport()
|
||||
parent: com.microsoft.azure.iothub._device_client
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
langs:
|
||||
- java
|
||||
name: transport
|
||||
fullName: IotHubTransport com.microsoft.azure.iothub.DeviceClient.transport
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClient.java
|
||||
startLine: 83
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected IotHubTransport transport
|
||||
return:
|
||||
type: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: d07b5f81
|
||||
spec.java:
|
||||
- name: final Charset
|
||||
fullName: final Charset
|
||||
- uid: cd415bf4
|
||||
spec.java:
|
||||
- name: ScheduledExecutorService
|
||||
fullName: ScheduledExecutorService
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: "44102508"
|
||||
spec.java:
|
||||
- name: URISyntaxException
|
||||
fullName: URISyntaxException
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: 12fe80de
|
||||
spec.java:
|
||||
- name: IllegalStateException
|
||||
fullName: IllegalStateException
|
||||
- uid: "79317049"
|
||||
spec.java:
|
||||
- name: Object
|
||||
fullName: Object
|
||||
- uid: com.microsoft.azure.iothub._device_client_config
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
name: DeviceClientConfig
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig
|
||||
type: Class
|
||||
summary: <p>Configuration settings for an IoT Hub client. Validates all user-defined settings. </p>
|
||||
syntax:
|
||||
content: public class DeviceClientConfig
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: IotHubTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubTransport
|
||||
type: Interface
|
||||
summary: <p>An interface for an IoT Hub transport. </p>
|
||||
syntax:
|
||||
content: public interface IotHubTransport
|
||||
- uid: com.microsoft.azure.iothub._device_client._iot_hub_client_state
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._device_client._iot_hub_client_state.yml
|
||||
name: DeviceClient.IotHubClientState
|
||||
fullName: com.microsoft.azure.iothub.DeviceClient.IotHubClientState
|
||||
type: Enum
|
||||
summary: <p>The state of the IoT Hub client's connection with the IoT Hub. </p>
|
||||
syntax:
|
||||
content: protected enum IotHubClientState
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_client_protocol
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_client_protocol.yml
|
||||
name: IotHubClientProtocol
|
||||
fullName: com.microsoft.azure.iothub.IotHubClientProtocol
|
||||
type: Enum
|
||||
summary: <p>The application-layer protocol used by the client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubClientProtocol
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
name: IotHubEventCallback
|
||||
fullName: com.microsoft.azure.iothub.IotHubEventCallback
|
||||
type: Interface
|
||||
summary: >-
|
||||
<p>An interface for an IoT Hub event callback.</p>
|
||||
|
||||
<p>Developers are expected to create an implementation of this interface, and the transport will call <xref href="com.microsoft.azure.iothub._iot_hub_event_callback.execute(IotHubStatusCode,Object)" data-throw-if-not-resolved="false"></xref> upon receiving a response from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public interface IotHubEventCallback
|
||||
- uid: com.microsoft.azure.iothub._device_client
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
name: DeviceClient
|
||||
fullName: com.microsoft.azure.iothub.DeviceClient
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>The public-facing API. Allows a single logical or physical device to connect to an IoT Hub. The IoT Hub client supports sending events to and receiving messages from an IoT Hub. </p>
|
||||
|
||||
<p>To support these workflows, the client library will provide the following abstractions: a message, with its payload and associated properties; and a client, which sends and receives messages. </p>
|
||||
|
||||
<p>The client buffers messages while the network is down, and re-sends them when the network comes back online. It also batches messages to improve communication efficiency (HTTPS only). </p>
|
||||
|
||||
<p>The client supports HTTPS 1.1 and AMQPS 1.0 transports. </p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iothub._message_callback
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message_callback.yml
|
||||
name: MessageCallback
|
||||
fullName: com.microsoft.azure.iothub.MessageCallback
|
||||
type: Interface
|
||||
summary: >-
|
||||
<p>An interface for an IoT Hub message callback. </p>
|
||||
|
||||
<p>The developer is expected to create an implementation of this interface, and the transport will call <xref href="com.microsoft.azure.iothub._message_callback.execute(Message,Object)" data-throw-if-not-resolved="false"></xref> upon receiving a message from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public interface MessageCallback
|
||||
|
|
@ -0,0 +1,668 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._device_client_config
|
||||
id: _device_client_config
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._device_client_config.DEFAULT_MESSAGE_LOCK_TIMEOUT_SECS()
|
||||
- com.microsoft.azure.iothub._device_client_config.DEFAULT_READ_TIMEOUT_MILLIS()
|
||||
- com.microsoft.azure.iothub._device_client_config.DeviceClientConfig()
|
||||
- com.microsoft.azure.iothub._device_client_config.DeviceClientConfig(String,String,String,String)
|
||||
- com.microsoft.azure.iothub._device_client_config.deviceId()
|
||||
- com.microsoft.azure.iothub._device_client_config.deviceKey()
|
||||
- com.microsoft.azure.iothub._device_client_config.getDeviceId()
|
||||
- com.microsoft.azure.iothub._device_client_config.getDeviceKey()
|
||||
- com.microsoft.azure.iothub._device_client_config.getIotHubHostname()
|
||||
- com.microsoft.azure.iothub._device_client_config.getIotHubName()
|
||||
- com.microsoft.azure.iothub._device_client_config.getMessageCallback()
|
||||
- com.microsoft.azure.iothub._device_client_config.getMessageContext()
|
||||
- com.microsoft.azure.iothub._device_client_config.getMessageLockTimeoutSecs()
|
||||
- com.microsoft.azure.iothub._device_client_config.getPathToCertificate()
|
||||
- com.microsoft.azure.iothub._device_client_config.getReadTimeoutMillis()
|
||||
- com.microsoft.azure.iothub._device_client_config.getSharedAccessToken()
|
||||
- com.microsoft.azure.iothub._device_client_config.getTokenValidSecs()
|
||||
- com.microsoft.azure.iothub._device_client_config.iotHubHostname()
|
||||
- com.microsoft.azure.iothub._device_client_config.iotHubName()
|
||||
- com.microsoft.azure.iothub._device_client_config.messageCallback()
|
||||
- com.microsoft.azure.iothub._device_client_config.messageContext()
|
||||
- com.microsoft.azure.iothub._device_client_config.pathToCertificate()
|
||||
- com.microsoft.azure.iothub._device_client_config.setMessageCallback(MessageCallback,Object)
|
||||
- com.microsoft.azure.iothub._device_client_config.setPathToCert(String)
|
||||
- com.microsoft.azure.iothub._device_client_config.setTokenValidSecs(long)
|
||||
- com.microsoft.azure.iothub._device_client_config.sharedAccessToken()
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceClientConfig
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Configuration settings for an IoT Hub client. Validates all user-defined settings. </p>
|
||||
syntax:
|
||||
content: public class DeviceClientConfig
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.DEFAULT_MESSAGE_LOCK_TIMEOUT_SECS()
|
||||
id: DEFAULT_MESSAGE_LOCK_TIMEOUT_SECS()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: DEFAULT_MESSAGE_LOCK_TIMEOUT_SECS
|
||||
fullName: final int com.microsoft.azure.iothub.DeviceClientConfig.DEFAULT_MESSAGE_LOCK_TIMEOUT_SECS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The default value for messageLockTimeoutSecs. </p>
|
||||
syntax:
|
||||
content: public static final int DEFAULT_MESSAGE_LOCK_TIMEOUT_SECS= 180
|
||||
return:
|
||||
type: cd225469
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.DEFAULT_READ_TIMEOUT_MILLIS()
|
||||
id: DEFAULT_READ_TIMEOUT_MILLIS()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: DEFAULT_READ_TIMEOUT_MILLIS
|
||||
fullName: final int com.microsoft.azure.iothub.DeviceClientConfig.DEFAULT_READ_TIMEOUT_MILLIS
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 24
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The default value for readTimeoutMillis. </p>
|
||||
syntax:
|
||||
content: public static final int DEFAULT_READ_TIMEOUT_MILLIS= 240000
|
||||
return:
|
||||
type: cd225469
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.DeviceClientConfig()
|
||||
id: DeviceClientConfig()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceClientConfig()
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig.DeviceClientConfig()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 249
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected DeviceClientConfig()
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.DeviceClientConfig(String,String,String,String)
|
||||
id: DeviceClientConfig(String,String,String,String)
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: DeviceClientConfig(String iotHubHostname, String deviceId, String deviceKey, String sharedAccessToken)
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig.DeviceClientConfig(String iotHubHostname, String deviceId, String deviceKey, String sharedAccessToken)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 55
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Constructor.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public DeviceClientConfig(String iotHubHostname, String deviceId, String deviceKey, String sharedAccessToken)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub hostname. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- id: deviceKey
|
||||
type: "26831127"
|
||||
description: <p>the device key. </p>
|
||||
- id: sharedAccessToken
|
||||
type: "26831127"
|
||||
description: <p>the shared access token.</p>
|
||||
exceptions:
|
||||
- type: "44102508"
|
||||
description: <p>if the IoT Hub hostname does not conform to RFC 3986. </p>
|
||||
- type: 3c87bd19
|
||||
description: <p>if the IoT Hub hostname does not contain a valid IoT Hub name as its prefix. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.deviceId()
|
||||
id: deviceId()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: deviceId
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClientConfig.deviceId
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 30
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected final String deviceId
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.deviceKey()
|
||||
id: deviceKey()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: deviceKey
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClientConfig.deviceKey
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 31
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected final String deviceKey
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getDeviceId()
|
||||
id: getDeviceId()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getDeviceId()
|
||||
fullName: String com.microsoft.azure.iothub.DeviceClientConfig.getDeviceId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 135
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the device ID.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getDeviceId()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getDeviceKey()
|
||||
id: getDeviceKey()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getDeviceKey()
|
||||
fullName: String com.microsoft.azure.iothub.DeviceClientConfig.getDeviceKey()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 146
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the device key.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getDeviceKey()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the device key. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getIotHubHostname()
|
||||
id: getIotHubHostname()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getIotHubHostname()
|
||||
fullName: String com.microsoft.azure.iothub.DeviceClientConfig.getIotHubHostname()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 113
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the IoT Hub hostname.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getIotHubHostname()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub hostname. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getIotHubName()
|
||||
id: getIotHubName()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getIotHubName()
|
||||
fullName: String com.microsoft.azure.iothub.DeviceClientConfig.getIotHubName()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 124
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the IoT Hub name.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getIotHubName()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub name. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getMessageCallback()
|
||||
id: getMessageCallback()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getMessageCallback()
|
||||
fullName: MessageCallback com.microsoft.azure.iothub.DeviceClientConfig.getMessageCallback()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 206
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the message callback.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public MessageCallback getMessageCallback()
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._message_callback
|
||||
description: <p>the message callback. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getMessageContext()
|
||||
id: getMessageContext()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getMessageContext()
|
||||
fullName: Object com.microsoft.azure.iothub.DeviceClientConfig.getMessageContext()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 217
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the context to be passed in to the message callback.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public Object getMessageContext()
|
||||
return:
|
||||
type: "79317049"
|
||||
description: <p>the message context. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getMessageLockTimeoutSecs()
|
||||
id: getMessageLockTimeoutSecs()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getMessageLockTimeoutSecs()
|
||||
fullName: int com.microsoft.azure.iothub.DeviceClientConfig.getMessageLockTimeoutSecs()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 229
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the timeout, in seconds, for the lock that the client has on a received message.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public int getMessageLockTimeoutSecs()
|
||||
return:
|
||||
type: f75371fa
|
||||
description: <p>the timeout, in seconds, for a received message lock. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getPathToCertificate()
|
||||
id: getPathToCertificate()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPathToCertificate()
|
||||
fullName: String com.microsoft.azure.iothub.DeviceClientConfig.getPathToCertificate()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 240
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the path to the certificate.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getPathToCertificate()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the path to certificate. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getReadTimeoutMillis()
|
||||
id: getReadTimeoutMillis()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getReadTimeoutMillis()
|
||||
fullName: int com.microsoft.azure.iothub.DeviceClientConfig.getReadTimeoutMillis()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 195
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the timeout, in milliseconds, after a connection is established for the server to respond to the request.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public int getReadTimeoutMillis()
|
||||
return:
|
||||
type: f75371fa
|
||||
description: <p>the timeout, in milliseconds, after a connection is established for the server to respond to the request. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getSharedAccessToken()
|
||||
id: getSharedAccessToken()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getSharedAccessToken()
|
||||
fullName: String com.microsoft.azure.iothub.DeviceClientConfig.getSharedAccessToken()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 157
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the shared access signature.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getSharedAccessToken()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the shared access signature. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getTokenValidSecs()
|
||||
id: getTokenValidSecs()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: getTokenValidSecs()
|
||||
fullName: long com.microsoft.azure.iothub.DeviceClientConfig.getTokenValidSecs()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 171
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Getter for the number of seconds a SAS token should be valid for. A message that arrives at an IoT Hub in time of length greater than this value will be rejected by the IoT Hub.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o1
|
||||
content: public long getTokenValidSecs()
|
||||
return:
|
||||
type: 0364520f
|
||||
description: <p>the number of seconds a message in transit to an IoT Hub is valid for. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.iotHubHostname()
|
||||
id: iotHubHostname()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: iotHubHostname
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClientConfig.iotHubHostname
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 28
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected final String iotHubHostname
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.iotHubName()
|
||||
id: iotHubName()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: iotHubName
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClientConfig.iotHubName
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 29
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected final String iotHubName
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.messageCallback()
|
||||
id: messageCallback()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: messageCallback
|
||||
fullName: MessageCallback com.microsoft.azure.iothub.DeviceClientConfig.messageCallback
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 38
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The callback to be invoked if a message is received. </p>
|
||||
syntax:
|
||||
content: protected MessageCallback messageCallback
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._message_callback
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.messageContext()
|
||||
id: messageContext()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: messageContext
|
||||
fullName: Object com.microsoft.azure.iothub.DeviceClientConfig.messageContext
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 40
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The context to be passed in to the message callback. </p>
|
||||
syntax:
|
||||
content: protected Object messageContext
|
||||
return:
|
||||
type: "79317049"
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.pathToCertificate()
|
||||
id: pathToCertificate()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: pathToCertificate
|
||||
fullName: String com.microsoft.azure.iothub.DeviceClientConfig.pathToCertificate
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 33
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected String pathToCertificate
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.setMessageCallback(MessageCallback,Object)
|
||||
id: setMessageCallback(MessageCallback,Object)
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: setMessageCallback(MessageCallback callback, Object context)
|
||||
fullName: void com.microsoft.azure.iothub.DeviceClientConfig.setMessageCallback(MessageCallback callback, Object context)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 100
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Setter for the message callback. Can be<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> .</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setMessageCallback(MessageCallback callback, Object context)
|
||||
parameters:
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._message_callback
|
||||
description: <p>the message callback. Can be<programlisting><codeline><highlight class="normal">null<sp></sp></highlight></codeline></programlisting> . </p>
|
||||
- id: context
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed in to the callback. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.setPathToCert(String)
|
||||
id: setPathToCert(String)
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: setPathToCert(String pathToCertificate)
|
||||
fullName: void com.microsoft.azure.iothub.DeviceClientConfig.setPathToCert(String pathToCertificate)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 89
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Setter for the providing trusted certificate.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setPathToCert(String pathToCertificate)
|
||||
parameters:
|
||||
- id: pathToCertificate
|
||||
type: "26831127"
|
||||
description: <p>path to the certificate for one way authentication. </p>
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.setTokenValidSecs(long)
|
||||
id: setTokenValidSecs(long)
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: setTokenValidSecs(long expiryTime)
|
||||
fullName: void com.microsoft.azure.iothub.DeviceClientConfig.setTokenValidSecs(long expiryTime)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 182
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Setter for the number of seconds a SAS token should be valid for. A message that arrives at an IoT Hub in time of length greater than this value will be rejected by the IoT Hub. </p>
|
||||
syntax:
|
||||
content: public void setTokenValidSecs(long expiryTime)
|
||||
parameters:
|
||||
- id: expiryTime
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.sharedAccessToken()
|
||||
id: sharedAccessToken()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
langs:
|
||||
- java
|
||||
name: sharedAccessToken
|
||||
fullName: final String com.microsoft.azure.iothub.DeviceClientConfig.sharedAccessToken
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/DeviceClientConfig.java
|
||||
startLine: 32
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected final String sharedAccessToken
|
||||
return:
|
||||
type: 3d93591e
|
||||
references:
|
||||
- uid: cd225469
|
||||
spec.java:
|
||||
- name: final int
|
||||
fullName: final int
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: "79317049"
|
||||
spec.java:
|
||||
- name: Object
|
||||
fullName: Object
|
||||
- uid: "44102508"
|
||||
spec.java:
|
||||
- name: URISyntaxException
|
||||
fullName: URISyntaxException
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
- uid: com.microsoft.azure.iothub._device_client_config.getTokenValidSecs()
|
||||
parent: com.microsoft.azure.iothub._device_client_config
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
name: getTokenValidSecs()
|
||||
fullName: long com.microsoft.azure.iothub.DeviceClientConfig.getTokenValidSecs()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Getter for the number of seconds a SAS token should be valid for. A message that arrives at an IoT Hub in time of length greater than this value will be rejected by the IoT Hub.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iothub._message_callback
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message_callback.yml
|
||||
name: MessageCallback
|
||||
fullName: com.microsoft.azure.iothub.MessageCallback
|
||||
type: Interface
|
||||
summary: >-
|
||||
<p>An interface for an IoT Hub message callback. </p>
|
||||
|
||||
<p>The developer is expected to create an implementation of this interface, and the transport will call <xref href="com.microsoft.azure.iothub._message_callback.execute(Message,Object)" data-throw-if-not-resolved="false"></xref> upon receiving a message from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public interface MessageCallback
|
||||
|
|
@ -0,0 +1,110 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._feedback_status_code_enum
|
||||
id: _feedback_status_code_enum
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._feedback_status_code_enum.deliveryCountExceeded()
|
||||
- com.microsoft.azure.iothub._feedback_status_code_enum.expired()
|
||||
- com.microsoft.azure.iothub._feedback_status_code_enum.none()
|
||||
- com.microsoft.azure.iothub._feedback_status_code_enum.rejected()
|
||||
- com.microsoft.azure.iothub._feedback_status_code_enum.success()
|
||||
href: com.microsoft.azure.iothub._feedback_status_code_enum.yml
|
||||
langs:
|
||||
- java
|
||||
name: FeedbackStatusCodeEnum
|
||||
fullName: com.microsoft.azure.iothub.FeedbackStatusCodeEnum
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/FeedbackStatusCodeEnum.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/FeedbackStatusCodeEnum.java
|
||||
startLine: 5
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public enum FeedbackStatusCodeEnum
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<FeedbackStatusCodeEnum>
|
||||
- uid: com.microsoft.azure.iothub._feedback_status_code_enum.deliveryCountExceeded()
|
||||
id: deliveryCountExceeded()
|
||||
parent: com.microsoft.azure.iothub._feedback_status_code_enum
|
||||
href: com.microsoft.azure.iothub._feedback_status_code_enum.yml
|
||||
langs:
|
||||
- java
|
||||
name: deliveryCountExceeded
|
||||
fullName: com.microsoft.azure.iothub.FeedbackStatusCodeEnum.deliveryCountExceeded
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/FeedbackStatusCodeEnum.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public deliveryCountExceeded
|
||||
- uid: com.microsoft.azure.iothub._feedback_status_code_enum.expired()
|
||||
id: expired()
|
||||
parent: com.microsoft.azure.iothub._feedback_status_code_enum
|
||||
href: com.microsoft.azure.iothub._feedback_status_code_enum.yml
|
||||
langs:
|
||||
- java
|
||||
name: expired
|
||||
fullName: com.microsoft.azure.iothub.FeedbackStatusCodeEnum.expired
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/FeedbackStatusCodeEnum.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public expired
|
||||
- uid: com.microsoft.azure.iothub._feedback_status_code_enum.none()
|
||||
id: none()
|
||||
parent: com.microsoft.azure.iothub._feedback_status_code_enum
|
||||
href: com.microsoft.azure.iothub._feedback_status_code_enum.yml
|
||||
langs:
|
||||
- java
|
||||
name: none
|
||||
fullName: com.microsoft.azure.iothub.FeedbackStatusCodeEnum.none
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/FeedbackStatusCodeEnum.java
|
||||
startLine: 7
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public none
|
||||
- uid: com.microsoft.azure.iothub._feedback_status_code_enum.rejected()
|
||||
id: rejected()
|
||||
parent: com.microsoft.azure.iothub._feedback_status_code_enum
|
||||
href: com.microsoft.azure.iothub._feedback_status_code_enum.yml
|
||||
langs:
|
||||
- java
|
||||
name: rejected
|
||||
fullName: com.microsoft.azure.iothub.FeedbackStatusCodeEnum.rejected
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/FeedbackStatusCodeEnum.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public rejected
|
||||
- uid: com.microsoft.azure.iothub._feedback_status_code_enum.success()
|
||||
id: success()
|
||||
parent: com.microsoft.azure.iothub._feedback_status_code_enum
|
||||
href: com.microsoft.azure.iothub._feedback_status_code_enum.yml
|
||||
langs:
|
||||
- java
|
||||
name: success
|
||||
fullName: com.microsoft.azure.iothub.FeedbackStatusCodeEnum.success
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/FeedbackStatusCodeEnum.java
|
||||
startLine: 8
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public success
|
||||
references: []
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_client_protocol
|
||||
id: _iot_hub_client_protocol
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._iot_hub_client_protocol.AMQPS()
|
||||
- com.microsoft.azure.iothub._iot_hub_client_protocol.AMQPS_WS()
|
||||
- com.microsoft.azure.iothub._iot_hub_client_protocol.HTTPS()
|
||||
- com.microsoft.azure.iothub._iot_hub_client_protocol.MQTT()
|
||||
href: com.microsoft.azure.iothub._iot_hub_client_protocol.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubClientProtocol
|
||||
fullName: com.microsoft.azure.iothub.IotHubClientProtocol
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubClientProtocol.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubClientProtocol.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The application-layer protocol used by the client to communicate with an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public enum IotHubClientProtocol
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<IotHubClientProtocol>
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_client_protocol.AMQPS()
|
||||
id: AMQPS()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_client_protocol
|
||||
href: com.microsoft.azure.iothub._iot_hub_client_protocol.yml
|
||||
langs:
|
||||
- java
|
||||
name: AMQPS
|
||||
fullName: com.microsoft.azure.iothub.IotHubClientProtocol.AMQPS
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubClientProtocol.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public AMQPS
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_client_protocol.AMQPS_WS()
|
||||
id: AMQPS_WS()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_client_protocol
|
||||
href: com.microsoft.azure.iothub._iot_hub_client_protocol.yml
|
||||
langs:
|
||||
- java
|
||||
name: AMQPS_WS
|
||||
fullName: com.microsoft.azure.iothub.IotHubClientProtocol.AMQPS_WS
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubClientProtocol.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public AMQPS_WS
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_client_protocol.HTTPS()
|
||||
id: HTTPS()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_client_protocol
|
||||
href: com.microsoft.azure.iothub._iot_hub_client_protocol.yml
|
||||
langs:
|
||||
- java
|
||||
name: HTTPS
|
||||
fullName: com.microsoft.azure.iothub.IotHubClientProtocol.HTTPS
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubClientProtocol.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public HTTPS
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_client_protocol.MQTT()
|
||||
id: MQTT()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_client_protocol
|
||||
href: com.microsoft.azure.iothub._iot_hub_client_protocol.yml
|
||||
langs:
|
||||
- java
|
||||
name: MQTT
|
||||
fullName: com.microsoft.azure.iothub.IotHubClientProtocol.MQTT
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubClientProtocol.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public MQTT
|
||||
references: []
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
id: _iot_hub_event_callback
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._iot_hub_event_callback.execute(IotHubStatusCode,Object)
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubEventCallback
|
||||
fullName: com.microsoft.azure.iothub.IotHubEventCallback
|
||||
type: Interface
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubEventCallback.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubEventCallback.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>An interface for an IoT Hub event callback.</p>
|
||||
|
||||
<p>Developers are expected to create an implementation of this interface, and the transport will call <xref href="com.microsoft.azure.iothub._iot_hub_event_callback.execute(IotHubStatusCode,Object)" data-throw-if-not-resolved="false"></xref> upon receiving a response from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public interface IotHubEventCallback
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback.execute(IotHubStatusCode,Object)
|
||||
id: execute(IotHubStatusCode,Object)
|
||||
parent: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
langs:
|
||||
- java
|
||||
name: execute(IotHubStatusCode responseStatus, Object callbackContext)
|
||||
fullName: void com.microsoft.azure.iothub.IotHubEventCallback.execute(IotHubStatusCode responseStatus, Object callbackContext)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubEventCallback.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Executes the callback.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o1
|
||||
content: public void execute(IotHubStatusCode responseStatus, Object callbackContext)
|
||||
parameters:
|
||||
- id: responseStatus
|
||||
type: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
description: <p>the response status code. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>a custom context given by the developer. </p>
|
||||
references:
|
||||
- uid: "79317049"
|
||||
spec.java:
|
||||
- name: Object
|
||||
fullName: Object
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
name: IotHubStatusCode
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode
|
||||
type: Enum
|
||||
summary: <p>An IoT Hub status code. Included in a message from an IoT Hub to a device. </p>
|
||||
syntax:
|
||||
content: public enum IotHubStatusCode
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback.execute(IotHubStatusCode,Object)
|
||||
parent: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
name: execute(IotHubStatusCode responseStatus, Object callbackContext)
|
||||
fullName: void com.microsoft.azure.iothub.IotHubEventCallback.execute(IotHubStatusCode responseStatus, Object callbackContext)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Executes the callback.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o1
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
id: _iot_hub_message_result
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._iot_hub_message_result.ABANDON()
|
||||
- com.microsoft.azure.iothub._iot_hub_message_result.COMPLETE()
|
||||
- com.microsoft.azure.iothub._iot_hub_message_result.REJECT()
|
||||
href: com.microsoft.azure.iothub._iot_hub_message_result.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubMessageResult
|
||||
fullName: com.microsoft.azure.iothub.IotHubMessageResult
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubMessageResult.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubMessageResult.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>A return value from a message callback that instructs an IoT Hub to complete, abandon, or reject the message. </p>
|
||||
syntax:
|
||||
content: public enum IotHubMessageResult
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<IotHubMessageResult>
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_message_result.ABANDON()
|
||||
id: ABANDON()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
href: com.microsoft.azure.iothub._iot_hub_message_result.yml
|
||||
langs:
|
||||
- java
|
||||
name: ABANDON
|
||||
fullName: com.microsoft.azure.iothub.IotHubMessageResult.ABANDON
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubMessageResult.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public ABANDON
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_message_result.COMPLETE()
|
||||
id: COMPLETE()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
href: com.microsoft.azure.iothub._iot_hub_message_result.yml
|
||||
langs:
|
||||
- java
|
||||
name: COMPLETE
|
||||
fullName: com.microsoft.azure.iothub.IotHubMessageResult.COMPLETE
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubMessageResult.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public COMPLETE
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_message_result.REJECT()
|
||||
id: REJECT()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
href: com.microsoft.azure.iothub._iot_hub_message_result.yml
|
||||
langs:
|
||||
- java
|
||||
name: REJECT
|
||||
fullName: com.microsoft.azure.iothub.IotHubMessageResult.REJECT
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubMessageResult.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public REJECT
|
||||
references: []
|
||||
|
|
@ -0,0 +1,280 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
id: _iot_hub_status_code
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.BAD_FORMAT()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.ERROR()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.getIotHubStatusCode(int)
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.HUB_OR_DEVICE_ID_NOT_FOUND()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.INTERNAL_SERVER_ERROR()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.OK()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.OK_EMPTY()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.PRECONDITION_FAILED()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.REQUEST_ENTITY_TOO_LARGE()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.SERVER_BUSY()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.THROTTLED()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.TOO_MANY_DEVICES()
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code.UNAUTHORIZED()
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubStatusCode
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 8
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>An IoT Hub status code. Included in a message from an IoT Hub to a device. </p>
|
||||
syntax: &o1
|
||||
content: public enum IotHubStatusCode
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<IotHubStatusCode>
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iothub._iot_hub_status_code_1a1004f8e31ebd88bb4360d642fa2dcebc
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.BAD_FORMAT()
|
||||
id: BAD_FORMAT()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: BAD_FORMAT
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.BAD_FORMAT
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public BAD_FORMAT
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.ERROR()
|
||||
id: ERROR()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: ERROR
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.ERROR
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public ERROR
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.getIotHubStatusCode(int)
|
||||
id: getIotHubStatusCode(int)
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: getIotHubStatusCode(int httpsStatus)
|
||||
fullName: static IotHubStatusCode com.microsoft.azure.iothub.IotHubStatusCode.getIotHubStatusCode(int httpsStatus)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 25
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Returns the IoT Hub status code referenced by the HTTPS status code.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static IotHubStatusCode getIotHubStatusCode(int httpsStatus)
|
||||
parameters:
|
||||
- id: httpsStatus
|
||||
type: f75371fa
|
||||
description: <p>the HTTPS status code.</p>
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
description: <p>the corresponding IoT Hub status code.</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if the HTTPS status code does not map to an IoT Hub status code. </p>
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.HUB_OR_DEVICE_ID_NOT_FOUND()
|
||||
id: HUB_OR_DEVICE_ID_NOT_FOUND()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: HUB_OR_DEVICE_ID_NOT_FOUND
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.HUB_OR_DEVICE_ID_NOT_FOUND
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public HUB_OR_DEVICE_ID_NOT_FOUND
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.INTERNAL_SERVER_ERROR()
|
||||
id: INTERNAL_SERVER_ERROR()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: INTERNAL_SERVER_ERROR
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.INTERNAL_SERVER_ERROR
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public INTERNAL_SERVER_ERROR
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.OK()
|
||||
id: OK()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: OK
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.OK
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public OK
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.OK_EMPTY()
|
||||
id: OK_EMPTY()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: OK_EMPTY
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.OK_EMPTY
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public OK_EMPTY
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.PRECONDITION_FAILED()
|
||||
id: PRECONDITION_FAILED()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: PRECONDITION_FAILED
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.PRECONDITION_FAILED
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public PRECONDITION_FAILED
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.REQUEST_ENTITY_TOO_LARGE()
|
||||
id: REQUEST_ENTITY_TOO_LARGE()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: REQUEST_ENTITY_TOO_LARGE
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.REQUEST_ENTITY_TOO_LARGE
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public REQUEST_ENTITY_TOO_LARGE
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.SERVER_BUSY()
|
||||
id: SERVER_BUSY()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: SERVER_BUSY
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.SERVER_BUSY
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public SERVER_BUSY
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.THROTTLED()
|
||||
id: THROTTLED()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: THROTTLED
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.THROTTLED
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public THROTTLED
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.TOO_MANY_DEVICES()
|
||||
id: TOO_MANY_DEVICES()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: TOO_MANY_DEVICES
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.TOO_MANY_DEVICES
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public TOO_MANY_DEVICES
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code.UNAUTHORIZED()
|
||||
id: UNAUTHORIZED()
|
||||
parent: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
langs:
|
||||
- java
|
||||
name: UNAUTHORIZED
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode.UNAUTHORIZED
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/IotHubStatusCode.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public UNAUTHORIZED
|
||||
references:
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code_1a1004f8e31ebd88bb4360d642fa2dcebc
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
name: IotHubStatusCode
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode
|
||||
type: Enum
|
||||
summary: <p>An IoT Hub status code. Included in a message from an IoT Hub to a device. </p>
|
||||
syntax: *o1
|
||||
|
|
@ -0,0 +1,438 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
id: _message
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._message.DEFAULT_IOTHUB_MESSAGE_CHARSET()
|
||||
- com.microsoft.azure.iothub._message.getBodyStream()
|
||||
- com.microsoft.azure.iothub._message.getBytes()
|
||||
- com.microsoft.azure.iothub._message.getCorrelationId()
|
||||
- com.microsoft.azure.iothub._message.getMessageId()
|
||||
- com.microsoft.azure.iothub._message.getProperties()
|
||||
- com.microsoft.azure.iothub._message.getProperty(String)
|
||||
- com.microsoft.azure.iothub._message.isExpired()
|
||||
- com.microsoft.azure.iothub._message.Message()
|
||||
- com.microsoft.azure.iothub._message.Message(byte [])
|
||||
- com.microsoft.azure.iothub._message.Message(ByteArrayInputStream)
|
||||
- com.microsoft.azure.iothub._message.Message(String)
|
||||
- com.microsoft.azure.iothub._message.setCorrelationId(String)
|
||||
- com.microsoft.azure.iothub._message.setExpiryTime(long)
|
||||
- com.microsoft.azure.iothub._message.setMessageId(String)
|
||||
- com.microsoft.azure.iothub._message.setProperty(String,String)
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax: &o1
|
||||
content: public class Message
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub._message.DEFAULT_IOTHUB_MESSAGE_CHARSET()
|
||||
id: DEFAULT_IOTHUB_MESSAGE_CHARSET()
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: DEFAULT_IOTHUB_MESSAGE_CHARSET
|
||||
fullName: final Charset com.microsoft.azure.iothub.Message.DEFAULT_IOTHUB_MESSAGE_CHARSET
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public static final Charset DEFAULT_IOTHUB_MESSAGE_CHARSET= StandardCharsets.UTF_8
|
||||
return:
|
||||
type: d07b5f81
|
||||
- uid: com.microsoft.azure.iothub._message.getBodyStream()
|
||||
id: getBodyStream()
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getBodyStream()
|
||||
fullName: ByteArrayOutputStream com.microsoft.azure.iothub.Message.getBodyStream()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 174
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The stream content of the body. </p>
|
||||
syntax:
|
||||
content: public ByteArrayOutputStream getBodyStream()
|
||||
return:
|
||||
type: 73a378c9
|
||||
- uid: com.microsoft.azure.iothub._message.getBytes()
|
||||
id: getBytes()
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getBytes()
|
||||
fullName: byte [] com.microsoft.azure.iothub.Message.getBytes()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 182
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The byte content of the body. </p>
|
||||
syntax:
|
||||
content: public byte [] getBytes()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>A copy of this <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> body, as a byte array. </p>
|
||||
- uid: com.microsoft.azure.iothub._message.getCorrelationId()
|
||||
id: getCorrelationId()
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getCorrelationId()
|
||||
fullName: String com.microsoft.azure.iothub.Message.getCorrelationId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 350
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Getter for the correlationId property </p>
|
||||
syntax:
|
||||
content: public String getCorrelationId()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The property value </p>
|
||||
- uid: com.microsoft.azure.iothub._message.getMessageId()
|
||||
id: getMessageId()
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getMessageId()
|
||||
fullName: String com.microsoft.azure.iothub.Message.getMessageId()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 332
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Getter for the messageId property </p>
|
||||
syntax:
|
||||
content: public String getMessageId()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The property value </p>
|
||||
- uid: com.microsoft.azure.iothub._message.getProperties()
|
||||
id: getProperties()
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getProperties()
|
||||
fullName: MessageProperty [] com.microsoft.azure.iothub.Message.getProperties()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 258
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Returns a copy of the message properties.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public MessageProperty [] getProperties()
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._message_propertye5b41c5f
|
||||
description: <p>a copy of the message properties. </p>
|
||||
- uid: com.microsoft.azure.iothub._message.getProperty(String)
|
||||
id: getProperty(String)
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getProperty(String name)
|
||||
fullName: String com.microsoft.azure.iothub.Message.getProperty(String name)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 199
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Gets the values of user-defined properties of this <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
syntax:
|
||||
content: public String getProperty(String name)
|
||||
parameters:
|
||||
- id: name
|
||||
type: "26831127"
|
||||
description: <p>Name of the user-defined property to search for. </p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>The value of the property if it is set, or null otherwise. </p>
|
||||
- uid: com.microsoft.azure.iothub._message.isExpired()
|
||||
id: isExpired()
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: isExpired()
|
||||
fullName: boolean com.microsoft.azure.iothub.Message.isExpired()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 302
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Verifies whether the message is expired or not </p>
|
||||
syntax:
|
||||
content: public boolean isExpired()
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: <p>true if the message is expired, false otherwise </p>
|
||||
- uid: com.microsoft.azure.iothub._message.Message()
|
||||
id: Message()
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message()
|
||||
fullName: com.microsoft.azure.iothub.Message.Message()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 125
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Constructor. </p>
|
||||
syntax:
|
||||
content: public Message()
|
||||
- uid: com.microsoft.azure.iothub._message.Message(byte [])
|
||||
id: Message(byte [])
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message(byte[] body)
|
||||
fullName: com.microsoft.azure.iothub.Message.Message(byte[] body)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 142
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Constructor. </p>
|
||||
syntax:
|
||||
content: public Message(byte[] body)
|
||||
parameters:
|
||||
- id: body
|
||||
type: ccd9418d
|
||||
description: <p>The body of the new <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> instance. </p>
|
||||
- uid: com.microsoft.azure.iothub._message.Message(ByteArrayInputStream)
|
||||
id: Message(ByteArrayInputStream)
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message(ByteArrayInputStream stream)
|
||||
fullName: com.microsoft.azure.iothub.Message.Message(ByteArrayInputStream stream)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 133
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Constructor. </p>
|
||||
syntax:
|
||||
content: public Message(ByteArrayInputStream stream)
|
||||
parameters:
|
||||
- id: stream
|
||||
type: f03846a9
|
||||
description: <p>A stream to provide the body of the new <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> instance. </p>
|
||||
- uid: com.microsoft.azure.iothub._message.Message(String)
|
||||
id: Message(String)
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: Message(String body)
|
||||
fullName: com.microsoft.azure.iothub.Message.Message(String body)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 158
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Constructor. </p>
|
||||
syntax:
|
||||
content: public Message(String body)
|
||||
parameters:
|
||||
- id: body
|
||||
type: "26831127"
|
||||
description: <p>The body of the new <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> instance. It is internally serialized to a byte array using UTF-8 encoding. </p>
|
||||
- uid: com.microsoft.azure.iothub._message.setCorrelationId(String)
|
||||
id: setCorrelationId(String)
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setCorrelationId(String correlationId)
|
||||
fullName: void com.microsoft.azure.iothub.Message.setCorrelationId(String correlationId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 359
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Setter for the correlationId property </p>
|
||||
syntax:
|
||||
content: public void setCorrelationId(String correlationId)
|
||||
parameters:
|
||||
- id: correlationId
|
||||
type: "26831127"
|
||||
description: <p>The string containing the property value </p>
|
||||
- uid: com.microsoft.azure.iothub._message.setExpiryTime(long)
|
||||
id: setExpiryTime(long)
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setExpiryTime(long timeOut)
|
||||
fullName: void com.microsoft.azure.iothub.Message.setExpiryTime(long timeOut)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 368
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Setter for the expiryTime property </p>
|
||||
syntax:
|
||||
content: public void setExpiryTime(long timeOut)
|
||||
parameters:
|
||||
- id: timeOut
|
||||
type: 0364520f
|
||||
description: <p>The time out for the message, in milliseconds. </p>
|
||||
- uid: com.microsoft.azure.iothub._message.setMessageId(String)
|
||||
id: setMessageId(String)
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setMessageId(String messageId)
|
||||
fullName: void com.microsoft.azure.iothub.Message.setMessageId(String messageId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 341
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Setter for the messageId property </p>
|
||||
syntax:
|
||||
content: public void setMessageId(String messageId)
|
||||
parameters:
|
||||
- id: messageId
|
||||
type: "26831127"
|
||||
description: <p>The string containing the property value </p>
|
||||
- uid: com.microsoft.azure.iothub._message.setProperty(String,String)
|
||||
id: setProperty(String,String)
|
||||
parent: com.microsoft.azure.iothub._message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setProperty(String name, String value)
|
||||
fullName: void com.microsoft.azure.iothub.Message.setProperty(String name, String value)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/Message.java
|
||||
startLine: 225
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>Adds or sets user-defined properties of this <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
syntax:
|
||||
content: public void setProperty(String name, String value)
|
||||
parameters:
|
||||
- id: name
|
||||
type: "26831127"
|
||||
description: <p>Name of the property to be set. </p>
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>Value of the property to be set. </p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>If any of the arguments provided is null. </p>
|
||||
references:
|
||||
- uid: d07b5f81
|
||||
spec.java:
|
||||
- name: final Charset
|
||||
fullName: final Charset
|
||||
- uid: f03846a9
|
||||
spec.java:
|
||||
- name: ByteArrayInputStream
|
||||
fullName: ByteArrayInputStream
|
||||
- uid: ccd9418d
|
||||
spec.java:
|
||||
- name: byte []
|
||||
fullName: byte []
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 73a378c9
|
||||
spec.java:
|
||||
- name: ByteArrayOutputStream
|
||||
fullName: ByteArrayOutputStream
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: com.microsoft.azure.iothub._message_propertye5b41c5f
|
||||
spec.java:
|
||||
- uid: com.microsoft.azure.iothub._message_property
|
||||
name: MessageProperty
|
||||
fullName: com.microsoft.azure.iothub.MessageProperty
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
- name: " []"
|
||||
fullName: " []"
|
||||
- uid: 4fc6e284
|
||||
spec.java:
|
||||
- name: boolean
|
||||
fullName: boolean
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: com.microsoft.azure.iothub._feedback_status_code_enum
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._feedback_status_code_enum.yml
|
||||
name: FeedbackStatusCodeEnum
|
||||
fullName: com.microsoft.azure.iothub.FeedbackStatusCodeEnum
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum FeedbackStatusCodeEnum
|
||||
- uid: com.microsoft.azure.iothub._message_property
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
name: MessageProperty
|
||||
fullName: com.microsoft.azure.iothub.MessageProperty
|
||||
type: Class
|
||||
summary: <p>An IoT Hub message property. </p>
|
||||
syntax:
|
||||
content: public class MessageProperty
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
syntax: *o1
|
||||
|
|
@ -0,0 +1,89 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._message_callback
|
||||
id: _message_callback
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._message_callback.execute(Message,Object)
|
||||
href: com.microsoft.azure.iothub._message_callback.yml
|
||||
langs:
|
||||
- java
|
||||
name: MessageCallback
|
||||
fullName: com.microsoft.azure.iothub.MessageCallback
|
||||
type: Interface
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageCallback.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageCallback.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>An interface for an IoT Hub message callback. </p>
|
||||
|
||||
<p>The developer is expected to create an implementation of this interface, and the transport will call <xref href="com.microsoft.azure.iothub._message_callback.execute(Message,Object)" data-throw-if-not-resolved="false"></xref> upon receiving a message from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public interface MessageCallback
|
||||
- uid: com.microsoft.azure.iothub._message_callback.execute(Message,Object)
|
||||
id: execute(Message,Object)
|
||||
parent: com.microsoft.azure.iothub._message_callback
|
||||
href: com.microsoft.azure.iothub._message_callback.yml
|
||||
langs:
|
||||
- java
|
||||
name: execute(Message message, Object callbackContext)
|
||||
fullName: IotHubMessageResult com.microsoft.azure.iothub.MessageCallback.execute(Message message, Object callbackContext)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageCallback.java
|
||||
startLine: 24
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Executes the callback. The callback should return a response that instructs an IoT Hub to complete, abandon, or reject the message.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o1
|
||||
content: public IotHubMessageResult execute(Message message, Object callbackContext)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>a custom context given by the developer.</p>
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
description: <p>whether the IoT Hub should complete, abandon, or reject the message. </p>
|
||||
references:
|
||||
- uid: "79317049"
|
||||
spec.java:
|
||||
- name: Object
|
||||
fullName: Object
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_message_result.yml
|
||||
name: IotHubMessageResult
|
||||
fullName: com.microsoft.azure.iothub.IotHubMessageResult
|
||||
type: Enum
|
||||
summary: <p>A return value from a message callback that instructs an IoT Hub to complete, abandon, or reject the message. </p>
|
||||
syntax:
|
||||
content: public enum IotHubMessageResult
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iothub._message_callback.execute(Message,Object)
|
||||
parent: com.microsoft.azure.iothub._message_callback
|
||||
href: com.microsoft.azure.iothub._message_callback.yml
|
||||
name: execute(Message message, Object callbackContext)
|
||||
fullName: IotHubMessageResult com.microsoft.azure.iothub.MessageCallback.execute(Message message, Object callbackContext)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Executes the callback. The callback should return a response that instructs an IoT Hub to complete, abandon, or reject the message.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o1
|
||||
|
|
@ -0,0 +1,291 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._message_property
|
||||
id: _message_property
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._message_property.getName()
|
||||
- com.microsoft.azure.iothub._message_property.getValue()
|
||||
- com.microsoft.azure.iothub._message_property.hasSameName(String)
|
||||
- com.microsoft.azure.iothub._message_property.isValidAppProperty(String,String)
|
||||
- com.microsoft.azure.iothub._message_property.MessageProperty()
|
||||
- com.microsoft.azure.iothub._message_property.MessageProperty(String,String)
|
||||
- com.microsoft.azure.iothub._message_property.name()
|
||||
- com.microsoft.azure.iothub._message_property.RESERVED_PROPERTY_NAMES()
|
||||
- com.microsoft.azure.iothub._message_property.usesValidChars(String)
|
||||
- com.microsoft.azure.iothub._message_property.value()
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: MessageProperty
|
||||
fullName: com.microsoft.azure.iothub.MessageProperty
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>An IoT Hub message property. </p>
|
||||
syntax:
|
||||
content: public class MessageProperty
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iothub._message_property.[static initializer]()
|
||||
- uid: com.microsoft.azure.iothub._message_property.getName()
|
||||
id: getName()
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: getName()
|
||||
fullName: String com.microsoft.azure.iothub.MessageProperty.getName()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 93
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Returns the property name.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getName()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the property name. </p>
|
||||
- uid: com.microsoft.azure.iothub._message_property.getValue()
|
||||
id: getValue()
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: getValue()
|
||||
fullName: String com.microsoft.azure.iothub.MessageProperty.getValue()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 103
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Returns the property value.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getValue()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the property value. </p>
|
||||
- uid: com.microsoft.azure.iothub._message_property.hasSameName(String)
|
||||
id: hasSameName(String)
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: hasSameName(String name)
|
||||
fullName: boolean com.microsoft.azure.iothub.MessageProperty.hasSameName(String name)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 115
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Equivalent to property.getName().equalsIgnoreCase(name).</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public boolean hasSameName(String name)
|
||||
parameters:
|
||||
- id: name
|
||||
type: "26831127"
|
||||
description: <p>the property name.</p>
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: <p>true if the given name is the property name. </p>
|
||||
- uid: com.microsoft.azure.iothub._message_property.isValidAppProperty(String,String)
|
||||
id: isValidAppProperty(String,String)
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: isValidAppProperty(String name, String value)
|
||||
fullName: static boolean com.microsoft.azure.iothub.MessageProperty.isValidAppProperty(String name, String value)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 137
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Returns whether the property is a valid application property. The property is valid if it is not one of the reserved properties, only uses US-ASCII printable chars, and does not contain: (space) (horizontal tab).</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static boolean isValidAppProperty(String name, String value)
|
||||
parameters:
|
||||
- id: name
|
||||
type: "26831127"
|
||||
description: <p>the property name. </p>
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>the property value.</p>
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: <p>whether the property is a valid application property. </p>
|
||||
- uid: com.microsoft.azure.iothub._message_property.MessageProperty()
|
||||
id: MessageProperty()
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: MessageProperty()
|
||||
fullName: com.microsoft.azure.iothub.MessageProperty.MessageProperty()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 172
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: protected MessageProperty()
|
||||
- uid: com.microsoft.azure.iothub._message_property.MessageProperty(String,String)
|
||||
id: MessageProperty(String,String)
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: MessageProperty(String name, String value)
|
||||
fullName: com.microsoft.azure.iothub.MessageProperty.MessageProperty(String name, String value)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 55
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Constructor.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public MessageProperty(String name, String value)
|
||||
parameters:
|
||||
- id: name
|
||||
type: "26831127"
|
||||
description: <p>The IoT Hub message property name. </p>
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>The IoT Hub message property value.</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if the name and value constitute an invalid IoT Hub message property. A message property can only contain US-ASCII printable chars, with some exceptions as specified in RFC 2047. A message property name cannot be one of the reserved property names. </p>
|
||||
- uid: com.microsoft.azure.iothub._message_property.name()
|
||||
id: name()
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: name
|
||||
fullName: final String com.microsoft.azure.iothub.MessageProperty.name
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 40
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The property name. </p>
|
||||
syntax:
|
||||
content: protected final String name
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub._message_property.RESERVED_PROPERTY_NAMES()
|
||||
id: RESERVED_PROPERTY_NAMES()
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: RESERVED_PROPERTY_NAMES
|
||||
fullName: final Set<String> com.microsoft.azure.iothub.MessageProperty.RESERVED_PROPERTY_NAMES
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>A set of reserved property names. The reserved property names are interpreted in a meaningful way by the device and the IoT Hub. </p>
|
||||
syntax:
|
||||
content: public static final Set<String> RESERVED_PROPERTY_NAMES
|
||||
return:
|
||||
type: 04c36f7e
|
||||
- uid: com.microsoft.azure.iothub._message_property.usesValidChars(String)
|
||||
id: usesValidChars(String)
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: usesValidChars(String s)
|
||||
fullName: static boolean com.microsoft.azure.iothub.MessageProperty.usesValidChars(String s)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 159
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: >-
|
||||
<p>Returns true if the string only uses US-ASCII printable chars and does not contain: (space) (horizontal tab)</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static boolean usesValidChars(String s)
|
||||
parameters:
|
||||
- id: s
|
||||
type: "26831127"
|
||||
description: <p>the string.</p>
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: '<p>whether the string only uses US-ASCII printable chars and does not contain: <code>()<>@,;:"/[]?={}</code> (space) (horizontal tab) </p>'
|
||||
- uid: com.microsoft.azure.iothub._message_property.value()
|
||||
id: value()
|
||||
parent: com.microsoft.azure.iothub._message_property
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
langs:
|
||||
- java
|
||||
name: value
|
||||
fullName: final String com.microsoft.azure.iothub.MessageProperty.value
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/MessageProperty.java
|
||||
startLine: 42
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>The property value. </p>
|
||||
syntax:
|
||||
content: protected final String value
|
||||
return:
|
||||
type: 3d93591e
|
||||
references:
|
||||
- uid: 04c36f7e
|
||||
spec.java:
|
||||
- name: final Set<String>
|
||||
fullName: final Set<String>
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 4fc6e284
|
||||
spec.java:
|
||||
- name: boolean
|
||||
fullName: boolean
|
||||
- uid: com.microsoft.azure.iothub._message_property.[static initializer]()
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub._object_lock
|
||||
id: _object_lock
|
||||
parent: com.microsoft.azure.iothub
|
||||
children:
|
||||
- com.microsoft.azure.iothub._object_lock.notifyLock()
|
||||
- com.microsoft.azure.iothub._object_lock.waitLock(long)
|
||||
href: com.microsoft.azure.iothub._object_lock.yml
|
||||
langs:
|
||||
- java
|
||||
name: ObjectLock
|
||||
fullName: com.microsoft.azure.iothub.ObjectLock
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/ObjectLock.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/ObjectLock.java
|
||||
startLine: 4
|
||||
package: com.microsoft.azure.iothub
|
||||
summary: <p>This class enables mocking of the base class wait and notify functions </p>
|
||||
syntax:
|
||||
content: public class ObjectLock
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub._object_lock.notifyLock()
|
||||
id: notifyLock()
|
||||
parent: com.microsoft.azure.iothub._object_lock
|
||||
href: com.microsoft.azure.iothub._object_lock.yml
|
||||
langs:
|
||||
- java
|
||||
name: notifyLock()
|
||||
fullName: void com.microsoft.azure.iothub.ObjectLock.notifyLock()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/ObjectLock.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public void notifyLock()
|
||||
- uid: com.microsoft.azure.iothub._object_lock.waitLock(long)
|
||||
id: waitLock(long)
|
||||
parent: com.microsoft.azure.iothub._object_lock
|
||||
href: com.microsoft.azure.iothub._object_lock.yml
|
||||
langs:
|
||||
- java
|
||||
name: waitLock(long timeout)
|
||||
fullName: void com.microsoft.azure.iothub.ObjectLock.waitLock(long timeout)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/ObjectLock.java
|
||||
startLine: 6
|
||||
package: com.microsoft.azure.iothub
|
||||
syntax:
|
||||
content: public void waitLock(long timeout)
|
||||
parameters:
|
||||
- id: timeout
|
||||
type: 0364520f
|
||||
references:
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
|
|
@ -0,0 +1,256 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
id: _iot_hub_sas_token
|
||||
parent: com.microsoft.azure.iothub.auth
|
||||
children:
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.buildSasToken()
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.expiryTime()
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.IotHubSasToken()
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.IotHubSasToken(DeviceClientConfig,long)
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.isSasFormat()
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.sasToken()
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.scope()
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.signature()
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.TOKEN_FORMAT()
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token.toString()
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubSasToken
|
||||
fullName: com.microsoft.azure.iothub.auth.IotHubSasToken
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: <p>Grants device access to an IoT Hub for the specified amount of time. </p>
|
||||
syntax:
|
||||
content: public class IotHubSasToken
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.buildSasToken()
|
||||
id: buildSasToken()
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: buildSasToken()
|
||||
fullName: String com.microsoft.azure.iothub.auth.IotHubSasToken.buildSasToken()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 108
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
syntax:
|
||||
content: protected String buildSasToken()
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.expiryTime()
|
||||
id: expiryTime()
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: expiryTime
|
||||
fullName: long com.microsoft.azure.iothub.auth.IotHubSasToken.expiryTime
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 22
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: <p>The time, as a UNIX timestamp, before which the token is valid. </p>
|
||||
syntax:
|
||||
content: protected long expiryTime= 0l
|
||||
return:
|
||||
type: 0364520f
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.IotHubSasToken()
|
||||
id: IotHubSasToken()
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubSasToken()
|
||||
fullName: com.microsoft.azure.iothub.auth.IotHubSasToken.IotHubSasToken()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 113
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
syntax:
|
||||
content: protected IotHubSasToken()
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.IotHubSasToken(DeviceClientConfig,long)
|
||||
id: IotHubSasToken(DeviceClientConfig,long)
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubSasToken(DeviceClientConfig config, long expiryTime)
|
||||
fullName: com.microsoft.azure.iothub.auth.IotHubSasToken.IotHubSasToken(DeviceClientConfig config, long expiryTime)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 37
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: >-
|
||||
<p>Constructor. Generates a SAS token that grants access to an IoT Hub for the specified amount of time.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubSasToken(DeviceClientConfig config, long expiryTime)
|
||||
parameters:
|
||||
- id: config
|
||||
type: com.microsoft.azure.iothub._device_client_config
|
||||
description: <p>the device client config. </p>
|
||||
- id: expiryTime
|
||||
type: 0364520f
|
||||
description: <p>the time, as a UNIX timestamp, after which the token will become invalid. </p>
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.isSasFormat()
|
||||
id: isSasFormat()
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: isSasFormat()
|
||||
fullName: boolean com.microsoft.azure.iothub.auth.IotHubSasToken.isSasFormat()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 89
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
syntax:
|
||||
content: protected boolean isSasFormat()
|
||||
return:
|
||||
type: 4fc6e284
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.sasToken()
|
||||
id: sasToken()
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: sasToken
|
||||
fullName: String com.microsoft.azure.iothub.auth.IotHubSasToken.sasToken
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
syntax:
|
||||
content: protected String sasToken= null
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.scope()
|
||||
id: scope()
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: scope
|
||||
fullName: String com.microsoft.azure.iothub.auth.IotHubSasToken.scope
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 27
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: <p>The URI for a connection from a device to an IoT Hub. Does not include a protocol. </p>
|
||||
syntax:
|
||||
content: protected String scope= null
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.signature()
|
||||
id: signature()
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: signature
|
||||
fullName: String com.microsoft.azure.iothub.auth.IotHubSasToken.signature
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: <p>Components of the SAS token. </p>
|
||||
syntax:
|
||||
content: protected String signature= null
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.TOKEN_FORMAT()
|
||||
id: TOKEN_FORMAT()
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: TOKEN_FORMAT
|
||||
fullName: final String com.microsoft.azure.iothub.auth.IotHubSasToken.TOKEN_FORMAT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 16
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: '<p>The SAS token format. The parameters to be interpolated are, in order: the signature, the expiry time, the key name (device ID), and the resource URI. </p>'
|
||||
syntax:
|
||||
content: public static final String TOKEN_FORMAT= "SharedAccessSignature sig=%s&se=%s&sr=%s"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iothub.auth.IotHubSasToken.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 70
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: >-
|
||||
<p>Returns the string representation of the SAS token.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the SAS token. </p>
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: 4fc6e284
|
||||
spec.java:
|
||||
- name: boolean
|
||||
fullName: boolean
|
||||
- uid: com.microsoft.azure.iothub._device_client_config
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
name: DeviceClientConfig
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig
|
||||
type: Class
|
||||
summary: <p>Configuration settings for an IoT Hub client. Validates all user-defined settings. </p>
|
||||
syntax:
|
||||
content: public class DeviceClientConfig
|
||||
|
|
@ -0,0 +1,104 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.auth._signature
|
||||
id: _signature
|
||||
parent: com.microsoft.azure.iothub.auth
|
||||
children:
|
||||
- com.microsoft.azure.iothub.auth._signature.sig()
|
||||
- com.microsoft.azure.iothub.auth._signature.Signature(String,long,String)
|
||||
- com.microsoft.azure.iothub.auth._signature.toString()
|
||||
href: com.microsoft.azure.iothub.auth._signature.yml
|
||||
langs:
|
||||
- java
|
||||
name: Signature
|
||||
fullName: com.microsoft.azure.iothub.auth.Signature
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/Signature.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/Signature.java
|
||||
startLine: 8
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: <p>A signature that is used in the SAS token to authenticate the client. </p>
|
||||
syntax:
|
||||
content: public class Signature
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.auth._signature.sig()
|
||||
id: sig()
|
||||
parent: com.microsoft.azure.iothub.auth._signature
|
||||
href: com.microsoft.azure.iothub.auth._signature.yml
|
||||
langs:
|
||||
- java
|
||||
name: sig
|
||||
fullName: String com.microsoft.azure.iothub.auth.Signature.sig
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/Signature.java
|
||||
startLine: 10
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
syntax:
|
||||
content: protected String sig
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.auth._signature.Signature(String,long,String)
|
||||
id: Signature(String,long,String)
|
||||
parent: com.microsoft.azure.iothub.auth._signature
|
||||
href: com.microsoft.azure.iothub.auth._signature.yml
|
||||
langs:
|
||||
- java
|
||||
name: Signature(String resourceUri, long expiryTime, String deviceKey)
|
||||
fullName: com.microsoft.azure.iothub.auth.Signature.Signature(String resourceUri, long expiryTime, String deviceKey)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/Signature.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: <p>Constructs a<programlisting><codeline><highlight class="normal">Signature<sp></sp></highlight></codeline></programlisting> instance from the given resource URI, expiry time and device key. </p>
|
||||
syntax:
|
||||
content: public Signature(String resourceUri, long expiryTime, String deviceKey)
|
||||
parameters:
|
||||
- id: resourceUri
|
||||
type: "26831127"
|
||||
description: <p>the resource URI. </p>
|
||||
- id: expiryTime
|
||||
type: 0364520f
|
||||
description: <p>the time, as a UNIX timestamp, after which the token will become invalid. </p>
|
||||
- id: deviceKey
|
||||
type: "26831127"
|
||||
description: <p>the device key. </p>
|
||||
- uid: com.microsoft.azure.iothub.auth._signature.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iothub.auth._signature
|
||||
href: com.microsoft.azure.iothub.auth._signature.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iothub.auth.Signature.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/Signature.java
|
||||
startLine: 44
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: >-
|
||||
<p>Returns the string representation of the signature.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the signature. </p>
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
|
|
@ -0,0 +1,276 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper
|
||||
id: _signature_helper
|
||||
parent: com.microsoft.azure.iothub.auth
|
||||
children:
|
||||
- com.microsoft.azure.iothub.auth._signature_helper.buildRawSignature(String,long)
|
||||
- com.microsoft.azure.iothub.auth._signature_helper.decodeDeviceKeyBase64(String)
|
||||
- com.microsoft.azure.iothub.auth._signature_helper.encodeSignatureBase64(byte [])
|
||||
- com.microsoft.azure.iothub.auth._signature_helper.encodeSignatureUtf8(byte [])
|
||||
- com.microsoft.azure.iothub.auth._signature_helper.encodeSignatureWebSafe(String)
|
||||
- com.microsoft.azure.iothub.auth._signature_helper.encryptSignatureHmacSha256(byte [],byte [])
|
||||
- com.microsoft.azure.iothub.auth._signature_helper.RAW_SIGNATURE_FORMAT()
|
||||
- com.microsoft.azure.iothub.auth._signature_helper.SIGNATURE_CHARSET()
|
||||
- com.microsoft.azure.iothub.auth._signature_helper.SignatureHelper()
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: SignatureHelper
|
||||
fullName: com.microsoft.azure.iothub.auth.SignatureHelper
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: <p>Builds the authorization signature as a composition of functions. </p>
|
||||
syntax:
|
||||
content: public class SignatureHelper
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper.buildRawSignature(String,long)
|
||||
id: buildRawSignature(String,long)
|
||||
parent: com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: buildRawSignature(String resourceUri, long expiryTime)
|
||||
fullName: static byte [] com.microsoft.azure.iothub.auth.SignatureHelper.buildRawSignature(String resourceUri, long expiryTime)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 36
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: >-
|
||||
<p>Builds the raw signature.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static byte [] buildRawSignature(String resourceUri, long expiryTime)
|
||||
parameters:
|
||||
- id: resourceUri
|
||||
type: "26831127"
|
||||
description: <p>the resource URI. </p>
|
||||
- id: expiryTime
|
||||
type: 0364520f
|
||||
description: <p>the signature expiry time, as a UNIX timestamp.</p>
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>the raw signature. </p>
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper.decodeDeviceKeyBase64(String)
|
||||
id: decodeDeviceKeyBase64(String)
|
||||
parent: com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: decodeDeviceKeyBase64(String deviceKey)
|
||||
fullName: static byte [] com.microsoft.azure.iothub.auth.SignatureHelper.decodeDeviceKeyBase64(String deviceKey)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 51
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: >-
|
||||
<p>Decodes the deviceKey using Base64.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static byte [] decodeDeviceKeyBase64(String deviceKey)
|
||||
parameters:
|
||||
- id: deviceKey
|
||||
type: "26831127"
|
||||
description: <p>the device key.</p>
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>the Base64-decoded device key. </p>
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper.encodeSignatureBase64(byte [])
|
||||
id: encodeSignatureBase64(byte [])
|
||||
parent: com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: encodeSignatureBase64(byte[] sig)
|
||||
fullName: static byte [] com.microsoft.azure.iothub.auth.SignatureHelper.encodeSignatureBase64(byte[] sig)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 101
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: >-
|
||||
<p>Encodes the signature using Base64 and then further encodes the resulting string using UTF-8 encoding.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static byte [] encodeSignatureBase64(byte[] sig)
|
||||
parameters:
|
||||
- id: sig
|
||||
type: ccd9418d
|
||||
description: <p>the HMAC-SHA256 encrypted signature.</p>
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>the Base64-encoded signature. </p>
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper.encodeSignatureUtf8(byte [])
|
||||
id: encodeSignatureUtf8(byte [])
|
||||
parent: com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: encodeSignatureUtf8(byte[] sig)
|
||||
fullName: static String com.microsoft.azure.iothub.auth.SignatureHelper.encodeSignatureUtf8(byte[] sig)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 114
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: >-
|
||||
<p>Encodes the signature using charset UTF-8.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static String encodeSignatureUtf8(byte[] sig)
|
||||
parameters:
|
||||
- id: sig
|
||||
type: ccd9418d
|
||||
description: <p>the HMAC-SHA256 encrypted, Base64-encoded signature.</p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the signature encoded using charset UTF-8. </p>
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper.encodeSignatureWebSafe(String)
|
||||
id: encodeSignatureWebSafe(String)
|
||||
parent: com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: encodeSignatureWebSafe(String sig)
|
||||
fullName: static String com.microsoft.azure.iothub.auth.SignatureHelper.encodeSignatureWebSafe(String sig)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 131
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: >-
|
||||
<p>Safely escapes characters in the signature so that they can be transmitted over the internet. Replaces unsafe characters with a '' followed by two hexadecimal digits (i.e. %2d).</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static String encodeSignatureWebSafe(String sig)
|
||||
parameters:
|
||||
- id: sig
|
||||
type: "26831127"
|
||||
description: <p>the HMAC-SHA256 encrypted, Base64-encoded, UTF-8 encoded signature.</p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the web-safe encoding of the signature. </p>
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper.encryptSignatureHmacSha256(byte [],byte [])
|
||||
id: encryptSignatureHmacSha256(byte [],byte [])
|
||||
parent: com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: encryptSignatureHmacSha256(byte[] sig, byte[] deviceKey)
|
||||
fullName: static byte [] com.microsoft.azure.iothub.auth.SignatureHelper.encryptSignatureHmacSha256(byte[] sig, byte[] deviceKey)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 65
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: >-
|
||||
<p>Encrypts the signature using HMAC-SHA256.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static byte [] encryptSignatureHmacSha256(byte[] sig, byte[] deviceKey)
|
||||
parameters:
|
||||
- id: sig
|
||||
type: ccd9418d
|
||||
description: <p>the unencrypted signature. </p>
|
||||
- id: deviceKey
|
||||
type: ccd9418d
|
||||
description: <p>the Base64-decoded device key.</p>
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>the HMAC-SHA256 encrypted signature. </p>
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper.RAW_SIGNATURE_FORMAT()
|
||||
id: RAW_SIGNATURE_FORMAT()
|
||||
parent: com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: RAW_SIGNATURE_FORMAT
|
||||
fullName: final String com.microsoft.azure.iothub.auth.SignatureHelper.RAW_SIGNATURE_FORMAT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 23
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: <p>The device ID will be the prefix. The expiry time, as a UNIX timestamp, will be the suffix. </p>
|
||||
syntax:
|
||||
content: public static final String RAW_SIGNATURE_FORMAT= "%s\n%s"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper.SIGNATURE_CHARSET()
|
||||
id: SIGNATURE_CHARSET()
|
||||
parent: com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: SIGNATURE_CHARSET
|
||||
fullName: final Charset com.microsoft.azure.iothub.auth.SignatureHelper.SIGNATURE_CHARSET
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
summary: <p>The charset used for the raw and hashed signature. </p>
|
||||
syntax:
|
||||
content: public static final Charset SIGNATURE_CHARSET= StandardCharsets.UTF_8
|
||||
return:
|
||||
type: d07b5f81
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper.SignatureHelper()
|
||||
id: SignatureHelper()
|
||||
parent: com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
langs:
|
||||
- java
|
||||
name: SignatureHelper()
|
||||
fullName: com.microsoft.azure.iothub.auth.SignatureHelper.SignatureHelper()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/SignatureHelper.java
|
||||
startLine: 149
|
||||
package: com.microsoft.azure.iothub.auth
|
||||
syntax:
|
||||
content: protected SignatureHelper()
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: d07b5f81
|
||||
spec.java:
|
||||
- name: final Charset
|
||||
fullName: final Charset
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 0364520f
|
||||
spec.java:
|
||||
- name: long
|
||||
fullName: long
|
||||
- uid: ccd9418d
|
||||
spec.java:
|
||||
- name: byte []
|
||||
fullName: byte []
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.auth
|
||||
id: auth
|
||||
children:
|
||||
- com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
- com.microsoft.azure.iothub.auth._signature
|
||||
- com.microsoft.azure.iothub.auth._signature_helper
|
||||
href: com.microsoft.azure.iothub.auth.yml
|
||||
langs:
|
||||
- java
|
||||
name: com.microsoft.azure.iothub.auth
|
||||
fullName: com.microsoft.azure.iothub.auth
|
||||
type: Namespace
|
||||
source:
|
||||
remote:
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/auth/IotHubSasToken.java
|
||||
startLine: 3
|
||||
summary: <p>Authenticates a device to an IoT Hub via SAS tokens. </p>
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iothub.auth
|
||||
references:
|
||||
- uid: com.microsoft.azure.iothub.auth._iot_hub_sas_token
|
||||
parent: com.microsoft.azure.iothub.auth
|
||||
href: com.microsoft.azure.iothub.auth._iot_hub_sas_token.yml
|
||||
name: IotHubSasToken
|
||||
fullName: com.microsoft.azure.iothub.auth.IotHubSasToken
|
||||
type: Class
|
||||
summary: <p>Grants device access to an IoT Hub for the specified amount of time. </p>
|
||||
syntax:
|
||||
content: public class IotHubSasToken
|
||||
- uid: com.microsoft.azure.iothub.auth._signature
|
||||
parent: com.microsoft.azure.iothub.auth
|
||||
href: com.microsoft.azure.iothub.auth._signature.yml
|
||||
name: Signature
|
||||
fullName: com.microsoft.azure.iothub.auth.Signature
|
||||
type: Class
|
||||
summary: <p>A signature that is used in the SAS token to authenticate the client. </p>
|
||||
syntax:
|
||||
content: public class Signature
|
||||
- uid: com.microsoft.azure.iothub.auth._signature_helper
|
||||
parent: com.microsoft.azure.iothub.auth
|
||||
href: com.microsoft.azure.iothub.auth._signature_helper.yml
|
||||
name: SignatureHelper
|
||||
fullName: com.microsoft.azure.iothub.auth.SignatureHelper
|
||||
type: Class
|
||||
summary: <p>Builds the authorization signature as a composition of functions. </p>
|
||||
syntax:
|
||||
content: public class SignatureHelper
|
||||
|
|
@ -0,0 +1,212 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
id: _iot_hub_abandon_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
children:
|
||||
- com.microsoft.azure.iothub.net._iot_hub_abandon_uri.ABANDON_PATH_FORMAT()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_abandon_uri.getHostname()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_abandon_uri.getPath()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_abandon_uri.IotHubAbandonUri()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_abandon_uri.IotHubAbandonUri(String,String,String)
|
||||
- com.microsoft.azure.iothub.net._iot_hub_abandon_uri.toString()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_abandon_uri.uri()
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubAbandonUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubAbandonUri
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>A URI for a device to instruct an IoT Hub to mark a message as being abandoned. </p>
|
||||
syntax:
|
||||
content: public class IotHubAbandonUri
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.ABANDON_PATH_FORMAT()
|
||||
id: ABANDON_PATH_FORMAT()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: ABANDON_PATH_FORMAT
|
||||
fullName: final String com.microsoft.azure.iothub.net.IotHubAbandonUri.ABANDON_PATH_FORMAT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The path to be appended to an IoT Hub URI. The s will be replaced by the message etag. </p>
|
||||
syntax:
|
||||
content: >-
|
||||
public static final String ABANDON_PATH_FORMAT=
|
||||
"/messages/devicebound/%s/abandon"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.getHostname()
|
||||
id: getHostname()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getHostname()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubAbandonUri.getHostname()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
startLine: 53
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub hostname.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getHostname()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub hostname. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.getPath()
|
||||
id: getPath()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPath()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubAbandonUri.getPath()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
startLine: 64
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub path.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getPath()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub path. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.IotHubAbandonUri()
|
||||
id: IotHubAbandonUri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubAbandonUri()
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubAbandonUri.IotHubAbandonUri()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
startLine: 70
|
||||
package: com.microsoft.azure.iothub.net
|
||||
syntax:
|
||||
content: protected IotHubAbandonUri()
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.IotHubAbandonUri(String,String,String)
|
||||
id: IotHubAbandonUri(String,String,String)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubAbandonUri(String iotHubHostname, String deviceId, String eTag)
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubAbandonUri.IotHubAbandonUri(String iotHubHostname, String deviceId, String eTag)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
startLine: 29
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Constructor. Returns a URI for a device to instruct an IoT Hub to mark a message as being abandoned. The URI does not include a protocol.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubAbandonUri(String iotHubHostname, String deviceId, String eTag)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub name. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- id: eTag
|
||||
type: "26831127"
|
||||
description: <p>the message e-tag. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubAbandonUri.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
startLine: 42
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub abandon message URI.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub abandon mesasge URI. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.uri()
|
||||
id: uri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: uri
|
||||
fullName: final IotHubUri com.microsoft.azure.iothub.net.IotHubAbandonUri.uri
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
startLine: 19
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The underlying IoT Hub URI. </p>
|
||||
syntax:
|
||||
content: protected final IotHubUri uri
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to connect to an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubUri
|
||||
|
|
@ -0,0 +1,212 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
id: _iot_hub_complete_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
children:
|
||||
- com.microsoft.azure.iothub.net._iot_hub_complete_uri.COMPLETE_PATH_FORMAT()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_complete_uri.getHostname()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_complete_uri.getPath()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_complete_uri.IotHubCompleteUri()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_complete_uri.IotHubCompleteUri(String,String,String)
|
||||
- com.microsoft.azure.iothub.net._iot_hub_complete_uri.toString()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_complete_uri.uri()
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_complete_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubCompleteUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubCompleteUri
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubCompleteUri.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubCompleteUri.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>A URI for a device to instruct an IoT Hub to mark a message as being completed. </p>
|
||||
syntax:
|
||||
content: public class IotHubCompleteUri
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_complete_uri.COMPLETE_PATH_FORMAT()
|
||||
id: COMPLETE_PATH_FORMAT()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_complete_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: COMPLETE_PATH_FORMAT
|
||||
fullName: final String com.microsoft.azure.iothub.net.IotHubCompleteUri.COMPLETE_PATH_FORMAT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubCompleteUri.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The path to be appended to an IoT Hub URI. The s will be replaced by the message etag. </p>
|
||||
syntax:
|
||||
content: >-
|
||||
public static final String COMPLETE_PATH_FORMAT=
|
||||
"/messages/devicebound/%s"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_complete_uri.getHostname()
|
||||
id: getHostname()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_complete_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getHostname()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubCompleteUri.getHostname()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubCompleteUri.java
|
||||
startLine: 53
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub hostname.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getHostname()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub hostname. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_complete_uri.getPath()
|
||||
id: getPath()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_complete_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPath()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubCompleteUri.getPath()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubCompleteUri.java
|
||||
startLine: 64
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub path.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getPath()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub path. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_complete_uri.IotHubCompleteUri()
|
||||
id: IotHubCompleteUri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_complete_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubCompleteUri()
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubCompleteUri.IotHubCompleteUri()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubCompleteUri.java
|
||||
startLine: 70
|
||||
package: com.microsoft.azure.iothub.net
|
||||
syntax:
|
||||
content: protected IotHubCompleteUri()
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_complete_uri.IotHubCompleteUri(String,String,String)
|
||||
id: IotHubCompleteUri(String,String,String)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_complete_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubCompleteUri(String iotHubHostname, String deviceId, String eTag)
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubCompleteUri.IotHubCompleteUri(String iotHubHostname, String deviceId, String eTag)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubCompleteUri.java
|
||||
startLine: 29
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Constructor. Returns a URI for a device to instruct an IoT Hub to mark a message as being completed. The URI does not include a protocol.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubCompleteUri(String iotHubHostname, String deviceId, String eTag)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub name. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- id: eTag
|
||||
type: "26831127"
|
||||
description: <p>the message e-tag. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_complete_uri.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_complete_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubCompleteUri.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubCompleteUri.java
|
||||
startLine: 42
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub complete message URI.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub complete message URI. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_complete_uri.uri()
|
||||
id: uri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_complete_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: uri
|
||||
fullName: final IotHubUri com.microsoft.azure.iothub.net.IotHubCompleteUri.uri
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubCompleteUri.java
|
||||
startLine: 19
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The underlying IoT Hub URI. </p>
|
||||
syntax:
|
||||
content: protected final IotHubUri uri
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to connect to an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubUri
|
||||
|
|
@ -0,0 +1,207 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
id: _iot_hub_event_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
children:
|
||||
- com.microsoft.azure.iothub.net._iot_hub_event_uri.EVENT_PATH()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_event_uri.getHostname()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_event_uri.getPath()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_event_uri.IotHubEventUri()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_event_uri.IotHubEventUri(String,String)
|
||||
- com.microsoft.azure.iothub.net._iot_hub_event_uri.toString()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_event_uri.uri()
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_event_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubEventUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubEventUri
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubEventUri.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubEventUri.java
|
||||
startLine: 6
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>A URI for a device to send event to an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubEventUri
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_event_uri.EVENT_PATH()
|
||||
id: EVENT_PATH()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_event_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: EVENT_PATH
|
||||
fullName: final String com.microsoft.azure.iothub.net.IotHubEventUri.EVENT_PATH
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubEventUri.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The path to be appended to an IoT Hub URI. </p>
|
||||
syntax:
|
||||
content: public static final String EVENT_PATH= "/messages/events"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_event_uri.getHostname()
|
||||
id: getHostname()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_event_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getHostname()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubEventUri.getHostname()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubEventUri.java
|
||||
startLine: 44
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub hostname.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getHostname()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub hostname. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_event_uri.getPath()
|
||||
id: getPath()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_event_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPath()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubEventUri.getPath()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubEventUri.java
|
||||
startLine: 55
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub path.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getPath()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub path. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_event_uri.IotHubEventUri()
|
||||
id: IotHubEventUri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_event_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubEventUri()
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubEventUri.IotHubEventUri()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubEventUri.java
|
||||
startLine: 61
|
||||
package: com.microsoft.azure.iothub.net
|
||||
syntax:
|
||||
content: protected IotHubEventUri()
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_event_uri.IotHubEventUri(String,String)
|
||||
id: IotHubEventUri(String,String)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_event_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubEventUri(String iotHubHostname, String deviceId)
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubEventUri.IotHubEventUri(String iotHubHostname, String deviceId)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubEventUri.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Constructor. Returns a URI for a device to send event to an IoT Hub. The URI does not include a protocol.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubEventUri(String iotHubHostname, String deviceId)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub name. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_event_uri.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_event_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubEventUri.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubEventUri.java
|
||||
startLine: 33
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub event URI.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub event URI. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_event_uri.uri()
|
||||
id: uri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_event_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: uri
|
||||
fullName: final IotHubUri com.microsoft.azure.iothub.net.IotHubEventUri.uri
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubEventUri.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The underlying IoT Hub URI. </p>
|
||||
syntax:
|
||||
content: protected final IotHubUri uri
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to connect to an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubUri
|
||||
|
|
@ -0,0 +1,207 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
id: _iot_hub_message_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
children:
|
||||
- com.microsoft.azure.iothub.net._iot_hub_message_uri.getHostname()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_message_uri.getPath()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_message_uri.IotHubMessageUri()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_message_uri.IotHubMessageUri(String,String)
|
||||
- com.microsoft.azure.iothub.net._iot_hub_message_uri.MESSAGE_PATH()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_message_uri.toString()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_message_uri.uri()
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_message_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubMessageUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubMessageUri
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubMessageUri.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubMessageUri.java
|
||||
startLine: 6
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>A URI for a device to poll for messages from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubMessageUri
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_message_uri.getHostname()
|
||||
id: getHostname()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_message_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getHostname()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubMessageUri.getHostname()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubMessageUri.java
|
||||
startLine: 44
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub hostname.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getHostname()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub hostname. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_message_uri.getPath()
|
||||
id: getPath()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_message_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPath()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubMessageUri.getPath()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubMessageUri.java
|
||||
startLine: 55
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub path.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getPath()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub path. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_message_uri.IotHubMessageUri()
|
||||
id: IotHubMessageUri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_message_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubMessageUri()
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubMessageUri.IotHubMessageUri()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubMessageUri.java
|
||||
startLine: 61
|
||||
package: com.microsoft.azure.iothub.net
|
||||
syntax:
|
||||
content: protected IotHubMessageUri()
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_message_uri.IotHubMessageUri(String,String)
|
||||
id: IotHubMessageUri(String,String)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_message_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubMessageUri(String iotHubHostname, String deviceId)
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubMessageUri.IotHubMessageUri(String iotHubHostname, String deviceId)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubMessageUri.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Constructor. Returns a URI for a device to poll for messages from an IoT Hub. The URI does not include a protocol.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubMessageUri(String iotHubHostname, String deviceId)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub name. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_message_uri.MESSAGE_PATH()
|
||||
id: MESSAGE_PATH()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_message_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: MESSAGE_PATH
|
||||
fullName: final String com.microsoft.azure.iothub.net.IotHubMessageUri.MESSAGE_PATH
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubMessageUri.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The path to be appended to an IoT Hub URI. </p>
|
||||
syntax:
|
||||
content: public static final String MESSAGE_PATH= "/messages/devicebound"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_message_uri.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_message_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubMessageUri.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubMessageUri.java
|
||||
startLine: 33
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub message URI.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub message URI. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_message_uri.uri()
|
||||
id: uri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_message_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: uri
|
||||
fullName: final IotHubUri com.microsoft.azure.iothub.net.IotHubMessageUri.uri
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubMessageUri.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The underlying IoT Hub URI. </p>
|
||||
syntax:
|
||||
content: protected final IotHubUri uri
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to connect to an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubUri
|
||||
|
|
@ -0,0 +1,237 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
id: _iot_hub_reject_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
children:
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri.getHostname()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri.getPath()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri.IotHubRejectUri()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri.IotHubRejectUri(String,String,String)
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri.REJECT_PATH_FORMAT()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri.REJECT_QUERY_PARAM()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri.toString()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri.uri()
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubRejectUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubRejectUri
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>A URI for a device to instruct an IoT Hub to mark a message as being rejected. </p>
|
||||
syntax:
|
||||
content: public class IotHubRejectUri
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri.[static initializer]()
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri.getHostname()
|
||||
id: getHostname()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getHostname()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubRejectUri.getHostname()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
startLine: 69
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub hostname.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getHostname()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub hostname. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri.getPath()
|
||||
id: getPath()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPath()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubRejectUri.getPath()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
startLine: 80
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub path.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getPath()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub path. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri.IotHubRejectUri()
|
||||
id: IotHubRejectUri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubRejectUri()
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubRejectUri.IotHubRejectUri()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
startLine: 86
|
||||
package: com.microsoft.azure.iothub.net
|
||||
syntax:
|
||||
content: protected IotHubRejectUri()
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri.IotHubRejectUri(String,String,String)
|
||||
id: IotHubRejectUri(String,String,String)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubRejectUri(String iotHubHostname, String deviceId, String eTag)
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubRejectUri.IotHubRejectUri(String iotHubHostname, String deviceId, String eTag)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
startLine: 43
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Constructor. Returns a URI for a device to instruct an IoT Hub to mark a message as being rejected. The URI does not include a protocol.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubRejectUri(String iotHubHostname, String deviceId, String eTag)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub name. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- id: eTag
|
||||
type: "26831127"
|
||||
description: <p>the message e-tag. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri.REJECT_PATH_FORMAT()
|
||||
id: REJECT_PATH_FORMAT()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: REJECT_PATH_FORMAT
|
||||
fullName: final String com.microsoft.azure.iothub.net.IotHubRejectUri.REJECT_PATH_FORMAT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
startLine: 19
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The path to be appended to an IoT Hub URI. The s will be replaced by the message etag. </p>
|
||||
syntax:
|
||||
content: public static final String REJECT_PATH_FORMAT= "/messages/devicebound/%s"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri.REJECT_QUERY_PARAM()
|
||||
id: REJECT_QUERY_PARAM()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: REJECT_QUERY_PARAM
|
||||
fullName: final Map<String, String> com.microsoft.azure.iothub.net.IotHubRejectUri.REJECT_QUERY_PARAM
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
startLine: 24
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The reject URI query parameter. </p>
|
||||
syntax:
|
||||
content: public static final Map<String, String> REJECT_QUERY_PARAM
|
||||
return:
|
||||
type: 15b3ef59
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubRejectUri.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
startLine: 58
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub reject message URI.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub reject mesage URI. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri.uri()
|
||||
id: uri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: uri
|
||||
fullName: final IotHubUri com.microsoft.azure.iothub.net.IotHubRejectUri.uri
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubRejectUri.java
|
||||
startLine: 33
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The underlying IoT Hub URI. </p>
|
||||
syntax:
|
||||
content: protected final IotHubUri uri
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: 15b3ef59
|
||||
spec.java:
|
||||
- name: final Map<String, String>
|
||||
fullName: final Map<String, String>
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri.[static initializer]()
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to connect to an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubUri
|
||||
|
|
@ -0,0 +1,409 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
id: _iot_hub_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
children:
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.API_VERSION()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.appendQueryParam(StringBuilder,String,String)
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.getHostname()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.getPath()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.getResourceUri(String,String)
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.hostname()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.IOTHUB_URL_ENCODING_CHARSET()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.IotHubUri()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.IotHubUri(String,String,String)
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.IotHubUri(String,String,String,Map<String, String>)
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.path()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.PATH_FORMAT()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.toString()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.uri()
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri.urlEncodePath(String)
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>A URI for a device to connect to an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubUri
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.API_VERSION()
|
||||
id: API_VERSION()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: API_VERSION
|
||||
fullName: final String com.microsoft.azure.iothub.net.IotHubUri.API_VERSION
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 24
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The API version will be passed as a param in the URI. </p>
|
||||
syntax:
|
||||
content: public static final String API_VERSION= "api-version=2016-02-03"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.appendQueryParam(StringBuilder,String,String)
|
||||
id: appendQueryParam(StringBuilder,String,String)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: appendQueryParam(StringBuilder uriBuilder, String name, String value)
|
||||
fullName: static void com.microsoft.azure.iothub.net.IotHubUri.appendQueryParam(StringBuilder uriBuilder, String name, String value)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 195
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>URL-encodes the query param<programlisting><codeline><highlight class="normal">name<sp></sp></highlight></codeline></programlisting> and<programlisting><codeline><highlight class="normal">value<sp></sp></highlight></codeline></programlisting> using charset UTF-8 and appends them to the URI.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static void appendQueryParam(StringBuilder uriBuilder, String name, String value)
|
||||
parameters:
|
||||
- id: uriBuilder
|
||||
type: 2483a40b
|
||||
description: <p>the URI. </p>
|
||||
- id: name
|
||||
type: "26831127"
|
||||
description: <p>the query param name. </p>
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>the query param value. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.getHostname()
|
||||
id: getHostname()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getHostname()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubUri.getHostname()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 118
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub hostname.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getHostname()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub hostname. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.getPath()
|
||||
id: getPath()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getPath()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubUri.getPath()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 129
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub path.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getPath()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub path. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.getResourceUri(String,String)
|
||||
id: getResourceUri(String,String)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: getResourceUri(String iotHubHostname, String deviceId)
|
||||
fullName: static String com.microsoft.azure.iothub.net.IotHubUri.getResourceUri(String iotHubHostname, String deviceId)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 146
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub resource URI. The IoT Hub resource URI is the hostname and path component that is common to all IoT Hub communication methods between the given device and IoT Hub. Safely escapes the IoT Hub resource URI.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static String getResourceUri(String iotHubHostname, String deviceId)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub hostname. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID.</p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub resource URI. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.hostname()
|
||||
id: hostname()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: hostname
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubUri.hostname
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The IoT Hub resource URI is the hostname and path component that is common to all IoT Hub communication methods between the given device and IoT Hub. </p>
|
||||
syntax:
|
||||
content: protected String hostname
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.IOTHUB_URL_ENCODING_CHARSET()
|
||||
id: IOTHUB_URL_ENCODING_CHARSET()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IOTHUB_URL_ENCODING_CHARSET
|
||||
fullName: final Charset com.microsoft.azure.iothub.net.IotHubUri.IOTHUB_URL_ENCODING_CHARSET
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 27
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The charset used when URL-encoding the IoT Hub name and device ID. </p>
|
||||
syntax:
|
||||
content: >-
|
||||
public static final Charset IOTHUB_URL_ENCODING_CHARSET=
|
||||
StandardCharsets.UTF_8
|
||||
return:
|
||||
type: d07b5f81
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.IotHubUri()
|
||||
id: IotHubUri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubUri()
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri.IotHubUri()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 215
|
||||
package: com.microsoft.azure.iothub.net
|
||||
syntax:
|
||||
content: protected IotHubUri()
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.IotHubUri(String,String,String)
|
||||
id: IotHubUri(String,String,String)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath)
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri.IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 92
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Constructor. Equivalent to<programlisting><codeline><highlight class="normal"><sp></sp>new<sp></sp>IotHubUri(iotHubHostname,<sp></sp>deviceId,</highlight></codeline><codeline><highlight class="normal">iotHubMethodPath,<sp></sp>null)<sp></sp></highlight></codeline></programlisting> .</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub hostname. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- id: iotHubMethodPath
|
||||
type: "26831127"
|
||||
description: <p>the path from the IoT Hub resource to the method. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.IotHubUri(String,String,String,Map<String, String>)
|
||||
id: IotHubUri(String,String,String,Map<String, String>)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, Map<String, String> queryParams)
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri.IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, Map<String, String> queryParams)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 49
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Constructor. Creates a URI to an IoT Hub method. The URI does not include a protocol. The function will safely escape the given arguments.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubUri(String iotHubHostname, String deviceId, String iotHubMethodPath, Map<String, String> queryParams)
|
||||
parameters:
|
||||
- id: iotHubHostname
|
||||
type: "26831127"
|
||||
description: <p>the IoT Hub hostname. </p>
|
||||
- id: deviceId
|
||||
type: "26831127"
|
||||
description: <p>the device ID. </p>
|
||||
- id: iotHubMethodPath
|
||||
type: "26831127"
|
||||
description: <p>the path from the IoT Hub resource to the method. </p>
|
||||
- id: queryParams
|
||||
type: 689c8cb5
|
||||
description: <p>the URL query parameters. Can be null. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.path()
|
||||
id: path()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: path
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubUri.path
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 36
|
||||
package: com.microsoft.azure.iothub.net
|
||||
syntax:
|
||||
content: protected String path
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.PATH_FORMAT()
|
||||
id: PATH_FORMAT()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: PATH_FORMAT
|
||||
fullName: final String com.microsoft.azure.iothub.net.IotHubUri.PATH_FORMAT
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: <p>The device ID and specific IoT Hub method path will be interpolated into the path. </p>
|
||||
syntax:
|
||||
content: public static final String PATH_FORMAT= "/devices/%s%s"
|
||||
return:
|
||||
type: 3d93591e
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.toString()
|
||||
id: toString()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: toString()
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubUri.toString()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 107
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>Returns the string representation of the IoT Hub URI.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String toString()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the string representation of the IoT Hub URI. </p>
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.uri()
|
||||
id: uri()
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: uri
|
||||
fullName: String com.microsoft.azure.iothub.net.IotHubUri.uri
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 37
|
||||
package: com.microsoft.azure.iothub.net
|
||||
syntax:
|
||||
content: protected String uri
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri.urlEncodePath(String)
|
||||
id: urlEncodePath(String)
|
||||
parent: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
langs:
|
||||
- java
|
||||
name: urlEncodePath(String path)
|
||||
fullName: static String com.microsoft.azure.iothub.net.IotHubUri.urlEncodePath(String path)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubUri.java
|
||||
startLine: 161
|
||||
package: com.microsoft.azure.iothub.net
|
||||
summary: >-
|
||||
<p>URL-encodes each subdirectory in the path.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static String urlEncodePath(String path)
|
||||
parameters:
|
||||
- id: path
|
||||
type: "26831127"
|
||||
description: <p>the path to be safely escaped.</p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>a path with each subdirectory URL-encoded. </p>
|
||||
references:
|
||||
- uid: 3d93591e
|
||||
spec.java:
|
||||
- name: final String
|
||||
fullName: final String
|
||||
- uid: d07b5f81
|
||||
spec.java:
|
||||
- name: final Charset
|
||||
fullName: final Charset
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 689c8cb5
|
||||
spec.java:
|
||||
- name: Map<String, String>
|
||||
fullName: Map<String, String>
|
||||
- uid: 2483a40b
|
||||
spec.java:
|
||||
- name: StringBuilder
|
||||
fullName: StringBuilder
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.net
|
||||
id: net
|
||||
children:
|
||||
- com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
- com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
- com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
- com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
- com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
- com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
href: com.microsoft.azure.iothub.net.yml
|
||||
langs:
|
||||
- java
|
||||
name: com.microsoft.azure.iothub.net
|
||||
fullName: com.microsoft.azure.iothub.net
|
||||
type: Namespace
|
||||
source:
|
||||
remote:
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/net/IotHubAbandonUri.java
|
||||
startLine: 3
|
||||
summary: <p>IoT Hub resource URIs. </p>
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iothub.net
|
||||
references:
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_abandon_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_abandon_uri.yml
|
||||
name: IotHubAbandonUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubAbandonUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to instruct an IoT Hub to mark a message as being abandoned. </p>
|
||||
syntax:
|
||||
content: public class IotHubAbandonUri
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_complete_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_complete_uri.yml
|
||||
name: IotHubCompleteUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubCompleteUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to instruct an IoT Hub to mark a message as being completed. </p>
|
||||
syntax:
|
||||
content: public class IotHubCompleteUri
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_event_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_event_uri.yml
|
||||
name: IotHubEventUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubEventUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to send event to an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubEventUri
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_message_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_message_uri.yml
|
||||
name: IotHubMessageUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubMessageUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to poll for messages from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubMessageUri
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_reject_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_reject_uri.yml
|
||||
name: IotHubRejectUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubRejectUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to instruct an IoT Hub to mark a message as being rejected. </p>
|
||||
syntax:
|
||||
content: public class IotHubRejectUri
|
||||
- uid: com.microsoft.azure.iothub.net._iot_hub_uri
|
||||
parent: com.microsoft.azure.iothub.net
|
||||
href: com.microsoft.azure.iothub.net._iot_hub_uri.yml
|
||||
name: IotHubUri
|
||||
fullName: com.microsoft.azure.iothub.net.IotHubUri
|
||||
type: Class
|
||||
summary: <p>A URI for a device to connect to an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public class IotHubUri
|
||||
|
|
@ -0,0 +1,230 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_callback_packet
|
||||
id: _iot_hub_callback_packet
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_callback_packet.callback()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_callback_packet.callbackContext()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_callback_packet.getCallback()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_callback_packet.getContext()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_callback_packet.getStatus()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_callback_packet.IotHubCallbackPacket(IotHubStatusCode,IotHubEventCallback,Object)
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_callback_packet.status()
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubCallbackPacket
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubCallbackPacket
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubCallbackPacket.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubCallbackPacket.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: <p>A packet containing the data needed for an IoT Hub transport to invoke a callback. </p>
|
||||
syntax:
|
||||
content: public class IotHubCallbackPacket
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.callback()
|
||||
id: callback()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_callback_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: callback
|
||||
fullName: final IotHubEventCallback com.microsoft.azure.iothub.transport.IotHubCallbackPacket.callback
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubCallbackPacket.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: protected final IotHubEventCallback callback
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.callbackContext()
|
||||
id: callbackContext()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_callback_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: callbackContext
|
||||
fullName: final Object com.microsoft.azure.iothub.transport.IotHubCallbackPacket.callbackContext
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubCallbackPacket.java
|
||||
startLine: 16
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: protected final Object callbackContext
|
||||
return:
|
||||
type: 1b60ba29
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.getCallback()
|
||||
id: getCallback()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_callback_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: getCallback()
|
||||
fullName: IotHubEventCallback com.microsoft.azure.iothub.transport.IotHubCallbackPacket.getCallback()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubCallbackPacket.java
|
||||
startLine: 51
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Getter for the callback to be invoked for the completed request.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubEventCallback getCallback()
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback function. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.getContext()
|
||||
id: getContext()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_callback_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: getContext()
|
||||
fullName: Object com.microsoft.azure.iothub.transport.IotHubCallbackPacket.getContext()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubCallbackPacket.java
|
||||
startLine: 63
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Getter for the context to be passed in to the callback when it is invoked.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public Object getContext()
|
||||
return:
|
||||
type: "79317049"
|
||||
description: <p>the callback context. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.getStatus()
|
||||
id: getStatus()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_callback_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: getStatus()
|
||||
fullName: IotHubStatusCode com.microsoft.azure.iothub.transport.IotHubCallbackPacket.getStatus()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubCallbackPacket.java
|
||||
startLine: 40
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Getter for the response status code.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubStatusCode getStatus()
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
description: <p>the response status code. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.IotHubCallbackPacket(IotHubStatusCode,IotHubEventCallback,Object)
|
||||
id: IotHubCallbackPacket(IotHubStatusCode,IotHubEventCallback,Object)
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_callback_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubCallbackPacket(IotHubStatusCode status, IotHubEventCallback callback, Object callbackContext)
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubCallbackPacket.IotHubCallbackPacket(IotHubStatusCode status, IotHubEventCallback callback, Object callbackContext)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubCallbackPacket.java
|
||||
startLine: 25
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Constructor.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubCallbackPacket(IotHubStatusCode status, IotHubEventCallback callback, Object callbackContext)
|
||||
parameters:
|
||||
- id: status
|
||||
type: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
description: <p>the response status code. </p>
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback to be invoked for the completed request. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed in to the callback. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.status()
|
||||
id: status()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_callback_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: status
|
||||
fullName: final IotHubStatusCode com.microsoft.azure.iothub.transport.IotHubCallbackPacket.status
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubCallbackPacket.java
|
||||
startLine: 14
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: protected final IotHubStatusCode status
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub._iot_hub_status_code
|
||||
references:
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub._iot_hub_status_code
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
name: IotHubStatusCode
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
name: IotHubEventCallback
|
||||
fullName: com.microsoft.azure.iothub.IotHubEventCallback
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
- uid: 1b60ba29
|
||||
spec.java:
|
||||
- name: final Object
|
||||
fullName: final Object
|
||||
- uid: "79317049"
|
||||
spec.java:
|
||||
- name: Object
|
||||
fullName: Object
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
name: IotHubStatusCode
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode
|
||||
type: Enum
|
||||
summary: <p>An IoT Hub status code. Included in a message from an IoT Hub to a device. </p>
|
||||
syntax:
|
||||
content: public enum IotHubStatusCode
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
name: IotHubEventCallback
|
||||
fullName: com.microsoft.azure.iothub.IotHubEventCallback
|
||||
type: Interface
|
||||
summary: >-
|
||||
<p>An interface for an IoT Hub event callback.</p>
|
||||
|
||||
<p>Developers are expected to create an implementation of this interface, and the transport will call <xref href="com.microsoft.azure.iothub._iot_hub_event_callback.execute(IotHubStatusCode,Object)" data-throw-if-not-resolved="false"></xref> upon receiving a response from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public interface IotHubEventCallback
|
||||
|
|
@ -0,0 +1,229 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet
|
||||
id: _iot_hub_outbound_packet
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.callback()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.callbackContext()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.getCallback()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.getContext()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.getMessage()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.IotHubOutboundPacket(Message,IotHubEventCallback,Object)
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.message()
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubOutboundPacket
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubOutboundPacket
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubOutboundPacket.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubOutboundPacket.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: <p>A packet containing the data needed for an IoT Hub transport to send a message. </p>
|
||||
syntax:
|
||||
content: public class IotHubOutboundPacket
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.callback()
|
||||
id: callback()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: callback
|
||||
fullName: final IotHubEventCallback com.microsoft.azure.iothub.transport.IotHubOutboundPacket.callback
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubOutboundPacket.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: protected final IotHubEventCallback callback
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.callbackContext()
|
||||
id: callbackContext()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: callbackContext
|
||||
fullName: final Object com.microsoft.azure.iothub.transport.IotHubOutboundPacket.callbackContext
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubOutboundPacket.java
|
||||
startLine: 16
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: protected final Object callbackContext
|
||||
return:
|
||||
type: 1b60ba29
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.getCallback()
|
||||
id: getCallback()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: getCallback()
|
||||
fullName: IotHubEventCallback com.microsoft.azure.iothub.transport.IotHubOutboundPacket.getCallback()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubOutboundPacket.java
|
||||
startLine: 52
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Getter for the callback to be invoked when a response is received.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubEventCallback getCallback()
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback function. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.getContext()
|
||||
id: getContext()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: getContext()
|
||||
fullName: Object com.microsoft.azure.iothub.transport.IotHubOutboundPacket.getContext()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubOutboundPacket.java
|
||||
startLine: 63
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Getter for the context to be passed to the callback when it is invoked.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public Object getContext()
|
||||
return:
|
||||
type: "79317049"
|
||||
description: <p>the callback context. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.getMessage()
|
||||
id: getMessage()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: getMessage()
|
||||
fullName: Message com.microsoft.azure.iothub.transport.IotHubOutboundPacket.getMessage()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubOutboundPacket.java
|
||||
startLine: 41
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Getter for the message to be sent.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public Message getMessage()
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message to be sent. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.IotHubOutboundPacket(Message,IotHubEventCallback,Object)
|
||||
id: IotHubOutboundPacket(Message,IotHubEventCallback,Object)
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubOutboundPacket(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubOutboundPacket.IotHubOutboundPacket(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubOutboundPacket.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Constructor.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubOutboundPacket(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message to be sent. </p>
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback to be invoked when a response from the IoT Hub is received. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed to the callback. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.message()
|
||||
id: message()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.yml
|
||||
langs:
|
||||
- java
|
||||
name: message
|
||||
fullName: final Message com.microsoft.azure.iothub.transport.IotHubOutboundPacket.message
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubOutboundPacket.java
|
||||
startLine: 14
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: protected final Message message
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub._message
|
||||
references:
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub._message
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
name: IotHubEventCallback
|
||||
fullName: com.microsoft.azure.iothub.IotHubEventCallback
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
- uid: 1b60ba29
|
||||
spec.java:
|
||||
- name: final Object
|
||||
fullName: final Object
|
||||
- uid: "79317049"
|
||||
spec.java:
|
||||
- name: Object
|
||||
fullName: Object
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
name: IotHubEventCallback
|
||||
fullName: com.microsoft.azure.iothub.IotHubEventCallback
|
||||
type: Interface
|
||||
summary: >-
|
||||
<p>An interface for an IoT Hub event callback.</p>
|
||||
|
||||
<p>Developers are expected to create an implementation of this interface, and the transport will call <xref href="com.microsoft.azure.iothub._iot_hub_event_callback.execute(IotHubStatusCode,Object)" data-throw-if-not-resolved="false"></xref> upon receiving a response from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public interface IotHubEventCallback
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_receive_task
|
||||
id: _iot_hub_receive_task
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_receive_task.IotHubReceiveTask(IotHubTransport)
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_receive_task.run()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_receive_task.transport()
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_receive_task.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubReceiveTask
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubReceiveTask
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubReceiveTask.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubReceiveTask.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: <p>Polls an IoT Hub for messages and invokes a callback if one is found. Meant to be used with an executor that continuously calls run(). </p>
|
||||
syntax:
|
||||
content: public class IotHubReceiveTask
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Runnable
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_receive_task.IotHubReceiveTask(IotHubTransport)
|
||||
id: IotHubReceiveTask(IotHubTransport)
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_receive_task
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_receive_task.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubReceiveTask(IotHubTransport transport)
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubReceiveTask.IotHubReceiveTask(IotHubTransport transport)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubReceiveTask.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public IotHubReceiveTask(IotHubTransport transport)
|
||||
parameters:
|
||||
- id: transport
|
||||
type: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_receive_task.run()
|
||||
id: run()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_receive_task
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_receive_task.yml
|
||||
langs:
|
||||
- java
|
||||
name: run()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubReceiveTask.run()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubReceiveTask.java
|
||||
startLine: 19
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public void run()
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_receive_task.transport()
|
||||
id: transport()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_receive_task
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_receive_task.yml
|
||||
langs:
|
||||
- java
|
||||
name: transport
|
||||
fullName: final IotHubTransport com.microsoft.azure.iothub.transport.IotHubReceiveTask.transport
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubReceiveTask.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: protected final IotHubTransport transport
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
references:
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
name: IotHubTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubTransport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: IotHubTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubTransport
|
||||
type: Interface
|
||||
summary: <p>An interface for an IoT Hub transport. </p>
|
||||
syntax:
|
||||
content: public interface IotHubTransport
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_send_task
|
||||
id: _iot_hub_send_task
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_send_task.IotHubSendTask(IotHubTransport)
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_send_task.run()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_send_task.transport()
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_send_task.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubSendTask
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubSendTask
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubSendTask.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubSendTask.java
|
||||
startLine: 9
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: <p>Sends batched messages and invokes callbacks on completed requests. Meant to be used with an executor that continuously calls run(). </p>
|
||||
syntax:
|
||||
content: public class IotHubSendTask
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Runnable
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_send_task.IotHubSendTask(IotHubTransport)
|
||||
id: IotHubSendTask(IotHubTransport)
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_send_task
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_send_task.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubSendTask(IotHubTransport transport)
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubSendTask.IotHubSendTask(IotHubTransport transport)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubSendTask.java
|
||||
startLine: 13
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public IotHubSendTask(IotHubTransport transport)
|
||||
parameters:
|
||||
- id: transport
|
||||
type: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_send_task.run()
|
||||
id: run()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_send_task
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_send_task.yml
|
||||
langs:
|
||||
- java
|
||||
name: run()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubSendTask.run()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubSendTask.java
|
||||
startLine: 19
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public void run()
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_send_task.transport()
|
||||
id: transport()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_send_task
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_send_task.yml
|
||||
langs:
|
||||
- java
|
||||
name: transport
|
||||
fullName: final IotHubTransport com.microsoft.azure.iothub.transport.IotHubSendTask.transport
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubSendTask.java
|
||||
startLine: 11
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: protected final IotHubTransport transport
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
references:
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
name: IotHubTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubTransport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: IotHubTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubTransport
|
||||
type: Interface
|
||||
summary: <p>An interface for an IoT Hub transport. </p>
|
||||
syntax:
|
||||
content: public interface IotHubTransport
|
||||
|
|
@ -0,0 +1,595 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
id: _iot_hub_transport
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_transport.addMessage(Message,IotHubEventCallback,Object)
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_transport.close()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_transport.handleMessage()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_transport.invokeCallbacks()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_transport.isEmpty()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_transport.open()
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_transport.sendMessages()
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubTransport
|
||||
type: Interface
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubTransport.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubTransport.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: <p>An interface for an IoT Hub transport. </p>
|
||||
syntax:
|
||||
content: public interface IotHubTransport
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.addMessage(Message,IotHubEventCallback,Object)
|
||||
id: addMessage(Message,IotHubEventCallback,Object)
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubTransport.java
|
||||
startLine: 41
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Adds a message to the transport queue.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message to be sent. </p>
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback to be invoked when a response for the message is received. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed in when the callback is invoked. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.close()
|
||||
id: close()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.close()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubTransport.java
|
||||
startLine: 30
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Closes all resources used to communicate with an IoT Hub. Once<programlisting><codeline><highlight class="normal">close()<sp></sp></highlight></codeline></programlisting> is called, the transport is no longer usable. If the transport is already closed, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void close()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if an error occurs in closing the transport. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.handleMessage()
|
||||
id: handleMessage()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: handleMessage()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.handleMessage()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubTransport.java
|
||||
startLine: 67
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Invokes the message callback if a message is found and responds to the IoT Hub on how the processed message should be handled by the IoT Hub. </p>
|
||||
|
||||
<p>If no message callback is set, the function will do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void handleMessage()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the server could not be reached. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.invokeCallbacks()
|
||||
id: invokeCallbacks()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: invokeCallbacks()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.invokeCallbacks()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubTransport.java
|
||||
startLine: 55
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: <p>Invokes the callbacks for all completed requests. </p>
|
||||
syntax:
|
||||
content: public void invokeCallbacks()
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.isEmpty()
|
||||
id: isEmpty()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: isEmpty()
|
||||
fullName: boolean com.microsoft.azure.iothub.transport.IotHubTransport.isEmpty()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubTransport.java
|
||||
startLine: 76
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Returns<programlisting><codeline><highlight class="normal">true<sp></sp></highlight></codeline></programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public boolean isEmpty()
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: >-
|
||||
<p>
|
||||
|
||||
<programlisting>
|
||||
|
||||
<codeline>
|
||||
|
||||
<highlight class="normal">true<sp></sp></highlight>
|
||||
|
||||
</codeline>
|
||||
|
||||
</programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.open()
|
||||
id: open()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.open()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubTransport.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Establishes a communication channel with an IoT Hub. If a channel is already open, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void open()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if a communication channel cannot be established. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.sendMessages()
|
||||
id: sendMessages()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: sendMessages()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.sendMessages()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/IotHubTransport.java
|
||||
startLine: 52
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Sends all messages on the transport queue. If a previous send attempt had failed, the function will attempt to resend the messages in the previous attempt.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void sendMessages()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the server could not be reached. </p>
|
||||
references:
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: "79317049"
|
||||
spec.java:
|
||||
- name: Object
|
||||
fullName: Object
|
||||
- uid: 4fc6e284
|
||||
spec.java:
|
||||
- name: boolean
|
||||
fullName: boolean
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: AmqpsTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsTransport
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>An AMQPS transport. Contains functionality for adding messages and sending messages to an IoT Hub. Buffers unsent messages until they are received by an IoT Hub. A transport is bound at construction to the following parameters: IoT Hub name, device ID and device key. </p>
|
||||
|
||||
<p>The transport also receives messages from IoT Hub and invokes a user-defined message callback if a message and callback are found. </p>
|
||||
syntax:
|
||||
content: public class AmqpsTransport implements IotHubTransport,ServerListener
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_transport
|
||||
parent: com.microsoft.azure.iothub.transport.https
|
||||
href: com.microsoft.azure.iothub.transport.https._https_transport.yml
|
||||
name: HttpsTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsTransport
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>An HTTPS transport. Contains functionality for adding messages and sending batched messages to an IoT Hub. Buffers unsent messages until they are received by an IoT Hub. A transport is bound at construction to the following parameters: IoT Hub name, device ID, device key, and message valid seconds. </p>
|
||||
|
||||
<p>The transport can also poll an IoT Hub for messages and invoke a user-defined message callback if a message and callback is found. </p>
|
||||
syntax:
|
||||
content: public class HttpsTransport implements IotHubTransport
|
||||
- uid: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport
|
||||
parent: com.microsoft.azure.iothub.transport.mqtt
|
||||
href: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.yml
|
||||
name: MqttTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.mqtt.MqttTransport
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>An MQTT transport. Contains functionality for adding messages and sending batched messages to an IoT Hub. Buffers unsent messages until they are received by an IoT Hub. A transport is bound at construction to the following parameters: IoT Hub name, device ID, device key, and message valid seconds. </p>
|
||||
|
||||
<p>The transport can also poll an IoT Hub for messages and invoke a user-defined message callback if a message and callback is found. </p>
|
||||
syntax:
|
||||
content: public class MqttTransport
|
||||
- uid: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.open()
|
||||
parent: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport
|
||||
href: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.yml
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iothub.transport.mqtt.MqttTransport.open()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Establishes a communication channel with an IoT Hub. If a channel is already open, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void open()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_transport.open()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_transport
|
||||
href: com.microsoft.azure.iothub.transport.https._https_transport.yml
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsTransport.open()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Establishes a communication channel with an IoT Hub. If a channel is already open, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void open()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.open()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: open()
|
||||
fullName: synchronized void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.open()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Establishes a communication channel with an IoT Hub. If a channel is already open, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public synchronized void open()
|
||||
return:
|
||||
type: 5c0b90ca
|
||||
- uid: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.close()
|
||||
parent: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport
|
||||
href: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.yml
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iothub.transport.mqtt.MqttTransport.close()
|
||||
type: Method
|
||||
summary: <p>Closes all resources used to communicate with an IoT Hub. Once<programlisting><codeline><highlight class="normal">close()<sp></sp></highlight></codeline></programlisting> is called, the transport is no longer usable. If the transport is already closed, the function shall do nothing. </p>
|
||||
syntax:
|
||||
content: public void close()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_transport.close()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_transport
|
||||
href: com.microsoft.azure.iothub.transport.https._https_transport.yml
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsTransport.close()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Closes all resources used to communicate with an IoT Hub. Once<programlisting><codeline><highlight class="normal">close()<sp></sp></highlight></codeline></programlisting> is called, the transport is no longer usable. If the transport is already closed, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void close()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.close()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: close()
|
||||
fullName: synchronized void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.close()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Closes all resources used to communicate with an IoT Hub. Once<programlisting><codeline><highlight class="normal">close()<sp></sp></highlight></codeline></programlisting> is called, the transport is no longer usable. If the transport is already closed, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public synchronized void close()
|
||||
return:
|
||||
type: 5c0b90ca
|
||||
- uid: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.addMessage(Message,IotHubEventCallback,Object)
|
||||
parent: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport
|
||||
href: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.yml
|
||||
name: addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
fullName: void com.microsoft.azure.iothub.transport.mqtt.MqttTransport.addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Adds a message to the transport queue.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message to be sent. </p>
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback to be invoked when a response for the message is received. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed in when the callback is invoked.</p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_transport.addMessage(Message,IotHubEventCallback,Object)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_transport
|
||||
href: com.microsoft.azure.iothub.transport.https._https_transport.yml
|
||||
name: addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsTransport.addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Adds a message to the transport queue.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message to be sent. </p>
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback to be invoked when a response for the message is received. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed in when the callback is invoked.</p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.addMessage(Message,IotHubEventCallback,Object)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Adds a message to the transport queue.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message to be sent. </p>
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback to be invoked when a response for the message is received. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed in when the callback is invoked.</p>
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
name: IotHubEventCallback
|
||||
fullName: com.microsoft.azure.iothub.IotHubEventCallback
|
||||
type: Interface
|
||||
summary: >-
|
||||
<p>An interface for an IoT Hub event callback.</p>
|
||||
|
||||
<p>Developers are expected to create an implementation of this interface, and the transport will call <xref href="com.microsoft.azure.iothub._iot_hub_event_callback.execute(IotHubStatusCode,Object)" data-throw-if-not-resolved="false"></xref> upon receiving a response from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public interface IotHubEventCallback
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_transport.sendMessages()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_transport
|
||||
href: com.microsoft.azure.iothub.transport.https._https_transport.yml
|
||||
name: sendMessages()
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsTransport.sendMessages()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Sends all messages on the transport queue as a batched request.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void sendMessages()
|
||||
- uid: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.sendMessages()
|
||||
parent: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport
|
||||
href: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.yml
|
||||
name: sendMessages()
|
||||
fullName: void com.microsoft.azure.iothub.transport.mqtt.MqttTransport.sendMessages()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Sends all messages on the transport queue, one at a time. If a previous send attempt had failed, the function will attempt to resend the messages in the previous attempt. </p>
|
||||
|
||||
<p>If one has not already been created, the function will initialize an MQTT connection with the IoT Hub specified in the configuration.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void sendMessages()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.sendMessages()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: sendMessages()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.sendMessages()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Sends all messages from the waiting list, one at a time. If a previous send attempt had failed, the function will attempt to resend the messages in the previous attempt. </p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void sendMessages()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_transport.invokeCallbacks()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_transport
|
||||
href: com.microsoft.azure.iothub.transport.https._https_transport.yml
|
||||
name: invokeCallbacks()
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsTransport.invokeCallbacks()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Invokes the callbacks for all completed requests.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void invokeCallbacks()
|
||||
- uid: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.invokeCallbacks()
|
||||
parent: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport
|
||||
href: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.yml
|
||||
name: invokeCallbacks()
|
||||
fullName: void com.microsoft.azure.iothub.transport.mqtt.MqttTransport.invokeCallbacks()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Invokes the callbacks for all completed requests.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void invokeCallbacks()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.invokeCallbacks()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: invokeCallbacks()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.invokeCallbacks()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Invokes the callbacks for all completed requests.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void invokeCallbacks()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_transport.handleMessage()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_transport
|
||||
href: com.microsoft.azure.iothub.transport.https._https_transport.yml
|
||||
name: handleMessage()
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsTransport.handleMessage()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Invokes the message callback if a message is found and responds to the IoT Hub on how the processed message should be handled by the IoT Hub. </p>
|
||||
|
||||
<p>If no message callback is set, the function will do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void handleMessage()
|
||||
- uid: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.handleMessage()
|
||||
parent: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport
|
||||
href: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.yml
|
||||
name: handleMessage()
|
||||
fullName: void com.microsoft.azure.iothub.transport.mqtt.MqttTransport.handleMessage()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Invokes the message callback every time a message arrives from the server. responds to the IoT Hub on how the processed message should be handled by the IoT Hub. </p>
|
||||
|
||||
<p>If no message callback is set, the function will do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void handleMessage()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.handleMessage()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: handleMessage()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.handleMessage()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Invokes the message callback if a message is found and responds to the IoT Hub on how the processed message should be handled by the IoT Hub. </p>
|
||||
|
||||
<p>If no message callback is set, the function will do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void handleMessage()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_transport.isEmpty()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_transport
|
||||
href: com.microsoft.azure.iothub.transport.https._https_transport.yml
|
||||
name: isEmpty()
|
||||
fullName: boolean com.microsoft.azure.iothub.transport.https.HttpsTransport.isEmpty()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Returns true if the transport has no more messages to handle, and false otherwise.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public boolean isEmpty()
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: <p>true if the transport has no more messages to handle, and false otherwise. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.isEmpty()
|
||||
parent: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport
|
||||
href: com.microsoft.azure.iothub.transport.mqtt._mqtt_transport.yml
|
||||
name: isEmpty()
|
||||
fullName: boolean com.microsoft.azure.iothub.transport.mqtt.MqttTransport.isEmpty()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Returns<programlisting><codeline><highlight class="normal">true<sp></sp></highlight></codeline></programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public boolean isEmpty()
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: >-
|
||||
<p>
|
||||
|
||||
<programlisting>
|
||||
|
||||
<codeline>
|
||||
|
||||
<highlight class="normal">true<sp></sp></highlight>
|
||||
|
||||
</codeline>
|
||||
|
||||
</programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.isEmpty()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: isEmpty()
|
||||
fullName: boolean com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.isEmpty()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Returns<programlisting><codeline><highlight class="normal">true<sp></sp></highlight></codeline></programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public boolean isEmpty()
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: >-
|
||||
<p>
|
||||
|
||||
<programlisting>
|
||||
|
||||
<codeline>
|
||||
|
||||
<highlight class="normal">true<sp></sp></highlight>
|
||||
|
||||
</codeline>
|
||||
|
||||
</programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise. </p>
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport._state
|
||||
id: _state
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport._state.CLOSED()
|
||||
- com.microsoft.azure.iothub.transport._state.OPEN()
|
||||
href: com.microsoft.azure.iothub.transport._state.yml
|
||||
langs:
|
||||
- java
|
||||
name: State
|
||||
fullName: com.microsoft.azure.iothub.transport.State
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/State.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/State.java
|
||||
startLine: 5
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public enum State
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<State>
|
||||
- uid: com.microsoft.azure.iothub.transport._state.CLOSED()
|
||||
id: CLOSED()
|
||||
parent: com.microsoft.azure.iothub.transport._state
|
||||
href: com.microsoft.azure.iothub.transport._state.yml
|
||||
langs:
|
||||
- java
|
||||
name: CLOSED
|
||||
fullName: com.microsoft.azure.iothub.transport.State.CLOSED
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/State.java
|
||||
startLine: 7
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public CLOSED
|
||||
- uid: com.microsoft.azure.iothub.transport._state.OPEN()
|
||||
id: OPEN()
|
||||
parent: com.microsoft.azure.iothub.transport._state
|
||||
href: com.microsoft.azure.iothub.transport._state.yml
|
||||
langs:
|
||||
- java
|
||||
name: OPEN
|
||||
fullName: com.microsoft.azure.iothub.transport.State.OPEN
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/State.java
|
||||
startLine: 7
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public OPEN
|
||||
references: []
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport._transport_utils
|
||||
id: _transport_utils
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport._transport_utils.clientVersion()
|
||||
- com.microsoft.azure.iothub.transport._transport_utils.generateSleepInterval(int)
|
||||
- com.microsoft.azure.iothub.transport._transport_utils.javaDeviceClientIdentifier()
|
||||
href: com.microsoft.azure.iothub.transport._transport_utils.yml
|
||||
langs:
|
||||
- java
|
||||
name: TransportUtils
|
||||
fullName: com.microsoft.azure.iothub.transport.TransportUtils
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/TransportUtils.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/TransportUtils.java
|
||||
startLine: 5
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public class TransportUtils
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.transport._transport_utils.clientVersion()
|
||||
id: clientVersion()
|
||||
parent: com.microsoft.azure.iothub.transport._transport_utils
|
||||
href: com.microsoft.azure.iothub.transport._transport_utils.yml
|
||||
langs:
|
||||
- java
|
||||
name: clientVersion
|
||||
fullName: String com.microsoft.azure.iothub.transport.TransportUtils.clientVersion
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/TransportUtils.java
|
||||
startLine: 8
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public static String clientVersion= "1.0.16"
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.transport._transport_utils.generateSleepInterval(int)
|
||||
id: generateSleepInterval(int)
|
||||
parent: com.microsoft.azure.iothub.transport._transport_utils
|
||||
href: com.microsoft.azure.iothub.transport._transport_utils.yml
|
||||
langs:
|
||||
- java
|
||||
name: generateSleepInterval(int currentAttempt)
|
||||
fullName: static int com.microsoft.azure.iothub.transport.TransportUtils.generateSleepInterval(int currentAttempt)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/TransportUtils.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
summary: >-
|
||||
<p>Generates a reconnection time with an exponential backoff and a maximum value of 60 seconds.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public static int generateSleepInterval(int currentAttempt)
|
||||
parameters:
|
||||
- id: currentAttempt
|
||||
type: f75371fa
|
||||
description: <p>the number of attempts </p>
|
||||
return:
|
||||
type: f75371fa
|
||||
description: <p>the sleep interval in milliseconds until the next attempt. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._transport_utils.javaDeviceClientIdentifier()
|
||||
id: javaDeviceClientIdentifier()
|
||||
parent: com.microsoft.azure.iothub.transport._transport_utils
|
||||
href: com.microsoft.azure.iothub.transport._transport_utils.yml
|
||||
langs:
|
||||
- java
|
||||
name: javaDeviceClientIdentifier
|
||||
fullName: String com.microsoft.azure.iothub.transport.TransportUtils.javaDeviceClientIdentifier
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/TransportUtils.java
|
||||
startLine: 7
|
||||
package: com.microsoft.azure.iothub.transport
|
||||
syntax:
|
||||
content: public static String javaDeviceClientIdentifier= "com.microsoft.azure.iothub-java-client/"
|
||||
return:
|
||||
type: "26831127"
|
||||
references:
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
|
|
@ -0,0 +1,555 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
id: _amqps_iot_hub_connection
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.addListener(ServerListener)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.AmqpsIotHubConnection(DeviceClientConfig,Boolean)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.close()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.config()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onConnectionBound(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onConnectionInit(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onConnectionUnbound(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onDelivery(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onLinkFlow(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onLinkInit(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onLinkRemoteClose(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onLinkRemoteOpen(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onReactorFinal(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onReactorInit(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onTransportError(Event)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.open()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.sendMessage(Message)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.sendMessageResult(AmqpsMessage,IotHubMessageResult)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.state()
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpsIotHubConnection
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 53
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>An AMQPS IotHub connection between a device and an IoTHub. This class contains functionality for sending/receiving a message, and logic to re-establish the connection with the IoTHub in case it gets lost. </p>
|
||||
syntax: &o1
|
||||
content: public class AmqpsIotHubConnection
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- BaseHandler
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.addListener(ServerListener)
|
||||
id: addListener(ServerListener)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: addListener(ServerListener listener)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.addListener(ServerListener listener)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 654
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Subscribe a listener to the list of listeners. </p>
|
||||
syntax:
|
||||
content: public void addListener(ServerListener listener)
|
||||
parameters:
|
||||
- id: listener
|
||||
type: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
description: <p>the listener to be subscribed. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.AmqpsIotHubConnection(DeviceClientConfig,Boolean)
|
||||
id: AmqpsIotHubConnection(DeviceClientConfig,Boolean)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpsIotHubConnection(DeviceClientConfig config, Boolean useWebSockets)
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.AmqpsIotHubConnection(DeviceClientConfig config, Boolean useWebSockets)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 105
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Constructor to set up connection parameters using the <xref href="com.microsoft.azure.iothub._device_client_config" data-throw-if-not-resolved="false"></xref>.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public AmqpsIotHubConnection(DeviceClientConfig config, Boolean useWebSockets)
|
||||
parameters:
|
||||
- id: config
|
||||
type: com.microsoft.azure.iothub._device_client_config
|
||||
description: <p>The <xref href="com.microsoft.azure.iothub._device_client_config" data-throw-if-not-resolved="false"></xref> corresponding to the device associated with this <xref href="com.microsoft.azure.iothub._device_client" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
- id: useWebSockets
|
||||
type: 866c2227
|
||||
description: <p>Whether the connection should use web sockets or not. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.close()
|
||||
id: close()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.close()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 225
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Closes the <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
|
||||
<p>If the current connection is not closed, this function will set the current state to closed and invalidate all connection related variables. </p>
|
||||
syntax:
|
||||
content: public void close()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.config()
|
||||
id: config()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: config
|
||||
fullName: DeviceClientConfig com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.config
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 86
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: protected DeviceClientConfig config
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._device_client_config
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onConnectionBound(Event)
|
||||
id: onConnectionBound(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onConnectionBound(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onConnectionBound(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 435
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Event handler for the connection bound event. Sets Sasl authentication and proper authentication mode. </p>
|
||||
syntax:
|
||||
content: public void onConnectionBound(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The Proton Event object. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onConnectionInit(Event)
|
||||
id: onConnectionInit(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onConnectionInit(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onConnectionInit(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 404
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Event handler for the connection init event </p>
|
||||
syntax:
|
||||
content: public void onConnectionInit(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The Proton Event object. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onConnectionUnbound(Event)
|
||||
id: onConnectionUnbound(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onConnectionUnbound(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onConnectionUnbound(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 462
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: public void onConnectionUnbound(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onDelivery(Event)
|
||||
id: onDelivery(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onDelivery(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onDelivery(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 515
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Event handler for the delivery event. This method handles both sending and receiving a message. </p>
|
||||
syntax:
|
||||
content: public void onDelivery(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The Proton Event object. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onLinkFlow(Event)
|
||||
id: onLinkFlow(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onLinkFlow(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onLinkFlow(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 565
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Event handler for the link flow event. Handles sending a single message. </p>
|
||||
syntax:
|
||||
content: public void onLinkFlow(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The Proton Event object. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onLinkInit(Event)
|
||||
id: onLinkInit(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onLinkInit(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onLinkInit(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 611
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Event handler for the link init event. Sets the proper target address on the link. </p>
|
||||
syntax:
|
||||
content: public void onLinkInit(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The Proton Event object. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onLinkRemoteClose(Event)
|
||||
id: onLinkRemoteClose(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onLinkRemoteClose(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onLinkRemoteClose(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 594
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Event handler for the link remote close event. This triggers reconnection attempts until successful. Both sender and receiver links closing trigger this event, so we only handle one of them, since the other is redundant. </p>
|
||||
syntax:
|
||||
content: public void onLinkRemoteClose(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The Proton Event object. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onLinkRemoteOpen(Event)
|
||||
id: onLinkRemoteOpen(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onLinkRemoteOpen(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onLinkRemoteOpen(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 577
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Event handler for the link remote open event. This signifies that the <ref refid="" kindref="compound">org.apache.qpid.proton.reactor.Reactor</ref> is ready, so we set the connection to OPEN. </p>
|
||||
syntax:
|
||||
content: public void onLinkRemoteOpen(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The Proton Event object. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onReactorFinal(Event)
|
||||
id: onReactorFinal(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onReactorFinal(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onReactorFinal(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 488
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: public void onReactorFinal(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onReactorInit(Event)
|
||||
id: onReactorInit(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onReactorInit(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onReactorInit(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 472
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Event handler for reactor init event. </p>
|
||||
syntax:
|
||||
content: public void onReactorInit(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>Proton Event object </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.onTransportError(Event)
|
||||
id: onTransportError(Event)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: onTransportError(Event event)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.onTransportError(Event event)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 642
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Event handler for the transport error event. This triggers reconnection attempts until successful. </p>
|
||||
syntax:
|
||||
content: public void onTransportError(Event event)
|
||||
parameters:
|
||||
- id: event
|
||||
type: 70fceca4
|
||||
description: <p>The Proton Event object. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.open()
|
||||
id: open()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.open()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 185
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Opens the <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
|
||||
<p>If the current connection is not open, this method will create a new <ref refid="" kindref="compound">IotHubSasToken</ref>. This method will start the <ref refid="" kindref="compound">Reactor</ref>, set the connection to open and make it ready for sending. </p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void open()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>If the reactor could not be initialized. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.sendMessage(Message)
|
||||
id: sendMessage(Message)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: sendMessage(Message message)
|
||||
fullName: Integer com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.sendMessage(Message message)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 308
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Creates a binary message using the given content and messageId. Sends the created message using the sender link. </p>
|
||||
syntax:
|
||||
content: public Integer sendMessage(Message message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>The message to be sent. </p>
|
||||
return:
|
||||
type: 08effaa0
|
||||
description: <p>An <ref refid="" kindref="compound">Integer</ref> representing the hash of the message, or -1 if the connection is closed. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.sendMessageResult(AmqpsMessage,IotHubMessageResult)
|
||||
id: sendMessageResult(AmqpsMessage,IotHubMessageResult)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: sendMessageResult(AmqpsMessage message, IotHubMessageResult result)
|
||||
fullName: Boolean com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.sendMessageResult(AmqpsMessage message, IotHubMessageResult result)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 362
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Sends the message result for the previously received message.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public Boolean sendMessageResult(AmqpsMessage message, IotHubMessageResult result)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
description: <p>the message to be acknowledged. </p>
|
||||
- id: result
|
||||
type: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
description: <p>the message result (one of <ref refid="" kindref="compound">IotHubMessageResult#COMPLETE</ref>, <ref refid="" kindref="compound">IotHubMessageResult#ABANDON</ref>, or <ref refid="" kindref="compound">IotHubMessageResult#REJECT</ref>). </p>
|
||||
return:
|
||||
type: 866c2227
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.state()
|
||||
id: state()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: state
|
||||
fullName: State com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection.state
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 57
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: protected State state
|
||||
return:
|
||||
type: com.microsoft.azure.iothub.transport._state
|
||||
references:
|
||||
- uid: 866c2227
|
||||
spec.java:
|
||||
- name: Boolean
|
||||
fullName: Boolean
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: 08effaa0
|
||||
spec.java:
|
||||
- name: Integer
|
||||
fullName: Integer
|
||||
- uid: 70fceca4
|
||||
spec.java:
|
||||
- name: Event
|
||||
fullName: Event
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
name: ServerListener
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.ServerListener
|
||||
type: Interface
|
||||
summary: <p>Defines methods which are triggered by interactions with the IoTHub. </p>
|
||||
syntax:
|
||||
content: public interface ServerListener
|
||||
- uid: com.microsoft.azure.iothub._object_lock
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._object_lock.yml
|
||||
name: ObjectLock
|
||||
fullName: com.microsoft.azure.iothub.ObjectLock
|
||||
type: Class
|
||||
summary: <p>This class enables mocking of the base class wait and notify functions </p>
|
||||
syntax:
|
||||
content: public class ObjectLock
|
||||
- uid: com.microsoft.azure.iothub.transport._state
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
href: com.microsoft.azure.iothub.transport._state.yml
|
||||
name: State
|
||||
fullName: com.microsoft.azure.iothub.transport.State
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum State
|
||||
- uid: com.microsoft.azure.iothub._device_client_config
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
name: DeviceClientConfig
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig
|
||||
type: Class
|
||||
summary: <p>Configuration settings for an IoT Hub client. Validates all user-defined settings. </p>
|
||||
syntax:
|
||||
content: public class DeviceClientConfig
|
||||
- uid: com.microsoft.azure.iothub._device_client
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._device_client.yml
|
||||
name: DeviceClient
|
||||
fullName: com.microsoft.azure.iothub.DeviceClient
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>The public-facing API. Allows a single logical or physical device to connect to an IoT Hub. The IoT Hub client supports sending events to and receiving messages from an IoT Hub. </p>
|
||||
|
||||
<p>To support these workflows, the client library will provide the following abstractions: a message, with its payload and associated properties; and a client, which sends and receives messages. </p>
|
||||
|
||||
<p>The client buffers messages while the network is down, and re-sends them when the network comes back online. It also batches messages to improve communication efficiency (HTTPS only). </p>
|
||||
|
||||
<p>The client supports HTTPS 1.1 and AMQPS 1.0 transports. </p>
|
||||
syntax:
|
||||
content: public class DeviceClient
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
name: AmqpsIotHubConnection
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection
|
||||
type: Class
|
||||
summary: <p>An AMQPS IotHub connection between a device and an IoTHub. This class contains functionality for sending/receiving a message, and logic to re-establish the connection with the IoTHub in case it gets lost. </p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message.yml
|
||||
name: AmqpsMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage
|
||||
type: Class
|
||||
summary: <p>Extension of the QPID-Proton-J MessageImpl class which implements the <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> interface. Adds a Delivery object as a private member variable and adds a new <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e" data-throw-if-not-resolved="false"></xref> enum. Adds the ability to easily acknowledge a single message. </p>
|
||||
syntax:
|
||||
content: public class AmqpsMessage
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_message_result.yml
|
||||
name: IotHubMessageResult
|
||||
fullName: com.microsoft.azure.iothub.IotHubMessageResult
|
||||
type: Enum
|
||||
summary: <p>A return value from a message callback that instructs an IoT Hub to complete, abandon, or reject the message. </p>
|
||||
syntax:
|
||||
content: public enum IotHubMessageResult
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e
|
||||
id: _a_c_k___t_y_p_e
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.ABANDON()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.COMPLETE()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.REJECT()
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpsMessage.ACK_TYPE
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage.ACK_TYPE
|
||||
type: Enum
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsMessage.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsMessage.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: public enum ACK_TYPE
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- java.lang.Enum<AmqpsMessage.ACK_TYPE>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.ABANDON()
|
||||
id: ABANDON()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.yml
|
||||
langs:
|
||||
- java
|
||||
name: ABANDON
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage.ACK_TYPE.ABANDON
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsMessage.java
|
||||
startLine: 24
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: public ABANDON
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.COMPLETE()
|
||||
id: COMPLETE()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.yml
|
||||
langs:
|
||||
- java
|
||||
name: COMPLETE
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage.ACK_TYPE.COMPLETE
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsMessage.java
|
||||
startLine: 23
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: public COMPLETE
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.REJECT()
|
||||
id: REJECT()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.yml
|
||||
langs:
|
||||
- java
|
||||
name: REJECT
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage.ACK_TYPE.REJECT
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsMessage.java
|
||||
startLine: 25
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: public REJECT
|
||||
references: []
|
||||
|
|
@ -0,0 +1,98 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
id: _amqps_message
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_message.acknowledge(ACK_TYPE)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_message.setDelivery(Delivery)
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpsMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsMessage.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsMessage.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Extension of the QPID-Proton-J MessageImpl class which implements the <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> interface. Adds a Delivery object as a private member variable and adds a new <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e" data-throw-if-not-resolved="false"></xref> enum. Adds the ability to easily acknowledge a single message. </p>
|
||||
syntax: &o1
|
||||
content: public class AmqpsMessage
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- MessageImpl
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message.acknowledge(ACK_TYPE)
|
||||
id: acknowledge(ACK_TYPE)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: acknowledge(ACK_TYPE ackType)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsMessage.acknowledge(ACK_TYPE ackType)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsMessage.java
|
||||
startLine: 32
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Sends acknowledgement of this message using the provided <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e" data-throw-if-not-resolved="false"></xref>. </p>
|
||||
syntax:
|
||||
content: public void acknowledge(ACK_TYPE ackType)
|
||||
parameters:
|
||||
- id: ackType
|
||||
type: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e
|
||||
description: <p>acknowledgement type to send </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message.setDelivery(Delivery)
|
||||
id: setDelivery(Delivery)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: setDelivery(Delivery _delivery)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsMessage.setDelivery(Delivery _delivery)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsMessage.java
|
||||
startLine: 60
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Sets this <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_message" data-throw-if-not-resolved="false"></xref> Delivery Object </p>
|
||||
syntax:
|
||||
content: public void setDelivery(Delivery _delivery)
|
||||
parameters:
|
||||
- id: _delivery
|
||||
type: a2b35a06
|
||||
description: <p>the new Delivery </p>
|
||||
references:
|
||||
- uid: a2b35a06
|
||||
spec.java:
|
||||
- name: Delivery
|
||||
fullName: Delivery
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.yml
|
||||
name: AmqpsMessage.ACK_TYPE
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage.ACK_TYPE
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum ACK_TYPE
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message.yml
|
||||
name: AmqpsMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage
|
||||
type: Class
|
||||
summary: <p>Extension of the QPID-Proton-J MessageImpl class which implements the <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> interface. Adds a Delivery object as a private member variable and adds a new <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e" data-throw-if-not-resolved="false"></xref> enum. Adds the ability to easily acknowledge a single message. </p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class Message
|
||||
|
|
@ -0,0 +1,602 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
id: _amqps_transport
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.addMessage(Message,IotHubEventCallback,Object)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.AmqpsTransport(final DeviceClientConfig,Boolean)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.close()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.connectionLost()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.handleMessage()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.invokeCallbacks()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.isEmpty()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.messageReceived(AmqpsMessage)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.messageSent(Integer,Boolean)
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.open()
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport.sendMessages()
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpsTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsTransport
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 36
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>An AMQPS transport. Contains functionality for adding messages and sending messages to an IoT Hub. Buffers unsent messages until they are received by an IoT Hub. A transport is bound at construction to the following parameters: IoT Hub name, device ID and device key. </p>
|
||||
|
||||
<p>The transport also receives messages from IoT Hub and invokes a user-defined message callback if a message and callback are found. </p>
|
||||
syntax:
|
||||
content: public class AmqpsTransport implements IotHubTransport,ServerListener
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- Closeable
|
||||
- com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.addMessage(Message,IotHubEventCallback,Object)
|
||||
id: addMessage(Message,IotHubEventCallback,Object)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 141
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Adds a message to the transport queue.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message to be sent. </p>
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback to be invoked when a response for the message is received. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed in when the callback is invoked.</p>
|
||||
overridden: com.microsoft.azure.iothub.transport._iot_hub_transport.addMessage(Message,IotHubEventCallback,Object)
|
||||
exceptions:
|
||||
- type: 12fe80de
|
||||
description: <p>if the transport is closed. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.AmqpsTransport(final DeviceClientConfig,Boolean)
|
||||
id: AmqpsTransport(final DeviceClientConfig,Boolean)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: AmqpsTransport(final DeviceClientConfig config, Boolean useWebSockets)
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.AmqpsTransport(final DeviceClientConfig config, Boolean useWebSockets)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 68
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Constructs an instance from the given <xref href="com.microsoft.azure.iothub._device_client_config" data-throw-if-not-resolved="false"></xref> object.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public AmqpsTransport(final DeviceClientConfig config, Boolean useWebSockets)
|
||||
parameters:
|
||||
- id: config
|
||||
type: 93de0ef9com.microsoft.azure.iothub._device_client_config
|
||||
description: <p>configuration parameters for an AMQPS session with an IoT Hub </p>
|
||||
- id: useWebSockets
|
||||
type: 866c2227
|
||||
description: <p>whether the transport should use web sockets or not </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.close()
|
||||
id: close()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: close()
|
||||
fullName: synchronized void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.close()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 117
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Closes all resources used to communicate with an IoT Hub. Once<programlisting><codeline><highlight class="normal">close()<sp></sp></highlight></codeline></programlisting> is called, the transport is no longer usable. If the transport is already closed, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public synchronized void close()
|
||||
return:
|
||||
type: 5c0b90ca
|
||||
overridden: com.microsoft.azure.iothub.transport._iot_hub_transport.close()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if an error occurs in closing the transport. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.connectionLost()
|
||||
id: connectionLost()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: connectionLost()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.connectionLost()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 327
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>If the connection is lost, all the messages in progress are buffered to be sent again. </p>
|
||||
syntax:
|
||||
content: public void connectionLost()
|
||||
overridden: com.microsoft.azure.iothub.transport.amqps._server_listener.connectionLost()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.handleMessage()
|
||||
id: handleMessage()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: handleMessage()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.handleMessage()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 259
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Invokes the message callback if a message is found and responds to the IoT Hub on how the processed message should be handled by the IoT Hub. </p>
|
||||
|
||||
<p>If no message callback is set, the function will do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void handleMessage()
|
||||
overridden: com.microsoft.azure.iothub.transport._iot_hub_transport.handleMessage()
|
||||
exceptions:
|
||||
- type: 12fe80de
|
||||
description: <p>if the transport is closed. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.invokeCallbacks()
|
||||
id: invokeCallbacks()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: invokeCallbacks()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.invokeCallbacks()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 228
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Invokes the callbacks for all completed requests.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void invokeCallbacks()
|
||||
overridden: com.microsoft.azure.iothub.transport._iot_hub_transport.invokeCallbacks()
|
||||
exceptions:
|
||||
- type: 12fe80de
|
||||
description: <p>if the transport is closed. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.isEmpty()
|
||||
id: isEmpty()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: isEmpty()
|
||||
fullName: boolean com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.isEmpty()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 356
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Returns<programlisting><codeline><highlight class="normal">true<sp></sp></highlight></codeline></programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public boolean isEmpty()
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: >-
|
||||
<p>
|
||||
|
||||
<programlisting>
|
||||
|
||||
<codeline>
|
||||
|
||||
<highlight class="normal">true<sp></sp></highlight>
|
||||
|
||||
</codeline>
|
||||
|
||||
</programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise. </p>
|
||||
overridden: com.microsoft.azure.iothub.transport._iot_hub_transport.isEmpty()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.messageReceived(AmqpsMessage)
|
||||
id: messageReceived(AmqpsMessage)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: messageReceived(AmqpsMessage message)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.messageReceived(AmqpsMessage message)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 343
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>When a message is received, it is added to the list of messages to be processed. </p>
|
||||
syntax:
|
||||
content: public void messageReceived(AmqpsMessage message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
description: <p>The message received. </p>
|
||||
overridden: com.microsoft.azure.iothub.transport.amqps._server_listener.messageReceived(AmqpsMessage)
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.messageSent(Integer,Boolean)
|
||||
id: messageSent(Integer,Boolean)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: messageSent(Integer messageHash, Boolean deliveryState)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.messageSent(Integer messageHash, Boolean deliveryState)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 304
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>When a message is acknowledged by IoTHub, it is removed from the list of in progress messages and its callback is added to the list of callbacks to be executed. If the message was not successfully delivered, it is buffered to be sent again. </p>
|
||||
syntax:
|
||||
content: public void messageSent(Integer messageHash, Boolean deliveryState)
|
||||
parameters:
|
||||
- id: messageHash
|
||||
type: 08effaa0
|
||||
description: <p>The hash of the message. </p>
|
||||
- id: deliveryState
|
||||
type: 866c2227
|
||||
description: <p>The state of the delivery. </p>
|
||||
overridden: com.microsoft.azure.iothub.transport.amqps._server_listener.messageSent(Integer,Boolean)
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.open()
|
||||
id: open()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: open()
|
||||
fullName: synchronized void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.open()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 84
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Establishes a communication channel with an IoT Hub. If a channel is already open, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public synchronized void open()
|
||||
return:
|
||||
type: 5c0b90ca
|
||||
overridden: com.microsoft.azure.iothub.transport._iot_hub_transport.open()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if a communication channel cannot be established. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.sendMessages()
|
||||
id: sendMessages()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
langs:
|
||||
- java
|
||||
name: sendMessages()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.sendMessages()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsTransport.java
|
||||
startLine: 165
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: >-
|
||||
<p>Sends all messages from the waiting list, one at a time. If a previous send attempt had failed, the function will attempt to resend the messages in the previous attempt. </p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void sendMessages()
|
||||
overridden: com.microsoft.azure.iothub.transport._iot_hub_transport.sendMessages()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the server could not be reached. </p>
|
||||
- type: 12fe80de
|
||||
description: <p>if the transport has not been opened or is already closed. </p>
|
||||
references:
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub._device_client_config
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub._device_client_config
|
||||
name: DeviceClientConfig
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
- uid: 866c2227
|
||||
spec.java:
|
||||
- name: Boolean
|
||||
fullName: Boolean
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: 5c0b90ca
|
||||
spec.java:
|
||||
- name: synchronized void
|
||||
fullName: synchronized void
|
||||
- uid: 12fe80de
|
||||
spec.java:
|
||||
- name: IllegalStateException
|
||||
fullName: IllegalStateException
|
||||
- uid: "79317049"
|
||||
spec.java:
|
||||
- name: Object
|
||||
fullName: Object
|
||||
- uid: 08effaa0
|
||||
spec.java:
|
||||
- name: Integer
|
||||
fullName: Integer
|
||||
- uid: 4fc6e284
|
||||
spec.java:
|
||||
- name: boolean
|
||||
fullName: boolean
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: IotHubTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubTransport
|
||||
type: Interface
|
||||
summary: <p>An interface for an IoT Hub transport. </p>
|
||||
syntax:
|
||||
content: public interface IotHubTransport
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
name: ServerListener
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.ServerListener
|
||||
type: Interface
|
||||
summary: <p>Defines methods which are triggered by interactions with the IoTHub. </p>
|
||||
syntax:
|
||||
content: public interface ServerListener
|
||||
- uid: com.microsoft.azure.iothub.transport._state
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
href: com.microsoft.azure.iothub.transport._state.yml
|
||||
name: State
|
||||
fullName: com.microsoft.azure.iothub.transport.State
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum State
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
name: AmqpsIotHubConnection
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection
|
||||
type: Class
|
||||
summary: <p>An AMQPS IotHub connection between a device and an IoTHub. This class contains functionality for sending/receiving a message, and logic to re-establish the connection with the IoTHub in case it gets lost. </p>
|
||||
syntax:
|
||||
content: public class AmqpsIotHubConnection
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_outbound_packet.yml
|
||||
name: IotHubOutboundPacket
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubOutboundPacket
|
||||
type: Class
|
||||
summary: <p>A packet containing the data needed for an IoT Hub transport to send a message. </p>
|
||||
syntax:
|
||||
content: public class IotHubOutboundPacket
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message.yml
|
||||
name: AmqpsMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage
|
||||
type: Class
|
||||
summary: <p>Extension of the QPID-Proton-J MessageImpl class which implements the <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> interface. Adds a Delivery object as a private member variable and adds a new <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e" data-throw-if-not-resolved="false"></xref> enum. Adds the ability to easily acknowledge a single message. </p>
|
||||
syntax:
|
||||
content: public class AmqpsMessage
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_callback_packet
|
||||
parent: com.microsoft.azure.iothub.transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_callback_packet.yml
|
||||
name: IotHubCallbackPacket
|
||||
fullName: com.microsoft.azure.iothub.transport.IotHubCallbackPacket
|
||||
type: Class
|
||||
summary: <p>A packet containing the data needed for an IoT Hub transport to invoke a callback. </p>
|
||||
syntax:
|
||||
content: public class IotHubCallbackPacket
|
||||
- uid: com.microsoft.azure.iothub._device_client_config
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
name: DeviceClientConfig
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig
|
||||
type: Class
|
||||
summary: <p>Configuration settings for an IoT Hub client. Validates all user-defined settings. </p>
|
||||
syntax:
|
||||
content: public class DeviceClientConfig
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.open()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: open()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.open()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Establishes a communication channel with an IoT Hub. If a channel is already open, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void open()
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.close()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: close()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.close()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Closes all resources used to communicate with an IoT Hub. Once<programlisting><codeline><highlight class="normal">close()<sp></sp></highlight></codeline></programlisting> is called, the transport is no longer usable. If the transport is already closed, the function shall do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void close()
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.addMessage(Message,IotHubEventCallback,Object)
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Adds a message to the transport queue.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void addMessage(Message message, IotHubEventCallback callback, Object callbackContext)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>the message to be sent. </p>
|
||||
- id: callback
|
||||
type: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
description: <p>the callback to be invoked when a response for the message is received. </p>
|
||||
- id: callbackContext
|
||||
type: "79317049"
|
||||
description: <p>the context to be passed in when the callback is invoked. </p>
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_event_callback
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_event_callback.yml
|
||||
name: IotHubEventCallback
|
||||
fullName: com.microsoft.azure.iothub.IotHubEventCallback
|
||||
type: Interface
|
||||
summary: >-
|
||||
<p>An interface for an IoT Hub event callback.</p>
|
||||
|
||||
<p>Developers are expected to create an implementation of this interface, and the transport will call <xref href="com.microsoft.azure.iothub._iot_hub_event_callback.execute(IotHubStatusCode,Object)" data-throw-if-not-resolved="false"></xref> upon receiving a response from an IoT Hub. </p>
|
||||
syntax:
|
||||
content: public interface IotHubEventCallback
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.sendMessages()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: sendMessages()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.sendMessages()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Sends all messages on the transport queue. If a previous send attempt had failed, the function will attempt to resend the messages in the previous attempt.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void sendMessages()
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.invokeCallbacks()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: invokeCallbacks()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.invokeCallbacks()
|
||||
type: Method
|
||||
summary: <p>Invokes the callbacks for all completed requests. </p>
|
||||
syntax:
|
||||
content: public void invokeCallbacks()
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.handleMessage()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: handleMessage()
|
||||
fullName: void com.microsoft.azure.iothub.transport.IotHubTransport.handleMessage()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Invokes the message callback if a message is found and responds to the IoT Hub on how the processed message should be handled by the IoT Hub. </p>
|
||||
|
||||
<p>If no message callback is set, the function will do nothing.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void handleMessage()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener.messageSent(Integer,Boolean)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
name: messageSent(Integer messageHash, Boolean deliveryState)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.ServerListener.messageSent(Integer messageHash, Boolean deliveryState)
|
||||
type: Method
|
||||
summary: <p>Method executed when a message was acknowledged by IoTHub. </p>
|
||||
syntax:
|
||||
content: public void messageSent(Integer messageHash, Boolean deliveryState)
|
||||
parameters:
|
||||
- id: messageHash
|
||||
type: 08effaa0
|
||||
description: <p>The hash of the message. </p>
|
||||
- id: deliveryState
|
||||
type: 866c2227
|
||||
description: <p>The state of the delivery. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener.connectionLost()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
name: connectionLost()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.ServerListener.connectionLost()
|
||||
type: Method
|
||||
summary: <p>Method executed when the connection with the IoTHub is lost. </p>
|
||||
syntax:
|
||||
content: public void connectionLost()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener.messageReceived(AmqpsMessage)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
name: messageReceived(AmqpsMessage message)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.ServerListener.messageReceived(AmqpsMessage message)
|
||||
type: Method
|
||||
summary: <p>Method executed when a message was received from IoTHub. </p>
|
||||
syntax:
|
||||
content: public void messageReceived(AmqpsMessage message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
description: <p>The message received. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport._iot_hub_transport.isEmpty()
|
||||
parent: com.microsoft.azure.iothub.transport._iot_hub_transport
|
||||
href: com.microsoft.azure.iothub.transport._iot_hub_transport.yml
|
||||
name: isEmpty()
|
||||
fullName: boolean com.microsoft.azure.iothub.transport.IotHubTransport.isEmpty()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Returns<programlisting><codeline><highlight class="normal">true<sp></sp></highlight></codeline></programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public boolean isEmpty()
|
||||
return:
|
||||
type: 4fc6e284
|
||||
description: >-
|
||||
<p>
|
||||
|
||||
<programlisting>
|
||||
|
||||
<codeline>
|
||||
|
||||
<highlight class="normal">true<sp></sp></highlight>
|
||||
|
||||
</codeline>
|
||||
|
||||
</programlisting> if the transport has no more messages to handle, and<programlisting><codeline><highlight class="normal">false<sp></sp></highlight></codeline></programlisting> otherwise. </p>
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor
|
||||
id: _iot_hub_reactor
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.IotHubReactor(Reactor)
|
||||
- com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.run()
|
||||
href: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubReactor
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.IotHubReactor
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/IotHubReactor.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/IotHubReactor.java
|
||||
startLine: 12
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: public class IotHubReactor
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.reactor()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.IotHubReactor(Reactor)
|
||||
id: IotHubReactor(Reactor)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor
|
||||
href: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.yml
|
||||
langs:
|
||||
- java
|
||||
name: IotHubReactor(Reactor reactor)
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.IotHubReactor.IotHubReactor(Reactor reactor)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/IotHubReactor.java
|
||||
startLine: 16
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: public IotHubReactor(Reactor reactor)
|
||||
parameters:
|
||||
- id: reactor
|
||||
type: 5f183614
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.run()
|
||||
id: run()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor
|
||||
href: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.yml
|
||||
langs:
|
||||
- java
|
||||
name: run()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.IotHubReactor.run()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/IotHubReactor.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
syntax:
|
||||
content: public void run()
|
||||
references:
|
||||
- uid: 5f183614
|
||||
spec.java:
|
||||
- name: Reactor
|
||||
fullName: Reactor
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.reactor()
|
||||
|
|
@ -0,0 +1,155 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
id: _server_listener
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.amqps._server_listener.connectionLost()
|
||||
- com.microsoft.azure.iothub.transport.amqps._server_listener.messageReceived(AmqpsMessage)
|
||||
- com.microsoft.azure.iothub.transport.amqps._server_listener.messageSent(Integer,Boolean)
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
langs:
|
||||
- java
|
||||
name: ServerListener
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.ServerListener
|
||||
type: Interface
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/ServerListener.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/ServerListener.java
|
||||
startLine: 8
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Defines methods which are triggered by interactions with the IoTHub. </p>
|
||||
syntax:
|
||||
content: public interface ServerListener
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener.connectionLost()
|
||||
id: connectionLost()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
langs:
|
||||
- java
|
||||
name: connectionLost()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.ServerListener.connectionLost()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/ServerListener.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Method executed when the connection with the IoTHub is lost. </p>
|
||||
syntax:
|
||||
content: public void connectionLost()
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener.messageReceived(AmqpsMessage)
|
||||
id: messageReceived(AmqpsMessage)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
langs:
|
||||
- java
|
||||
name: messageReceived(AmqpsMessage message)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.ServerListener.messageReceived(AmqpsMessage message)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/ServerListener.java
|
||||
startLine: 21
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Method executed when a message was received from IoTHub. </p>
|
||||
syntax:
|
||||
content: public void messageReceived(AmqpsMessage message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
description: <p>The message received. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener.messageSent(Integer,Boolean)
|
||||
id: messageSent(Integer,Boolean)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
langs:
|
||||
- java
|
||||
name: messageSent(Integer messageHash, Boolean deliveryState)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.ServerListener.messageSent(Integer messageHash, Boolean deliveryState)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/ServerListener.java
|
||||
startLine: 15
|
||||
package: com.microsoft.azure.iothub.transport.amqps
|
||||
summary: <p>Method executed when a message was acknowledged by IoTHub. </p>
|
||||
syntax:
|
||||
content: public void messageSent(Integer messageHash, Boolean deliveryState)
|
||||
parameters:
|
||||
- id: messageHash
|
||||
type: 08effaa0
|
||||
description: <p>The hash of the message. </p>
|
||||
- id: deliveryState
|
||||
type: 866c2227
|
||||
description: <p>The state of the delivery. </p>
|
||||
references:
|
||||
- uid: 08effaa0
|
||||
spec.java:
|
||||
- name: Integer
|
||||
fullName: Integer
|
||||
- uid: 866c2227
|
||||
spec.java:
|
||||
- name: Boolean
|
||||
fullName: Boolean
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: AmqpsTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsTransport
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>An AMQPS transport. Contains functionality for adding messages and sending messages to an IoT Hub. Buffers unsent messages until they are received by an IoT Hub. A transport is bound at construction to the following parameters: IoT Hub name, device ID and device key. </p>
|
||||
|
||||
<p>The transport also receives messages from IoT Hub and invokes a user-defined message callback if a message and callback are found. </p>
|
||||
syntax:
|
||||
content: public class AmqpsTransport implements IotHubTransport,ServerListener
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.messageSent(Integer,Boolean)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: messageSent(Integer messageHash, Boolean deliveryState)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.messageSent(Integer messageHash, Boolean deliveryState)
|
||||
type: Method
|
||||
summary: <p>When a message is acknowledged by IoTHub, it is removed from the list of in progress messages and its callback is added to the list of callbacks to be executed. If the message was not successfully delivered, it is buffered to be sent again. </p>
|
||||
syntax:
|
||||
content: public void messageSent(Integer messageHash, Boolean deliveryState)
|
||||
parameters:
|
||||
- id: messageHash
|
||||
type: 08effaa0
|
||||
description: <p>The hash of the message. </p>
|
||||
- id: deliveryState
|
||||
type: 866c2227
|
||||
description: <p>The state of the delivery. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.messageReceived(AmqpsMessage)
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: messageReceived(AmqpsMessage message)
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.messageReceived(AmqpsMessage message)
|
||||
type: Method
|
||||
summary: <p>When a message is received, it is added to the list of messages to be processed. </p>
|
||||
syntax:
|
||||
content: public void messageReceived(AmqpsMessage message)
|
||||
parameters:
|
||||
- id: message
|
||||
type: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
description: <p>The message received. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message.yml
|
||||
name: AmqpsMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage
|
||||
type: Class
|
||||
summary: <p>Extension of the QPID-Proton-J MessageImpl class which implements the <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> interface. Adds a Delivery object as a private member variable and adds a new <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e" data-throw-if-not-resolved="false"></xref> enum. Adds the ability to easily acknowledge a single message. </p>
|
||||
syntax:
|
||||
content: public class AmqpsMessage
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport.connectionLost()
|
||||
parent: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: connectionLost()
|
||||
fullName: void com.microsoft.azure.iothub.transport.amqps.AmqpsTransport.connectionLost()
|
||||
type: Method
|
||||
summary: <p>If the connection is lost, all the messages in progress are buffered to be sent again. </p>
|
||||
syntax:
|
||||
content: public void connectionLost()
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps
|
||||
id: amqps
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e
|
||||
- com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
- com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor
|
||||
- com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
href: com.microsoft.azure.iothub.transport.amqps.yml
|
||||
langs:
|
||||
- java
|
||||
name: com.microsoft.azure.iothub.transport.amqps
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps
|
||||
type: Namespace
|
||||
source:
|
||||
remote:
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/amqps/AmqpsIotHubConnection.java
|
||||
startLine: 5
|
||||
summary: <p>AMQPS IoT Hub transport and communication classes. </p>
|
||||
syntax:
|
||||
content: package com.microsoft.azure.iothub.transport.amqps
|
||||
references:
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_iot_hub_connection.yml
|
||||
name: AmqpsIotHubConnection
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsIotHubConnection
|
||||
type: Class
|
||||
summary: <p>An AMQPS IotHub connection between a device and an IoTHub. This class contains functionality for sending/receiving a message, and logic to re-establish the connection with the IoTHub in case it gets lost. </p>
|
||||
syntax:
|
||||
content: public class AmqpsIotHubConnection
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message.yml
|
||||
name: AmqpsMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage
|
||||
type: Class
|
||||
summary: <p>Extension of the QPID-Proton-J MessageImpl class which implements the <xref href="com.microsoft.azure.iothub._message" data-throw-if-not-resolved="false"></xref> interface. Adds a Delivery object as a private member variable and adds a new <xref href="com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e" data-throw-if-not-resolved="false"></xref> enum. Adds the ability to easily acknowledge a single message. </p>
|
||||
syntax:
|
||||
content: public class AmqpsMessage
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_transport
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_transport.yml
|
||||
name: AmqpsTransport
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsTransport
|
||||
type: Class
|
||||
summary: >-
|
||||
<p>An AMQPS transport. Contains functionality for adding messages and sending messages to an IoT Hub. Buffers unsent messages until they are received by an IoT Hub. A transport is bound at construction to the following parameters: IoT Hub name, device ID and device key. </p>
|
||||
|
||||
<p>The transport also receives messages from IoT Hub and invokes a user-defined message callback if a message and callback are found. </p>
|
||||
syntax:
|
||||
content: public class AmqpsTransport implements IotHubTransport,ServerListener
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._iot_hub_reactor.yml
|
||||
name: IotHubReactor
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.IotHubReactor
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class IotHubReactor
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._server_listener
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._server_listener.yml
|
||||
name: ServerListener
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.ServerListener
|
||||
type: Interface
|
||||
summary: <p>Defines methods which are triggered by interactions with the IoTHub. </p>
|
||||
syntax:
|
||||
content: public interface ServerListener
|
||||
- uid: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e
|
||||
parent: com.microsoft.azure.iothub.transport.amqps
|
||||
href: com.microsoft.azure.iothub.transport.amqps._amqps_message._a_c_k___t_y_p_e.yml
|
||||
name: AmqpsMessage.ACK_TYPE
|
||||
fullName: com.microsoft.azure.iothub.transport.amqps.AmqpsMessage.ACK_TYPE
|
||||
type: Enum
|
||||
syntax:
|
||||
content: public enum ACK_TYPE
|
||||
|
|
@ -0,0 +1,437 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
id: _https_batch_message
|
||||
parent: com.microsoft.azure.iothub.transport.https
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.addJsonObjToArray(String,String)
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.addMessage(HttpsSingleMessage)
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.BATCH_CHARSET()
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.batchBody()
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.getBody()
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.getContentType()
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.getProperties()
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.HTTPS_BATCH_CONTENT_TYPE()
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.HttpsBatchMessage()
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.msgToJson(HttpsSingleMessage)
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.numMessages()
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.numMsgs()
|
||||
- com.microsoft.azure.iothub.transport.https._https_batch_message.SERVICEBOUND_MESSAGE_MAX_SIZE_BYTES()
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpsBatchMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsBatchMessage
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>Builds a batched IoT Hub request body as a JSON array. The batched message has a maximum size of 256 kb. </p>
|
||||
syntax:
|
||||
content: public class HttpsBatchMessage implements HttpsMessage
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- com.microsoft.azure.iothub.transport.https._https_message
|
||||
inheritedMembers:
|
||||
- com.microsoft.azure.iothub.transport.https._https_message.HTTPS_APP_PROPERTY_PREFIX()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.addJsonObjToArray(String,String)
|
||||
id: addJsonObjToArray(String,String)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: addJsonObjToArray(String jsonObj, String jsonArray)
|
||||
fullName: static String com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.addJsonObjToArray(String jsonObj, String jsonArray)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 175
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Adds a JSON object to a JSON array.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static String addJsonObjToArray(String jsonObj, String jsonArray)
|
||||
parameters:
|
||||
- id: jsonObj
|
||||
type: "26831127"
|
||||
description: <p>the object to be added to the JSON array. </p>
|
||||
- id: jsonArray
|
||||
type: "26831127"
|
||||
description: <p>the JSON array.</p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the JSON string representation of the JSON array with the object added. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.addMessage(HttpsSingleMessage)
|
||||
id: addMessage(HttpsSingleMessage)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: addMessage(HttpsSingleMessage msg)
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.addMessage(HttpsSingleMessage msg)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 56
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Adds a message to the batch.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void addMessage(HttpsSingleMessage msg)
|
||||
parameters:
|
||||
- id: msg
|
||||
type: com.microsoft.azure.iothub.transport.https._https_single_message
|
||||
description: <p>the message to be added.</p>
|
||||
exceptions:
|
||||
- type: 5006a7c2
|
||||
description: <p>if adding the message causes the batched message to exceed 256 kb in size. The batched message will remain as if the message was never added. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.BATCH_CHARSET()
|
||||
id: BATCH_CHARSET()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: BATCH_CHARSET
|
||||
fullName: Charset com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.BATCH_CHARSET
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 32
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>The charset used to encode IoT Hub messages. The server will interpret the JSON array using UTF-8 by default according to RFC4627. </p>
|
||||
syntax:
|
||||
content: public static Charset BATCH_CHARSET= StandardCharsets.UTF_8
|
||||
return:
|
||||
type: 05c094f5
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.batchBody()
|
||||
id: batchBody()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: batchBody
|
||||
fullName: String com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.batchBody
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 35
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>The current batched message body. </p>
|
||||
syntax:
|
||||
content: protected String batchBody
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.getBody()
|
||||
id: getBody()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getBody()
|
||||
fullName: byte [] com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.getBody()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 82
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Returns the current batch body as a UTF-8 encoded byte array.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public byte [] getBody()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>the current batch body as a UTF-8 encoded byte array. </p>
|
||||
overridden: com.microsoft.azure.iothub.transport.https._https_message.getBody()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.getContentType()
|
||||
id: getContentType()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getContentType()
|
||||
fullName: String com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.getContentType()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 94
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Returns the message content-type as 'application/vnd.microsoft.iothub.json'.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public String getContentType()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the message content-type as 'application/vnd.microsoft.iothub.json'. </p>
|
||||
overridden: com.microsoft.azure.iothub.transport.https._https_message.getContentType()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.getProperties()
|
||||
id: getProperties()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: getProperties()
|
||||
fullName: MessageProperty [] com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.getProperties()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 105
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Returns an empty list of properties for the batched message.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public MessageProperty [] getProperties()
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._message_propertye5b41c5f
|
||||
description: <p>an empty list of properties for the batched message. </p>
|
||||
overridden: com.microsoft.azure.iothub.transport.https._https_message.getProperties()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.HTTPS_BATCH_CONTENT_TYPE()
|
||||
id: HTTPS_BATCH_CONTENT_TYPE()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: HTTPS_BATCH_CONTENT_TYPE
|
||||
fullName: String com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.HTTPS_BATCH_CONTENT_TYPE
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 26
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>The value for the "content-type" header field in a batched HTTPS request. </p>
|
||||
syntax:
|
||||
content: public static String HTTPS_BATCH_CONTENT_TYPE= "application/vnd.microsoft.iothub.json"
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.HttpsBatchMessage()
|
||||
id: HttpsBatchMessage()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpsBatchMessage()
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.HttpsBatchMessage()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 40
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>Constructor. Initializes the batch body as an empty JSON array. </p>
|
||||
syntax:
|
||||
content: public HttpsBatchMessage()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.msgToJson(HttpsSingleMessage)
|
||||
id: msgToJson(HttpsSingleMessage)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: msgToJson(HttpsSingleMessage msg)
|
||||
fullName: static String com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.msgToJson(HttpsSingleMessage msg)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 130
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Converts a service-bound message to a JSON object with the correct format.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static String msgToJson(HttpsSingleMessage msg)
|
||||
parameters:
|
||||
- id: msg
|
||||
type: com.microsoft.azure.iothub.transport.https._https_single_message
|
||||
description: <p>the message to be converted to a corresponding JSON object.</p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the JSON string representation of the message. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.numMessages()
|
||||
id: numMessages()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: numMessages()
|
||||
fullName: int com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.numMessages()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 116
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Returns the number of messages currently in the batch.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public int numMessages()
|
||||
return:
|
||||
type: f75371fa
|
||||
description: <p>the number of messages currently in the batch. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.numMsgs()
|
||||
id: numMsgs()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: numMsgs
|
||||
fullName: int com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.numMsgs
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 37
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>The current number of messages in the batch. </p>
|
||||
syntax:
|
||||
content: protected int numMsgs
|
||||
return:
|
||||
type: f75371fa
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_batch_message.SERVICEBOUND_MESSAGE_MAX_SIZE_BYTES()
|
||||
id: SERVICEBOUND_MESSAGE_MAX_SIZE_BYTES()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_batch_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_batch_message.yml
|
||||
langs:
|
||||
- java
|
||||
name: SERVICEBOUND_MESSAGE_MAX_SIZE_BYTES
|
||||
fullName: final int com.microsoft.azure.iothub.transport.https.HttpsBatchMessage.SERVICEBOUND_MESSAGE_MAX_SIZE_BYTES
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsBatchMessage.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
syntax:
|
||||
content: public static final int SERVICEBOUND_MESSAGE_MAX_SIZE_BYTES= 255 * 1024 - 1
|
||||
return:
|
||||
type: cd225469
|
||||
references:
|
||||
- uid: cd225469
|
||||
spec.java:
|
||||
- name: final int
|
||||
fullName: final int
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: 05c094f5
|
||||
spec.java:
|
||||
- name: Charset
|
||||
fullName: Charset
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
- uid: 5006a7c2
|
||||
spec.java:
|
||||
- name: SizeLimitExceededException
|
||||
fullName: SizeLimitExceededException
|
||||
- uid: ccd9418d
|
||||
spec.java:
|
||||
- name: byte []
|
||||
fullName: byte []
|
||||
- uid: com.microsoft.azure.iothub._message_propertye5b41c5f
|
||||
spec.java:
|
||||
- uid: com.microsoft.azure.iothub._message_property
|
||||
name: MessageProperty
|
||||
fullName: com.microsoft.azure.iothub.MessageProperty
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
- name: " []"
|
||||
fullName: " []"
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_message.HTTPS_APP_PROPERTY_PREFIX()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_message.yml
|
||||
name: HTTPS_APP_PROPERTY_PREFIX
|
||||
fullName: String com.microsoft.azure.iothub.transport.https.HttpsMessage.HTTPS_APP_PROPERTY_PREFIX
|
||||
type: Field
|
||||
summary: <p>The prefix to be added to an HTTPS application-defined property. </p>
|
||||
syntax:
|
||||
content: public String HTTPS_APP_PROPERTY_PREFIX= "iothub-app-"
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_message
|
||||
parent: com.microsoft.azure.iothub.transport.https
|
||||
href: com.microsoft.azure.iothub.transport.https._https_message.yml
|
||||
name: HttpsMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsMessage
|
||||
type: Interface
|
||||
summary: <p>An HTTPS message. An HTTPS message is distinguished from a plain IoT Hub message by its property names, which are prefixed with 'iothub-app-'; and by the explicit specification of a content-type. </p>
|
||||
syntax:
|
||||
content: public interface HttpsMessage
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_single_message
|
||||
parent: com.microsoft.azure.iothub.transport.https
|
||||
href: com.microsoft.azure.iothub.transport.https._https_single_message.yml
|
||||
name: HttpsSingleMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsSingleMessage
|
||||
type: Class
|
||||
summary: <p>A single HTTPS message. </p>
|
||||
syntax:
|
||||
content: public class HttpsSingleMessage
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_message.getBody()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_message.yml
|
||||
name: getBody()
|
||||
fullName: byte [] com.microsoft.azure.iothub.transport.https.HttpsMessage.getBody()
|
||||
type: Method
|
||||
summary: <p>Gets the message body. </p>
|
||||
syntax:
|
||||
content: public byte [] getBody()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>Returns the message body. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_message.getContentType()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_message.yml
|
||||
name: getContentType()
|
||||
fullName: String com.microsoft.azure.iothub.transport.https.HttpsMessage.getContentType()
|
||||
type: Method
|
||||
summary: <p>Gets the message content type. </p>
|
||||
syntax:
|
||||
content: public String getContentType()
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>Returns the message content-type. </p>
|
||||
- uid: com.microsoft.azure.iothub._message_property
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message_property.yml
|
||||
name: MessageProperty
|
||||
fullName: com.microsoft.azure.iothub.MessageProperty
|
||||
type: Class
|
||||
summary: <p>An IoT Hub message property. </p>
|
||||
syntax:
|
||||
content: public class MessageProperty
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_message.getProperties()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_message
|
||||
href: com.microsoft.azure.iothub.transport.https._https_message.yml
|
||||
name: getProperties()
|
||||
fullName: MessageProperty [] com.microsoft.azure.iothub.transport.https.HttpsMessage.getProperties()
|
||||
type: Method
|
||||
summary: <p>Gets the collection of message properties. </p>
|
||||
syntax:
|
||||
content: public MessageProperty [] getProperties()
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._message_propertye5b41c5f
|
||||
description: <p>Returns the message properties. </p>
|
||||
|
|
@ -0,0 +1,444 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
id: _https_connection
|
||||
parent: com.microsoft.azure.iothub.transport.https
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.body()
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.connect()
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.connection()
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.getResponseHeaders()
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.getResponseStatus()
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.HttpsConnection()
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.HttpsConnection(URL,HttpsMethod)
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.readError()
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.readInput()
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.readInputStream(InputStream)
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.setReadTimeoutMillis(int)
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.setRequestHeader(String,String)
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.setRequestMethod(HttpsMethod)
|
||||
- com.microsoft.azure.iothub.transport.https._https_connection.writeOutput(byte [])
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpsConnection
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsConnection
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 30
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>A wrapper for the Java SE class <ref refid="" kindref="compound">HttpsURLConnection</ref>. Used to avoid compatibility issues when testing with the mocking framework JMockit, as well as to avoid some undocumented side effects when using HttpsURLConnection. </p>
|
||||
|
||||
<p>The underlying <ref refid="" kindref="compound">HttpsURLConnection</ref> is transparently managed by Java. To reuse connections, for each time <xref href="com.microsoft.azure.iothub.transport.https._https_connection.connect()" data-throw-if-not-resolved="false"></xref> is called, the input streams (input stream or error stream, if input stream is not accessible) must be completely read. Otherwise, the data remains in the stream and the connection will not be reusable. </p>
|
||||
syntax:
|
||||
content: public class HttpsConnection
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.body()
|
||||
id: body()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: body
|
||||
fullName: byte [] com.microsoft.azure.iothub.transport.https.HttpsConnection.body
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 40
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>The body. <ref refid="" kindref="compound">HttpsURLConnection</ref> silently calls <xref href="com.microsoft.azure.iothub.transport.https._https_connection.connect()" data-throw-if-not-resolved="false"></xref> when the output stream is written to. We buffer the body and defer writing to the output stream until <xref href="com.microsoft.azure.iothub.transport.https._https_connection.connect()" data-throw-if-not-resolved="false"></xref> is called. </p>
|
||||
syntax:
|
||||
content: protected byte [] body
|
||||
return:
|
||||
type: ccd9418d
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.connect()
|
||||
id: connect()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: connect()
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsConnection.connect()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 77
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Sends the request to the URL given in the constructor.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o1
|
||||
content: public void connect()
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the connection could not be established, or the server responded with a bad status code. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.connection()
|
||||
id: connection()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: connection
|
||||
fullName: final HttpsURLConnection com.microsoft.azure.iothub.transport.https.HttpsConnection.connection
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 33
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>The underlying HTTPS connection. </p>
|
||||
syntax:
|
||||
content: protected final HttpsURLConnection connection
|
||||
return:
|
||||
type: 9d854a40
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.getResponseHeaders()
|
||||
id: getResponseHeaders()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: getResponseHeaders()
|
||||
fullName: Map<String, List<String>> com.microsoft.azure.iothub.transport.https.HttpsConnection.getResponseHeaders()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 249
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Returns the response headers as a <ref refid="" kindref="compound">Map</ref>, where the key is the header field name and the values are the values associated with the header field name.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public Map<String, List<String>> getResponseHeaders()
|
||||
return:
|
||||
type: b2319095
|
||||
description: <p>the response headers.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if no response was received. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.getResponseStatus()
|
||||
id: getResponseStatus()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: getResponseStatus()
|
||||
fullName: int com.microsoft.azure.iothub.transport.https.HttpsConnection.getResponseStatus()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 233
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Returns the response status code.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public int getResponseStatus()
|
||||
return:
|
||||
type: f75371fa
|
||||
description: <p>the response status code.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if no response was received. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.HttpsConnection()
|
||||
id: HttpsConnection()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpsConnection()
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsConnection.HttpsConnection()
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 287
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
syntax:
|
||||
content: protected HttpsConnection()
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.HttpsConnection(URL,HttpsMethod)
|
||||
id: HttpsConnection(URL,HttpsMethod)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpsConnection(URL url, HttpsMethod method)
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsConnection.HttpsConnection(URL url, HttpsMethod method)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 50
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Constructor. Opens a connection to the given URL.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public HttpsConnection(URL url, HttpsMethod method)
|
||||
parameters:
|
||||
- id: url
|
||||
type: a891b3e6
|
||||
description: <p>the URL for the HTTPS connection. </p>
|
||||
- id: method
|
||||
type: com.microsoft.azure.iothub.transport.https._https_method
|
||||
description: <p>the HTTPS method (i.e. GET).</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the connection could not be opened. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.readError()
|
||||
id: readError()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: readError()
|
||||
fullName: byte [] com.microsoft.azure.iothub.transport.https.HttpsConnection.readError()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 208
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Reads from the error stream and returns the error reason.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public byte [] readError()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>the error reason.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the input stream could not be accessed, for example if the server could not be reached. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.readInput()
|
||||
id: readInput()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: readInput()
|
||||
fullName: byte [] com.microsoft.azure.iothub.transport.https.HttpsConnection.readInput()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 188
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Reads from the input stream (response stream) and returns the response.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public byte [] readInput()
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>the response body.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the input stream could not be accessed, for example if the server could not be reached. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.readInputStream(InputStream)
|
||||
id: readInputStream(InputStream)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: readInputStream(InputStream stream)
|
||||
fullName: static byte [] com.microsoft.azure.iothub.transport.https.HttpsConnection.readInputStream(InputStream stream)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 265
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Reads the input stream until the stream is empty.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static byte [] readInputStream(InputStream stream)
|
||||
parameters:
|
||||
- id: stream
|
||||
type: 76fcb9b7
|
||||
description: <p>the input stream.</p>
|
||||
return:
|
||||
type: ccd9418d
|
||||
description: <p>the content of the input stream.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the input stream could not be read from. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.setReadTimeoutMillis(int)
|
||||
id: setReadTimeoutMillis(int)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: setReadTimeoutMillis(int timeout)
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsConnection.setReadTimeoutMillis(int timeout)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 143
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Sets the read timeout in milliseconds. The read timeout is the number of milliseconds after the server receives a request and before the server sends data back.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setReadTimeoutMillis(int timeout)
|
||||
parameters:
|
||||
- id: timeout
|
||||
type: f75371fa
|
||||
description: <p>the read timeout. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.setRequestHeader(String,String)
|
||||
id: setRequestHeader(String,String)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: setRequestHeader(String field, String value)
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsConnection.setRequestHeader(String field, String value)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 130
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Sets the request header field to the given value.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setRequestHeader(String field, String value)
|
||||
parameters:
|
||||
- id: field
|
||||
type: "26831127"
|
||||
description: <p>the header field name. </p>
|
||||
- id: value
|
||||
type: "26831127"
|
||||
description: <p>the header field value. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.setRequestMethod(HttpsMethod)
|
||||
id: setRequestMethod(HttpsMethod)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: setRequestMethod(HttpsMethod method)
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsConnection.setRequestMethod(HttpsMethod method)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 100
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Sets the request method (i.e. POST).</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void setRequestMethod(HttpsMethod method)
|
||||
parameters:
|
||||
- id: method
|
||||
type: com.microsoft.azure.iothub.transport.https._https_method
|
||||
description: <p>the request method.</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if the request currently has a non-empty body and the new method is not a POST or a PUT. This is because Java's <ref refid="" kindref="compound">HttpsURLConnection</ref> silently converts the HTTPS method to POST or PUT if a body is written to the request. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.writeOutput(byte [])
|
||||
id: writeOutput(byte [])
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: writeOutput(byte[] body)
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsConnection.writeOutput(byte[] body)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsConnection.java
|
||||
startLine: 159
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Saves the body to be sent with the request.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void writeOutput(byte[] body)
|
||||
parameters:
|
||||
- id: body
|
||||
type: ccd9418d
|
||||
description: <p>the request body.</p>
|
||||
exceptions:
|
||||
- type: 3c87bd19
|
||||
description: <p>if the request does not currently use method POST or PUT and the body is non-empty. This is because Java's <ref refid="" kindref="compound">HttpsURLConnection</ref> silently converts the HTTPS method to POST or PUT if a body is written to the request. </p>
|
||||
references:
|
||||
- uid: 9d854a40
|
||||
spec.java:
|
||||
- name: final HttpsURLConnection
|
||||
fullName: final HttpsURLConnection
|
||||
- uid: ccd9418d
|
||||
spec.java:
|
||||
- name: byte []
|
||||
fullName: byte []
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: a891b3e6
|
||||
spec.java:
|
||||
- name: URL
|
||||
fullName: URL
|
||||
- uid: 3c87bd19
|
||||
spec.java:
|
||||
- name: IllegalArgumentException
|
||||
fullName: IllegalArgumentException
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: f75371fa
|
||||
spec.java:
|
||||
- name: int
|
||||
fullName: int
|
||||
- uid: b2319095
|
||||
spec.java:
|
||||
- name: Map<String, List<String>>
|
||||
fullName: Map<String, List<String>>
|
||||
- uid: 76fcb9b7
|
||||
spec.java:
|
||||
- name: InputStream
|
||||
fullName: InputStream
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_connection.connect()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_connection.yml
|
||||
name: connect()
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsConnection.connect()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Sends the request to the URL given in the constructor.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o1
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_method
|
||||
parent: com.microsoft.azure.iothub.transport.https
|
||||
href: com.microsoft.azure.iothub.transport.https._https_method.yml
|
||||
name: HttpsMethod
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsMethod
|
||||
type: Enum
|
||||
summary: <p>The HTTPS request method (i.e. GET). </p>
|
||||
syntax:
|
||||
content: public enum HttpsMethod
|
||||
|
|
@ -0,0 +1,305 @@
|
|||
items:
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
id: _https_iot_hub_connection
|
||||
parent: com.microsoft.azure.iothub.transport.https
|
||||
children:
|
||||
- com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.config()
|
||||
- com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.HTTPS_CONNECTION_LOCK()
|
||||
- com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.HttpsIotHubConnection(DeviceClientConfig)
|
||||
- com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.messageEtag()
|
||||
- com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.receiveMessage()
|
||||
- com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.sanitizeEtag(String)
|
||||
- com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.sendEvent(HttpsMessage)
|
||||
- com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.sendMessageResult(IotHubMessageResult)
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpsIotHubConnection
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection
|
||||
type: Class
|
||||
source:
|
||||
remote: &o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
branch: master
|
||||
repo: https://github.com/Azure/azure-iot-sdk-java
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
startLine: 17
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>An HTTPS connection between a device and an IoT Hub. Contains functionality for synchronously connecting to the different IoT Hub resource URIs. </p>
|
||||
syntax:
|
||||
content: public class HttpsIotHubConnection
|
||||
inheritance:
|
||||
- java.lang.Object
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.config()
|
||||
id: config()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: config
|
||||
fullName: final DeviceClientConfig com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection.config
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
startLine: 23
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>The client configuration. </p>
|
||||
syntax:
|
||||
content: protected final DeviceClientConfig config
|
||||
return:
|
||||
type: 93de0ef9com.microsoft.azure.iothub._device_client_config
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.HTTPS_CONNECTION_LOCK()
|
||||
id: HTTPS_CONNECTION_LOCK()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: HTTPS_CONNECTION_LOCK
|
||||
fullName: final Object com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection.HTTPS_CONNECTION_LOCK
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
startLine: 20
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>The HTTPS connection lock. </p>
|
||||
syntax:
|
||||
content: protected static final Object HTTPS_CONNECTION_LOCK= new Object()
|
||||
return:
|
||||
type: 1b60ba29
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.HttpsIotHubConnection(DeviceClientConfig)
|
||||
id: HttpsIotHubConnection(DeviceClientConfig)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: HttpsIotHubConnection(DeviceClientConfig config)
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection.HttpsIotHubConnection(DeviceClientConfig config)
|
||||
type: Constructor
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
startLine: 37
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Constructs an instance from the given <xref href="com.microsoft.azure.iothub._device_client_config" data-throw-if-not-resolved="false"></xref> object.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public HttpsIotHubConnection(DeviceClientConfig config)
|
||||
parameters:
|
||||
- id: config
|
||||
type: com.microsoft.azure.iothub._device_client_config
|
||||
description: <p>the client configuration. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.messageEtag()
|
||||
id: messageEtag()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: messageEtag
|
||||
fullName: String com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection.messageEtag
|
||||
type: Field
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
startLine: 29
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: <p>The message e-tag. Obtained when the device receives a message and used when sending a message result back to the IoT Hub. </p>
|
||||
syntax:
|
||||
content: protected String messageEtag
|
||||
return:
|
||||
type: "26831127"
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.receiveMessage()
|
||||
id: receiveMessage()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: receiveMessage()
|
||||
fullName: Message com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection.receiveMessage()
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
startLine: 104
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Receives a message, if one exists.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: &o1
|
||||
content: public Message receiveMessage()
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._message
|
||||
description: <p>a message, or null if none exists.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the IoT Hub could not be reached. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.sanitizeEtag(String)
|
||||
id: sanitizeEtag(String)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: sanitizeEtag(String dirtyEtag)
|
||||
fullName: static String com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection.sanitizeEtag(String dirtyEtag)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
startLine: 271
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Removes double quotes from the e-tag property.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: protected static String sanitizeEtag(String dirtyEtag)
|
||||
parameters:
|
||||
- id: dirtyEtag
|
||||
type: "26831127"
|
||||
description: <p>the dirty e-tag value.</p>
|
||||
return:
|
||||
type: "26831127"
|
||||
description: <p>the e-tag value with double quotes removed. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.sendEvent(HttpsMessage)
|
||||
id: sendEvent(HttpsMessage)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: sendEvent(HttpsMessage msg)
|
||||
fullName: IotHubStatusCode com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection.sendEvent(HttpsMessage msg)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
startLine: 55
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Sends an event message.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public IotHubStatusCode sendEvent(HttpsMessage msg)
|
||||
parameters:
|
||||
- id: msg
|
||||
type: com.microsoft.azure.iothub.transport.https._https_message
|
||||
description: <p>the event message.</p>
|
||||
return:
|
||||
type: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
description: <p>the status code from sending the event message.</p>
|
||||
exceptions:
|
||||
- type: cbf33bbe
|
||||
description: <p>if the IoT Hub could not be reached. </p>
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.sendMessageResult(IotHubMessageResult)
|
||||
id: sendMessageResult(IotHubMessageResult)
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
langs:
|
||||
- java
|
||||
name: sendMessageResult(IotHubMessageResult result)
|
||||
fullName: void com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection.sendMessageResult(IotHubMessageResult result)
|
||||
type: Method
|
||||
source:
|
||||
remote: *o0
|
||||
path: device/iothub-java-client/src/main/java/com/microsoft/azure/iothub/transport/https/HttpsIotHubConnection.java
|
||||
startLine: 166
|
||||
package: com.microsoft.azure.iothub.transport.https
|
||||
summary: >-
|
||||
<p>Sends the message result for the previously received message.</p>
|
||||
|
||||
<p></p>
|
||||
syntax:
|
||||
content: public void sendMessageResult(IotHubMessageResult result)
|
||||
parameters:
|
||||
- id: result
|
||||
type: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
description: <p>the message result (one of <ref refid="" kindref="compound">IotHubMessageResult#COMPLETE</ref>, <ref refid="" kindref="compound">IotHubMessageResult#ABANDON</ref>, or <ref refid="" kindref="compound">IotHubMessageResult#REJECT</ref>).</p>
|
||||
exceptions:
|
||||
- type: 12fe80de
|
||||
description: <p>if<programlisting><codeline><highlight class="normal">sendMessageResult<sp></sp></highlight></codeline></programlisting> is called before <xref href="com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.receiveMessage()" data-throw-if-not-resolved="false"></xref> is called. </p>
|
||||
- type: cbf33bbe
|
||||
description: <p>if the IoT Hub could not be reached. </p>
|
||||
references:
|
||||
- uid: 1b60ba29
|
||||
spec.java:
|
||||
- name: final Object
|
||||
fullName: final Object
|
||||
- uid: 93de0ef9com.microsoft.azure.iothub._device_client_config
|
||||
spec.java:
|
||||
- name: 'final '
|
||||
fullName: 'final '
|
||||
- uid: com.microsoft.azure.iothub._device_client_config
|
||||
name: DeviceClientConfig
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
- uid: "26831127"
|
||||
spec.java:
|
||||
- name: String
|
||||
fullName: String
|
||||
- uid: cbf33bbe
|
||||
spec.java:
|
||||
- name: IOException
|
||||
fullName: IOException
|
||||
- uid: 12fe80de
|
||||
spec.java:
|
||||
- name: IllegalStateException
|
||||
fullName: IllegalStateException
|
||||
- uid: com.microsoft.azure.iothub._device_client_config
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._device_client_config.yml
|
||||
name: DeviceClientConfig
|
||||
fullName: com.microsoft.azure.iothub.DeviceClientConfig
|
||||
type: Class
|
||||
summary: <p>Configuration settings for an IoT Hub client. Validates all user-defined settings. </p>
|
||||
syntax:
|
||||
content: public class DeviceClientConfig
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_status_code
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_status_code.yml
|
||||
name: IotHubStatusCode
|
||||
fullName: com.microsoft.azure.iothub.IotHubStatusCode
|
||||
type: Enum
|
||||
summary: <p>An IoT Hub status code. Included in a message from an IoT Hub to a device. </p>
|
||||
syntax:
|
||||
content: public enum IotHubStatusCode
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_message
|
||||
parent: com.microsoft.azure.iothub.transport.https
|
||||
href: com.microsoft.azure.iothub.transport.https._https_message.yml
|
||||
name: HttpsMessage
|
||||
fullName: com.microsoft.azure.iothub.transport.https.HttpsMessage
|
||||
type: Interface
|
||||
summary: <p>An HTTPS message. An HTTPS message is distinguished from a plain IoT Hub message by its property names, which are prefixed with 'iothub-app-'; and by the explicit specification of a content-type. </p>
|
||||
syntax:
|
||||
content: public interface HttpsMessage
|
||||
- uid: com.microsoft.azure.iothub._message
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._message.yml
|
||||
name: Message
|
||||
fullName: com.microsoft.azure.iothub.Message
|
||||
type: Class
|
||||
syntax:
|
||||
content: public class Message
|
||||
- uid: com.microsoft.azure.iothub._iot_hub_message_result
|
||||
parent: com.microsoft.azure.iothub
|
||||
href: com.microsoft.azure.iothub._iot_hub_message_result.yml
|
||||
name: IotHubMessageResult
|
||||
fullName: com.microsoft.azure.iothub.IotHubMessageResult
|
||||
type: Enum
|
||||
summary: <p>A return value from a message callback that instructs an IoT Hub to complete, abandon, or reject the message. </p>
|
||||
syntax:
|
||||
content: public enum IotHubMessageResult
|
||||
- uid: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.receiveMessage()
|
||||
parent: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection
|
||||
href: com.microsoft.azure.iothub.transport.https._https_iot_hub_connection.yml
|
||||
name: receiveMessage()
|
||||
fullName: Message com.microsoft.azure.iothub.transport.https.HttpsIotHubConnection.receiveMessage()
|
||||
type: Method
|
||||
summary: >-
|
||||
<p>Receives a message, if one exists.</p>
|
||||
|
||||
<p></p>
|
||||
syntax: *o1
|
||||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче