azure-iot-device package

類別

Message	物件 Message 用於裝置到雲端) (遙測和命令， (裝置間) 裝置與IoT 中樞服務之間的非同步傳訊。 它與傳輸無關，這表示它的運作方式與 AMQP、MQTT 和 HTTP 相同。
Client	IoT 中樞用來將裝置與 Azure IoT 中樞連線的裝置用戶端。 SDK 的使用者應該呼叫其中一個 Factory 方法，fromConnectionString或fromSharedAccessSignature來建立IoT 中樞裝置用戶端。
DeviceMethodRequest	表示從雲端呼叫裝置方法時，從服務傳遞至裝置的資料。 這個類別的實例會傳遞至透過 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void) 註冊的回呼。
DeviceMethodResponse	DeviceMethodResponse物件會提供給使用者，並 DeviceMethodRequest 讓使用者針對每個裝置方法呼叫建構和傳送格式良好的回應給服務。 這個類別的實例會當做第二個參數傳遞至透過 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void) 註冊的回呼。
IotEdgeAuthenticationProvider	提供將 AuthenticationProvider 權杖產生委派給 iotedged 的實作。 此實作是在搭配 Azure IoT Edge使用模組用戶端時使用。 此類型繼承自 SharedAccessKeyAuthenticationProvider ，且功能上與該類型相同，但實作 方法所覆寫的 _sign 權杖產生部分除外。
ModuleClient	IoT 中樞用來將裝置與 Azure IoT 中樞連線的裝置用戶端。 SDK 的使用者應該呼叫其中一個 Factory 方法，fromConnectionString或fromSharedAccessSignature來建立IoT 中樞裝置用戶端。
SharedAccessKeyAuthenticationProvider	AuthenticationProvider提供物件，只要使用連接字串即可建立，然後由裝置用戶端和傳輸使用，以向 Azure IoT 中樞實例進行驗證。 物件 SharedAccessKeyAuthenticationProvider 會負責定期建立共用存取簽章權杖，併發出 newTokenAvailable 事件，讓傳輸使用 Azure IoT 中樞實例更新其認證，並保持連線。
SharedAccessSignatureAuthenticationProvider	AuthenticationProvider提供物件，只要使用共用存取簽章即可建立，然後由裝置用戶端和傳輸使用，以向 Azure IoT 中樞實例進行驗證。 物件 SharedAccessSignatureAuthenticationProvider 不會自動更新共用存取簽章權杖，因此使用者必須使用 方法將非過期的共用存取簽章權杖摘要給它 updateSharedAccessSignature 。 針對這個方法的每個呼叫， SharedAccessSignatureAuthenticationProvider 都會發出一個 newTokenAvailable 事件，傳輸會用來向 Azure IoT 中樞實例進行驗證。
Twin	裝置對應項檔描述 Azure IoT 中樞所儲存之裝置的狀態，即使裝置離線，仍可供使用。 其建置大約 3 個區段： 標籤：索引鍵/值組只能從服務端存取 所需屬性：由服務更新，並由裝置接收 報告屬性：由裝置更新，並由服務接收。 請注意，雖然這是可能的情況，但所需和報告的屬性不需要相符，而且視需要同步處理這兩個集合的邏輯會保留給 SDK 的使用者。 如需詳細資訊，請參閱 瞭解裝置對應項。
X509AuthenticationProvider	AuthenticationProvider提供物件，只要使用 X509 憑證和金鑰即可建立，然後由裝置用戶端和傳輸使用，以向 Azure IoT 中樞實例進行驗證。 SharedAccessSignatureAuthenticationProvider不同于 和 SharedAccessKeyAuthenticationProvider 物件，不會發出 newTokenAvailable 事件， X509AuthenticationProvider 因為 X509 驗證中沒有任何涉及的權杖。 傳輸會使用 方法來取得認證 getDeviceCredentials 。

介面

AmqpTransportOptions	AMQP 傳輸特有的選項。 這會傳遞至setOptions做為DeviceClientOptions物件內名為 http 的屬性。 請參閱
DeviceClientOptions	Client 物件的選項。 傳遞至 setOptions 函式。 範例 var options = { cert: myX509Certificate, key: myX509Key, http: { receivePolicy: { interval: 10 } } } client.setOptions(options, callback);
DeviceTransport
HttpReceiverOptions	用來設定 HTTP 接收者輪詢訊息頻率的選項結構。 除了布林值之外，上述每個選項都是互斥的 drain 。 選項結構中只能有一個 interval 、 atcron 或 manualPolling 。 這是藉由呼叫setOptions做為HttpTransportOptions物件內名為 receivePolicy 的屬性來設定，該物件位於DeviceClientOptions物件內部。 請參閱
HttpTransportOptions	將選擇性組態參數傳遞至 Http Transport 的選項結構。 這會傳遞至setOptions做為DeviceClientOptions物件內名為 http 的屬性。 請參閱
MqttTransportOptions	MQTT 傳輸特有的選項 這會傳遞至setOptions做為DeviceClientOptions物件內名為 mqtt 的屬性。
TwinProperties	包含對應項所需的和報告屬性。

類型別名

BufferConvertible

函數

getUserAgentString(NoErrorCallback<string>)
getUserAgentString()
getUserAgentString(string, NoErrorCallback<string>)
getUserAgentString(string)

函式詳細資料

getUserAgentString(NoErrorCallback<string>)

function getUserAgentString(done: NoErrorCallback<string>)

參數

done

NoErrorCallback<string>

getUserAgentString()

function getUserAgentString(): Promise<string>

傳回

Promise<string>

getUserAgentString(string, NoErrorCallback<string>)

function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)

參數

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string)

function getUserAgentString(productInfo: string): Promise<string>

參數

productInfo

string

傳回

Promise<string>