87 строки
5.9 KiB
YAML
87 строки
5.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod"
|
|
name: "AuthenticationMethod"
|
|
nameWithType: "AuthenticationMethod"
|
|
summary: "Class used to abstract the different authentication methods used to use IoT Hub SDK."
|
|
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 abstract class **AuthenticationMethod**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.AuthenticationMethod()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.AuthenticationMethod()"
|
|
name: "AuthenticationMethod()"
|
|
nameWithType: "AuthenticationMethod.AuthenticationMethod()"
|
|
syntax: "public AuthenticationMethod()"
|
|
fields:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.key"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.key"
|
|
name: "key"
|
|
nameWithType: "AuthenticationMethod.key"
|
|
summary: "Shared access policy key (if applies)"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String key"
|
|
desc: "Shared access policy key (if applies)"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.policyName"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.policyName"
|
|
name: "policyName"
|
|
nameWithType: "AuthenticationMethod.policyName"
|
|
summary: "Authentication policy name"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String policyName"
|
|
desc: "Authentication policy name"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.token"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.token"
|
|
name: "token"
|
|
nameWithType: "AuthenticationMethod.token"
|
|
summary: "Shared access policy token (if applies)"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String token"
|
|
desc: "Shared access policy token (if applies)"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.populate(com.microsoft.azure.sdk.iot.service.IotHubConnectionString)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.AuthenticationMethod.populate(IotHubConnectionString iotHubConnectionStringBuilder)"
|
|
name: "populate(IotHubConnectionString iotHubConnectionStringBuilder)"
|
|
nameWithType: "AuthenticationMethod.populate(IotHubConnectionString iotHubConnectionStringBuilder)"
|
|
summary: "Abstract helper function to populate `IotHubConnectionString` class with proper authentication properties"
|
|
modifiers:
|
|
- "protected"
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The <xref uid=\"com.microsoft.azure.sdk.iot.service.IotHubConnectionString\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IotHubConnectionString\"></xref> that is\n to be populated with the authentication\n properties."
|
|
name: "iotHubConnectionStringBuilder"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.IotHubConnectionString?alt=com.microsoft.azure.sdk.iot.service.IotHubConnectionString&text=IotHubConnectionString\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected abstract IotHubConnectionString populate(IotHubConnectionString iotHubConnectionStringBuilder)"
|
|
desc: "Abstract helper function to populate `IotHubConnectionString` class with proper authentication properties"
|
|
returns:
|
|
description: "An instance of <xref uid=\"com.microsoft.azure.sdk.iot.service.IotHubConnectionString\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IotHubConnectionString\"></xref> populated with the\n the authentication properties."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.IotHubConnectionString?alt=com.microsoft.azure.sdk.iot.service.IotHubConnectionString&text=IotHubConnectionString\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Class used to abstract the different authentication methods used to use IoT Hub SDK."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.service"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0
|