-
Notifications
You must be signed in to change notification settings - Fork 221
/
com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.yml
119 lines (119 loc) · 8.15 KB
/
com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken"
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken"
name: "IotHubSasToken"
nameWithType: "IotHubSasToken"
summary: "Grants device access to an IoT Hub for the specified amount of time."
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 final class **IotHubSasToken**"
constructors:
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.IotHubSasToken()"
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.IotHubSasToken()"
name: "IotHubSasToken()"
nameWithType: "IotHubSasToken.IotHubSasToken()"
modifiers:
- "protected"
syntax: "protected IotHubSasToken()"
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.IotHubSasToken(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,long)"
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.IotHubSasToken(String hostname, String deviceId, String deviceKey, String sharedAccessToken, String moduleId, long expiryTime)"
name: "IotHubSasToken(String hostname, String deviceId, String deviceKey, String sharedAccessToken, String moduleId, long expiryTime)"
nameWithType: "IotHubSasToken.IotHubSasToken(String hostname, String deviceId, String deviceKey, String sharedAccessToken, String moduleId, long expiryTime)"
summary: "Constructor."
parameters:
- description: "the hostname of the hub the token is for"
name: "hostname"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The id of the device the token is for"
name: "deviceId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The device key for connecting the device to the hub with. May be null if sharedAccessToken is not."
name: "deviceKey"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The sas token for connecting the device to the hub with. May be null if deviceKey is not."
name: "sharedAccessToken"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the module id. May be null if the sas token is not for a module"
name: "moduleId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the time, as a UNIX timestamp, after which the token will become invalid"
name: "expiryTime"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "public IotHubSasToken(String hostname, String deviceId, String deviceKey, String sharedAccessToken, String moduleId, long expiryTime)"
desc: "Constructor. Generates a SAS token that grants access to an IoT Hub for the specified amount of time."
methods:
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.buildSharedAccessToken(java.lang.String,java.lang.String,long)"
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.buildSharedAccessToken(String audience, String signature, long expiry)"
name: "buildSharedAccessToken(String audience, String signature, long expiry)"
nameWithType: "IotHubSasToken.buildSharedAccessToken(String audience, String signature, long expiry)"
summary: "Creates a shared access token from the provided audience, signature and expiry time"
modifiers:
- "static"
parameters:
- description: "the audience of the token"
name: "audience"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "the signature of the token"
name: "signature"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "when the token will expire, in seconds since the epoch"
name: "expiry"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static String buildSharedAccessToken(String audience, String signature, long expiry)"
desc: "Creates a shared access token from the provided audience, signature and expiry time"
returns:
description: "the shared access token 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.device.auth.IotHubSasToken.getSasToken()"
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.getSasToken()"
name: "getSasToken()"
nameWithType: "IotHubSasToken.getSasToken()"
syntax: "public String getSasToken()"
returns:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.isExpired(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.isExpired(String sasToken)"
name: "isExpired(String sasToken)"
nameWithType: "IotHubSasToken.isExpired(String sasToken)"
summary: "Returns if the provided sas<wbr>Token has expired yet or not"
modifiers:
- "static"
parameters:
- description: "the token to check for expiration"
name: "sasToken"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static boolean isExpired(String sasToken)"
desc: "Returns if the provided sasToken has expired yet or not"
returns:
description: "a boolean true if the SasToken is still valid,\n or false if it is expired."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.toString()"
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubSasToken.toString()"
name: "toString()"
nameWithType: "IotHubSasToken.toString()"
summary: "Returns the string representation of the SAS token."
overridden: "java.lang.Object.toString()"
syntax: "public String toString()"
desc: "Returns the string representation of the SAS token."
returns:
description: "the string representation of the SAS token."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Grants device access to an IoT Hub for the specified amount of time."
metadata: {}
package: "com.microsoft.azure.sdk.iot.device.auth"
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1