azure-iot-device package

類別

Message	Message 對象用於裝置與IoT中樞服務之間的遙測（裝置到雲端）和命令（雲端到裝置）異步傳訊。 它與傳輸無關，這表示它的運作方式與AMQP、MQTT和 HTTP 相同。
Client	用來將裝置與 Azure IoT 中樞連線的 IoT 中樞裝置用戶端。 SDK 的使用者應該呼叫其中一個處理站方法，fromConnectionString 或從SharedAccessSignature 建立 IoT 中樞裝置用戶端。
DeviceMethodRequest	表示從雲端呼叫裝置方法時，從服務傳遞至裝置的數據。 這個類別的實例會傳遞至透過 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)註冊的回呼。
DeviceMethodResponse	每個 DeviceMethodRequest 都會提供 DeviceMethodResponse 對象給使用者，讓使用者針對每個裝置方法呼叫建構和傳送格式正確的回應回服務。 這個類別的實例會當做第二個參數傳遞至透過 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)註冊的回呼。
IotEdgeAuthenticationProvider	提供將令牌產生委派給iotedged的 AuthenticationProvider 實作。 搭配 Azure IoT Edge 使用模組用戶端時，本應使用此實作。 此類型繼承自 SharedAccessKeyAuthenticationProvider，在功能上與該類型相同，但除了實作 _sign 方法覆寫的令牌產生部分以外。
ModuleClient	用來將裝置與 Azure IoT 中樞連線的 IoT 中樞裝置用戶端。 SDK 的使用者應該呼叫其中一個處理站方法，fromConnectionString 或從SharedAccessSignature 建立 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 物件，X509AuthenticationProvider 不會發出 newTokenAvailable 事件，因為 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、at、cron 或 manualPolling。 這是藉由呼叫 setOptions，並將此屬性當做 receivePolicyHttpTransportOptions 物件內的屬性，這個屬性位於 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>