Documentation

Mistake on this page? Email us
Public Member Functions | Static Public Member Functions | List of all members
MbedCloudSDK.Connect.Model.ConnectedDevice.ConnectedDevice Class Reference

Connected Device More...

Inheritance diagram for MbedCloudSDK.Connect.Model.ConnectedDevice.ConnectedDevice:
MbedCloudSDK.DeviceDirectory.Model.Device.Device Mbed.Cloud.Common.Entity Mbed.Cloud.Common.IEntity

Public Member Functions

 ConnectedDevice (IDictionary< string, object > options=null, Connect.Api.ConnectApi api=null)
 Initializes a new instance of the ConnectedDevice class. More...
 
IEnumerable< Model.Resource.ResourceListResources ()
 List resources for this device. More...
 
override string ToString ()
 Returns the string presentation of the object. More...
 
- Public Member Functions inherited from MbedCloudSDK.DeviceDirectory.Model.Device.Device
 Device ()
 Initializes a new instance of the Device class. Default constructor More...
 
 Device (DeviceDirectoryApi api)
 Initializes a new instance of the Device class. More...
 
override string ToString ()
 Returns the string presentation of the object. More...
 

Static Public Member Functions

static ConnectedDevice Map (device_directory.Model.DeviceData deviceData, Connect.Api.ConnectApi api=null)
 Map to Device object. More...
 
- Static Public Member Functions inherited from MbedCloudSDK.DeviceDirectory.Model.Device.Device
static Device Map (DeviceData deviceData, DeviceDirectoryApi api=null)
 Map to Device object. More...
 
static DeviceDataPostRequest CreatePostRequest (Device device)
 Create a device data post request More...
 
static DeviceDataPutRequest CreatePutRequest (Device device)
 Create a device data put request More...
 

Additional Inherited Members

- Properties inherited from MbedCloudSDK.DeviceDirectory.Model.Device.Device
Mechanism Mechanism [get, set]
 Gets or sets the ID of the channel used to communicate with the device More...
 
State State [get, set]
 Gets or sets the current state of the device More...
 
DeployedState DeployedState [get, set]
 Gets or sets the state of the device's deployment More...
 
DateTime BootstrappedTimestamp [get, set]
 Gets or sets gets or Sets BootstrappedTimestamp More...
 
DateTime UpdatedAt [get, set]
 Gets the time the object was updated More...
 
Dictionary< string, string > CustomAttributes [get, set]
 Gets or sets up to 5 custom JSON attributes More...
 
string DeviceClass [get, set]
 Gets or sets the device class More...
 
string Description [get, set]
 Gets or sets the description of the object More...
 
bool AutoUpdate [get, set]
 Gets or sets mark this device for auto firmware update More...
 
string ProvisionKey [get, set]
 Gets or sets the key used to provision the device More...
 
string SerialNumber [get, set]
 Gets or sets the serial number of the device More...
 
string VendorId [get, set]
 Gets or sets the device vendor ID More...
 
string AccountId [get, set]
 Gets the owning IAM account ID More...
 
string Deployment [get, set]
 Gets or sets the last deployment used on the device More...
 
string MechanismUrl [get, set]
 Gets or sets the address of the connector to use More...
 
string Name [get, set]
 Gets or sets the name of the object More...
 
DateTime CreatedAt [get, set]
 Gets the time the object was created More...
 
string Manifest [get, set]
 Gets or sets URL for the current device manifest More...
 
DateTime ManifestTimestamp [get, set]
 Gets the timestamp of the current manifest version More...
 
string CertificateFingerprint [get, set]
 Gets or sets fingerprint of the device certificate More...
 
string CertificateIssuerId [get, set]
 Gets or sets ID of the issuer of the certificate More...
 
DateTime BootstrapCertificateExpiration [get, set]
 Gets or sets expiration date of the certificate used to connect to bootstrap server More...
 
DateTime ConnectorCertificateExpiration [get, set]
 Gets or sets expiration date of the certificate used to connect to connector server More...
 
string Alias [get, set]
 Gets or sets the endpoint name given to the device More...
 
string HostGateway [get, set]
 Gets or sets the endpoint_name of the host gateway, if appropriate More...
 
int DeviceExecutionMode [get, set]
 Gets or sets defines the type of certificate used More...
 
string FirmwareChecksum [get, set]
 Gets or sets the SHA256 checksum of the current firmware image More...
 
string DeviceType [get, set]
 Gets or sets the endpoint type of the device - e.g. if the device is a gateway More...
 
DateTime ClaimedAt [get, set]
 Gets the claim date/time More...
 
- Properties inherited from Mbed.Cloud.Common.Entity
string Id [get, set]
 Gets or sets the identifier. More...
 
- Properties inherited from Mbed.Cloud.Common.IEntity
string Id [get, set]
 Gets or sets the identifier. More...
 

Detailed Description

Connected Device

Constructor & Destructor Documentation

MbedCloudSDK.Connect.Model.ConnectedDevice.ConnectedDevice.ConnectedDevice ( IDictionary< string, object >  options = null,
Connect.Api.ConnectApi  api = null 
)
inline

Initializes a new instance of the ConnectedDevice class.

Parameters
optionsDictionary containing properties.
apiConnect Api.

Member Function Documentation

IEnumerable<Model.Resource.Resource> MbedCloudSDK.Connect.Model.ConnectedDevice.ConnectedDevice.ListResources ( )
inline

List resources for this device.

Returns
List of resources
static ConnectedDevice MbedCloudSDK.Connect.Model.ConnectedDevice.ConnectedDevice.Map ( device_directory.Model.DeviceData  deviceData,
Connect.Api.ConnectApi  api = null 
)
inlinestatic

Map to Device object.

\

Parameters
deviceDataDevice response object.
apioptional DeviceDirectoryApi.
Returns
Connected device
override string MbedCloudSDK.Connect.Model.ConnectedDevice.ConnectedDevice.ToString ( )

Returns the string presentation of the object.

Returns
String presentation of the object.

The documentation for this class was generated from the following file: