358 строки
22 KiB
YAML
358 строки
22 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.service.BaseDevice"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice"
|
|
name: "BaseDevice"
|
|
nameWithType: "BaseDevice"
|
|
summary: "The Base<wbr>Device class implementing constructors and serialization functionality."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **BaseDevice**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.BaseDevice(java.lang.String,com.microsoft.azure.sdk.iot.service.auth.AuthenticationType)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.BaseDevice(String deviceId, AuthenticationType authenticationType)"
|
|
name: "BaseDevice(String deviceId, AuthenticationType authenticationType)"
|
|
nameWithType: "BaseDevice.BaseDevice(String deviceId, AuthenticationType authenticationType)"
|
|
summary: "Create an Base<wbr>Device instance using the given device name with the given authentication<wbr>Type"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "Name of the device (used as device id)"
|
|
name: "deviceId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- The type of authentication used by this device."
|
|
name: "authenticationType"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.auth.AuthenticationType?alt=com.microsoft.azure.sdk.iot.service.auth.AuthenticationType&text=AuthenticationType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected BaseDevice(String deviceId, AuthenticationType authenticationType)"
|
|
desc: "Create an BaseDevice instance using the given device name with the given authenticationType"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.BaseDevice(java.lang.String,com.microsoft.azure.sdk.iot.service.auth.SymmetricKey)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.BaseDevice(String deviceId, SymmetricKey symmetricKey)"
|
|
name: "BaseDevice(String deviceId, SymmetricKey symmetricKey)"
|
|
nameWithType: "BaseDevice.BaseDevice(String deviceId, SymmetricKey symmetricKey)"
|
|
summary: "Create an Base<wbr>Device instance using the given device name"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "Name of the device (used as device id)"
|
|
name: "deviceId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- Device key. If parameter is null, then the key will be auto generated."
|
|
name: "symmetricKey"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.auth.SymmetricKey?alt=com.microsoft.azure.sdk.iot.service.auth.SymmetricKey&text=SymmetricKey\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected BaseDevice(String deviceId, SymmetricKey symmetricKey)"
|
|
exceptions:
|
|
- description: "if deviceId is null"
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Create an BaseDevice instance using the given device name"
|
|
fields:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.OFFSET_TIME_DEFAULT"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.OFFSET_TIME_DEFAULT"
|
|
name: "OFFSET_TIME_DEFAULT"
|
|
nameWithType: "BaseDevice.OFFSET_TIME_DEFAULT"
|
|
modifiers:
|
|
- "protected"
|
|
- "final"
|
|
field:
|
|
value: "0001-01-01T00:00:00-00:00"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected final String OFFSET_TIME_DEFAULT"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.UTC_TIME_DEFAULT"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.UTC_TIME_DEFAULT"
|
|
name: "UTC_TIME_DEFAULT"
|
|
nameWithType: "BaseDevice.UTC_TIME_DEFAULT"
|
|
modifiers:
|
|
- "protected"
|
|
- "final"
|
|
field:
|
|
value: "0001-01-01T00:00:00"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected final String UTC_TIME_DEFAULT"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.cloudToDeviceMessageCount"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.cloudToDeviceMessageCount"
|
|
name: "cloudToDeviceMessageCount"
|
|
nameWithType: "BaseDevice.cloudToDeviceMessageCount"
|
|
summary: "Number of messages received by the device"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected long cloudToDeviceMessageCount"
|
|
desc: "Number of messages received by the device"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.connectionState"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.connectionState"
|
|
name: "connectionState"
|
|
nameWithType: "BaseDevice.connectionState"
|
|
summary: "Status of the device: \\{\"connected\" | \"disconnected\"\\}"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.DeviceConnectionState?alt=com.microsoft.azure.sdk.iot.service.DeviceConnectionState&text=DeviceConnectionState\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected DeviceConnectionState connectionState"
|
|
desc: "Status of the device: \\{\"connected\" | \"disconnected\"\\}"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.connectionStateUpdatedTime"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.connectionStateUpdatedTime"
|
|
name: "connectionStateUpdatedTime"
|
|
nameWithType: "BaseDevice.connectionStateUpdatedTime"
|
|
summary: "Datetime of last time the connection state was updated."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String connectionStateUpdatedTime"
|
|
desc: "Datetime of last time the connection state was updated."
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.deviceId"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.deviceId"
|
|
name: "deviceId"
|
|
nameWithType: "BaseDevice.deviceId"
|
|
summary: "Device name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + \\{'-', ':', '.', '+', '%', '\\_', '\\#', '\\*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''\\}."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String deviceId"
|
|
desc: "Device name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + \\{'-', ':', '.', '+', '%', '\\_', '\\#', '\\*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''\\}."
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.eTag"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.eTag"
|
|
name: "eTag"
|
|
nameWithType: "BaseDevice.eTag"
|
|
summary: "A string representing a weak ETAG version of this JSON description."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String eTag"
|
|
desc: "A string representing a weak ETAG version of this JSON description. This is a hash."
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.generationId"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.generationId"
|
|
name: "generationId"
|
|
nameWithType: "BaseDevice.generationId"
|
|
summary: "Device generation Id"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String generationId"
|
|
desc: "Device generation Id"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.lastActivityTime"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.lastActivityTime"
|
|
name: "lastActivityTime"
|
|
nameWithType: "BaseDevice.lastActivityTime"
|
|
summary: "Datetime of last time the device authenticated, received, or sent a message."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String lastActivityTime"
|
|
desc: "Datetime of last time the device authenticated, received, or sent a message."
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getAuthenticationType()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getAuthenticationType()"
|
|
name: "getAuthenticationType()"
|
|
nameWithType: "BaseDevice.getAuthenticationType()"
|
|
summary: "Getter for the authentication type of this device"
|
|
syntax: "public AuthenticationType getAuthenticationType()"
|
|
desc: "Getter for the authentication type of this device"
|
|
returns:
|
|
description: "the authentication type"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.auth.AuthenticationType?alt=com.microsoft.azure.sdk.iot.service.auth.AuthenticationType&text=AuthenticationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getCloudToDeviceMessageCount()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getCloudToDeviceMessageCount()"
|
|
name: "getCloudToDeviceMessageCount()"
|
|
nameWithType: "BaseDevice.getCloudToDeviceMessageCount()"
|
|
summary: "Getter for cloud to device message count"
|
|
syntax: "public long getCloudToDeviceMessageCount()"
|
|
desc: "Getter for cloud to device message count"
|
|
returns:
|
|
description: "The string containing the time when the cloudToDeviceMessageCount parameter was updated"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getConnectionState()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getConnectionState()"
|
|
name: "getConnectionState()"
|
|
nameWithType: "BaseDevice.getConnectionState()"
|
|
summary: "Getter for connection state"
|
|
syntax: "public DeviceConnectionState getConnectionState()"
|
|
desc: "Getter for connection state"
|
|
returns:
|
|
description: "The connectionState string"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.DeviceConnectionState?alt=com.microsoft.azure.sdk.iot.service.DeviceConnectionState&text=DeviceConnectionState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getConnectionStateUpdatedTime()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getConnectionStateUpdatedTime()"
|
|
name: "getConnectionStateUpdatedTime()"
|
|
nameWithType: "BaseDevice.getConnectionStateUpdatedTime()"
|
|
summary: "Getter for connection state updated time"
|
|
syntax: "public String getConnectionStateUpdatedTime()"
|
|
desc: "Getter for connection state updated time"
|
|
returns:
|
|
description: "The string containing the time when the connectionState parameter was updated"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getDeviceId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getDeviceId()"
|
|
name: "getDeviceId()"
|
|
nameWithType: "BaseDevice.getDeviceId()"
|
|
summary: "Getter for device name"
|
|
syntax: "public String getDeviceId()"
|
|
desc: "Getter for device name"
|
|
returns:
|
|
description: "The deviceId string"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getGenerationId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getGenerationId()"
|
|
name: "getGenerationId()"
|
|
nameWithType: "BaseDevice.getGenerationId()"
|
|
summary: "Getter for Generation<wbr>Id"
|
|
syntax: "public String getGenerationId()"
|
|
desc: "Getter for GenerationId"
|
|
returns:
|
|
description: "The generationId string"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getLastActivityTime()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getLastActivityTime()"
|
|
name: "getLastActivityTime()"
|
|
nameWithType: "BaseDevice.getLastActivityTime()"
|
|
summary: "Getter for last activity time"
|
|
syntax: "public String getLastActivityTime()"
|
|
desc: "Getter for last activity time"
|
|
returns:
|
|
description: "The string containing the time when the lastActivity parameter was updated"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getPrimaryKey()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getPrimaryKey()"
|
|
name: "getPrimaryKey()"
|
|
nameWithType: "BaseDevice.getPrimaryKey()"
|
|
summary: "Getter for Primary<wbr>Key part of the Symmetric<wbr>Key"
|
|
syntax: "public String getPrimaryKey()"
|
|
desc: "Getter for PrimaryKey part of the SymmetricKey"
|
|
returns:
|
|
description: "The primaryKey string"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getPrimaryThumbprint()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getPrimaryThumbprint()"
|
|
name: "getPrimaryThumbprint()"
|
|
nameWithType: "BaseDevice.getPrimaryThumbprint()"
|
|
summary: "Getter for primary thumbprint part of the whole thumbprint"
|
|
syntax: "public String getPrimaryThumbprint()"
|
|
desc: "Getter for primary thumbprint part of the whole thumbprint"
|
|
returns:
|
|
description: "The primary thumbprint string"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getSecondaryKey()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getSecondaryKey()"
|
|
name: "getSecondaryKey()"
|
|
nameWithType: "BaseDevice.getSecondaryKey()"
|
|
summary: "Getter for Secondary<wbr>Key part of the Symmetric<wbr>Key"
|
|
syntax: "public String getSecondaryKey()"
|
|
desc: "Getter for SecondaryKey part of the SymmetricKey"
|
|
returns:
|
|
description: "The secondaryKey string"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getSecondaryThumbprint()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getSecondaryThumbprint()"
|
|
name: "getSecondaryThumbprint()"
|
|
nameWithType: "BaseDevice.getSecondaryThumbprint()"
|
|
summary: "Getter for secondary thumbprint part of the whole thumbprint"
|
|
syntax: "public String getSecondaryThumbprint()"
|
|
desc: "Getter for secondary thumbprint part of the whole thumbprint"
|
|
returns:
|
|
description: "The secondary thumbprint string"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.getSymmetricKey()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.getSymmetricKey()"
|
|
name: "getSymmetricKey()"
|
|
nameWithType: "BaseDevice.getSymmetricKey()"
|
|
summary: "Getter for Symmetric<wbr>Key object"
|
|
syntax: "public SymmetricKey getSymmetricKey()"
|
|
desc: "Getter for SymmetricKey object"
|
|
returns:
|
|
description: "The symmetricKey object"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.auth.SymmetricKey?alt=com.microsoft.azure.sdk.iot.service.auth.SymmetricKey&text=SymmetricKey\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.geteTag()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.geteTag()"
|
|
name: "geteTag()"
|
|
nameWithType: "BaseDevice.geteTag()"
|
|
summary: "Getter for e<wbr>Tag"
|
|
syntax: "public String geteTag()"
|
|
desc: "Getter for eTag"
|
|
returns:
|
|
description: "The eTag string"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.setForceUpdate(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.setForceUpdate(Boolean forceUpdate)"
|
|
name: "setForceUpdate(Boolean forceUpdate)"
|
|
nameWithType: "BaseDevice.setForceUpdate(Boolean forceUpdate)"
|
|
summary: "Setter for force update boolean"
|
|
deprecatedTag: "This method currently only validates force<wbr>Update parameter"
|
|
parameters:
|
|
- description: "- Boolean controlling if the update should be forced or not"
|
|
name: "forceUpdate"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "</br>public void setForceUpdate(Boolean forceUpdate)"
|
|
exceptions:
|
|
- description: "if the provided argument is null"
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Setter for force update boolean"
|
|
hasDeprecatedTag: true
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.setSymmetricKey(com.microsoft.azure.sdk.iot.service.auth.SymmetricKey)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.setSymmetricKey(SymmetricKey symmetricKey)"
|
|
name: "setSymmetricKey(SymmetricKey symmetricKey)"
|
|
nameWithType: "BaseDevice.setSymmetricKey(SymmetricKey symmetricKey)"
|
|
summary: "Setter for Symmetric<wbr>Key object"
|
|
parameters:
|
|
- description: "symmetricKey to be set"
|
|
name: "symmetricKey"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.auth.SymmetricKey?alt=com.microsoft.azure.sdk.iot.service.auth.SymmetricKey&text=SymmetricKey\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setSymmetricKey(SymmetricKey symmetricKey)"
|
|
exceptions:
|
|
- description: "if the provided symmetric key is null"
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Setter for SymmetricKey object"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.setThumbprint(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.setThumbprint(String primaryThumbprint, String secondaryThumbprint)"
|
|
name: "setThumbprint(String primaryThumbprint, String secondaryThumbprint)"
|
|
nameWithType: "BaseDevice.setThumbprint(String primaryThumbprint, String secondaryThumbprint)"
|
|
summary: "Setter for X509 thumbprint"
|
|
deprecatedTag: "as of service-client version 1.15.1, please use <xref uid=\"com.microsoft.azure.sdk.iot.service.BaseDevice.setThumbprintFinal(java.lang.String,java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setThumbprintFinal(String, String)\"></xref>"
|
|
parameters:
|
|
- description: "the primary thumbprint to set"
|
|
name: "primaryThumbprint"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the secondary thumbprint to set"
|
|
name: "secondaryThumbprint"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "</br>public void setThumbprint(String primaryThumbprint, String secondaryThumbprint)"
|
|
desc: "Setter for X509 thumbprint"
|
|
hasDeprecatedTag: true
|
|
- uid: "com.microsoft.azure.sdk.iot.service.BaseDevice.setThumbprintFinal(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.BaseDevice.setThumbprintFinal(String primaryThumbprint, String secondaryThumbprint)"
|
|
name: "setThumbprintFinal(String primaryThumbprint, String secondaryThumbprint)"
|
|
nameWithType: "BaseDevice.setThumbprintFinal(String primaryThumbprint, String secondaryThumbprint)"
|
|
summary: "Setter for X509 thumbprint"
|
|
modifiers:
|
|
- "final"
|
|
parameters:
|
|
- description: "the primary thumbprint to set"
|
|
name: "primaryThumbprint"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the secondary thumbprint to set"
|
|
name: "secondaryThumbprint"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public final void setThumbprintFinal(String primaryThumbprint, String secondaryThumbprint)"
|
|
desc: "Setter for X509 thumbprint"
|
|
type: "class"
|
|
desc: "The BaseDevice class implementing constructors and serialization functionality."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.service"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0
|