Documentation

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

Api meta data More...

Static Public Member Functions

static ApiMetadata Map (IRestResponse response)
 Map an IRestResponse to an ApiMetadata object More...
 

Properties

HttpStatusCode StatusCode [get, set]
 Gets or sets HTTP Status code of the API response More...
 
string ErrorMessage [get, set]
 Gets or sets any error message returned More...
 
Dictionary< string, string > Headers [get, set]
 Gets or sets headers in the API response More...
 
DateTime Date [get, set]
 Gets or sets date of the API response More...
 
string RequestId [get, set]
 Gets or sets request ID of the transaction More...
 
string Object [get, set]
 Gets or sets object type of the returned data More...
 
object Etag [get, set]
 Gets or sets etag of the returned data More...
 
string Method [get, set]
 Gets or sets method of the API request More...
 
string Url [get, set]
 Gets or sets URL of the API request More...
 

Detailed Description

Api meta data

Member Function Documentation

static ApiMetadata MbedCloudSDK.Common.ApiMetadata.Map ( IRestResponse  response)
inlinestatic

Map an IRestResponse to an ApiMetadata object

Parameters
responseResponse
Returns
Api Metadata

Property Documentation

DateTime MbedCloudSDK.Common.ApiMetadata.Date
getset

Gets or sets date of the API response

string MbedCloudSDK.Common.ApiMetadata.ErrorMessage
getset

Gets or sets any error message returned

object MbedCloudSDK.Common.ApiMetadata.Etag
getset

Gets or sets etag of the returned data

Dictionary<string, string> MbedCloudSDK.Common.ApiMetadata.Headers
getset

Gets or sets headers in the API response

string MbedCloudSDK.Common.ApiMetadata.Method
getset

Gets or sets method of the API request

string MbedCloudSDK.Common.ApiMetadata.Object
getset

Gets or sets object type of the returned data

string MbedCloudSDK.Common.ApiMetadata.RequestId
getset

Gets or sets request ID of the transaction

HttpStatusCode MbedCloudSDK.Common.ApiMetadata.StatusCode
getset

Gets or sets HTTP Status code of the API response

string MbedCloudSDK.Common.ApiMetadata.Url
getset

Gets or sets URL of the API request


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