Documentation

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

Resource. More...

Inheritance diagram for MbedCloudSDK.Connect.Model.Resource.Resource:
Mbed.Cloud.Common.Entity Mbed.Cloud.Common.IEntity

Public Member Functions

 Resource (string deviceId, ConnectApi api=null)
 Initializes a new instance of the Resource class. Initializes new Resource. More...
 
string GetResourceValue ()
 Gets the value of the resource. More...
 
string SetResourceValue (string resourceValue)
 Set value of the resource. More...
 
async Task< ResourceSubscribe ()
 Subscribe to this resource. More...
 
void Unsubscribe ()
 Unsubscribe this resource. More...
 
override string ToString ()
 Returns the string presentation of the object. More...
 

Static Public Member Functions

static Resource Map (string deviceId, mds.Model.Resource res, ConnectApi api)
 Map to Resource object. More...
 

Properties

string DeviceId [get]
 Gets ID of the device this resource belongs to. More...
 
string Type [get]
 Gets resource&#39;s type More...
 
string ContentType [get]
 Gets the content type of the resource. You are encouraged to use the resource types listed in the LWM2M specification: http://technical.openmobilealliance.org/Technical/technical-information/omna/lightweight-m2m-lwm2m-object-registry More...
 
string Path [get]
 Gets resource URL. More...
 
bool Observable [get]
 Gets observable determines whether you can subscribe to changes for this resource. More...
 
AsyncCollection< string > NotificationQueue [get, set]
 Gets or sets the NotificationQueue values. 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

Resource.

Constructor & Destructor Documentation

MbedCloudSDK.Connect.Model.Resource.Resource.Resource ( string  deviceId,
ConnectApi  api = null 
)
inline

Initializes a new instance of the Resource class. Initializes new Resource.

Parameters
deviceIdId of the device that the resource belongs to.
apiDeviceDirectory API.

Member Function Documentation

string MbedCloudSDK.Connect.Model.Resource.Resource.GetResourceValue ( )
inline

Gets the value of the resource.

Returns
Resource value
static Resource MbedCloudSDK.Connect.Model.Resource.Resource.Map ( string  deviceId,
mds.Model.Resource  res,
ConnectApi  api 
)
inlinestatic

Map to Resource object.

Parameters
deviceIdId of the devi
resresource
apiApi
Returns
Resource
string MbedCloudSDK.Connect.Model.Resource.Resource.SetResourceValue ( string  resourceValue)
inline

Set value of the resource.

Parameters
resourceValueValue to set.
Returns
Async consumer with string
async Task<Resource> MbedCloudSDK.Connect.Model.Resource.Resource.Subscribe ( )
inline

Subscribe to this resource.

Returns
Async consumer with string
override string MbedCloudSDK.Connect.Model.Resource.Resource.ToString ( )

Returns the string presentation of the object.

Returns
String presentation of the object.
void MbedCloudSDK.Connect.Model.Resource.Resource.Unsubscribe ( )
inline

Unsubscribe this resource.

Property Documentation

string MbedCloudSDK.Connect.Model.Resource.Resource.ContentType
get

Gets the content type of the resource. You are encouraged to use the resource types listed in the LWM2M specification: http://technical.openmobilealliance.org/Technical/technical-information/omna/lightweight-m2m-lwm2m-object-registry

string MbedCloudSDK.Connect.Model.Resource.Resource.DeviceId
get

Gets ID of the device this resource belongs to.

AsyncCollection<string> MbedCloudSDK.Connect.Model.Resource.Resource.NotificationQueue
getset

Gets or sets the NotificationQueue values.

bool MbedCloudSDK.Connect.Model.Resource.Resource.Observable
get

Gets observable determines whether you can subscribe to changes for this resource.

string MbedCloudSDK.Connect.Model.Resource.Resource.Path
get

Gets resource URL.

Resource&#39;s url.

string MbedCloudSDK.Connect.Model.Resource.Resource.Type
get

Gets resource&#39;s type


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