Class Attributes

This class represents current attributes of a resource. It provides API to manage attributes. This class is accessed by using a constructor to create a new instance of this object.

Inheritance

Object

Attributes

Implements

IDictionary<String, Object>

ICollection<KeyValuePair<String, Object>>

IEnumerable<KeyValuePair<String, Object>>

IEnumerable

IDisposable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Tizen.Network.IoTConnectivity

Assembly: Tizen.Network.IoTConnectivity.dll

Syntax

public class Attributes : IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable, IDisposable

Constructors

Attributes()

The Attributes constructor.

Declaration

public Attributes()

API Version

3

Feature

http://tizen.org/feature/iot.ocf

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes();

Exceptions

Type	Condition
NotSupportedException	Thrown when the iotcon is not supported.
OutOfMemoryException	Thrown when there is not enough memory.

Properties

Count

Gets the number of keys.

Declaration

public int Count { get; }

Property Value

Type	Description
Int32	The number of keys.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
    attributes.Add("brightness", 50);
    var count = attributes.Count;
    Console.WriteLine("There are {0} keys in the attribute object", count);

IsReadOnly

Represents whether an attribute is readonly.

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
Boolean	Whether an attribute is readonly.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" },
        { "dim", 10 }
    };
    if (attributes.IsReadOnly)
        Console.WriteLine("Read only attribute");

Item[String]

Gets or sets the attribute with the specified key.

Declaration

public object this[string key] { get; set; }

Parameters

Type	Name	Description
String	key	The key of the attribute to get or set.

Property Value

Type	Description
Object	The attribute with the specified key.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes();
    attributes["state"] = "ON";
    Console.WriteLine("Attribute value for key 'state' : {0}", attributes["state"]);

Keys

Contains all the attribute keys.

Declaration

public ICollection<string> Keys { get; }

Property Value

Type	Description
ICollection<String>	All the attribute keys.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" },
        { "dim", 10 }
    };
    var keys = attributes.Keys;
    Console.WriteLine("Attribute contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1));

Values

Contains all the attribute values.

Declaration

public ICollection<object> Values { get; }

Property Value

Type	Description
ICollection<Object>	All the attribute values.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" },
        { "dim", 10 }
    };
    var values = attributes.Values;
    Console.WriteLine("Attribute contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1));

Methods

Add(KeyValuePair<String, Object>)

Adds the attribute key and a value as a key value pair.

Declaration

public void Add(KeyValuePair<string, object> item)

Parameters

Type	Name	Description
KeyValuePair<String, Object>	item	The key value pair to add.

API Version

3

Feature

http://tizen.org/feature/iot.ocf

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes();
    attributes.Add(new KeyValuePair<string, object> ("state", "ON"));

Add(String, Object)

Adds an attribute.

Declaration

public void Add(string key, object value)

Parameters

Type	Name	Description
String	key	The key representing the attribute.
Object	value	The value representing the attribute.

API Version

3

Feature

http://tizen.org/feature/iot.ocf

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes();
    attributes.Add("brightness", 50);

Clear()

Clears attributes collection.

Declaration

public void Clear()

API Version

3

Feature

http://tizen.org/feature/iot.ocf

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes();
    attributes.Add("brightness", 50);
    attributes.Clear();

Exceptions

Type	Condition
NotSupportedException	Thrown when the iotcon is not supported
InvalidOperationException	Thrown when the operation is invalid

Contains(KeyValuePair<String, Object>)

Checks whether the given key value pair exists in attributes collection.

Declaration

public bool Contains(KeyValuePair<string, object> item)

Parameters

Type	Name	Description
KeyValuePair<String, Object>	item	The status key value pair.

Returns

Type	Description
Boolean	true if exists. Otherwise, false.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" },
        { "dim", 10 }
    };
    if (attributes.Contains(new KeyValuePair<string, object> ("dim", 10))
        Console.WriteLine("Attribute conatins pair ('dim', 10)");

ContainsKey(String)

Checks whether the given key exists in attributes collection.

Declaration

public bool ContainsKey(string key)

Parameters

Type	Name	Description
String	key	The status key to look for.

Returns

Type	Description
Boolean	true if exists. Otherwise, false.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" },
        { "dim", 10 }
    };
    if (attributes.ContainsKey("dim"))
        Console.WriteLine("Attribute conatins key : dim");

CopyTo(KeyValuePair<String, Object>[], Int32)

Copies the elements of the attributes to an array, starting at a particular index.

Declaration

public void CopyTo(KeyValuePair<string, object>[] array, int arrayIndex)

Parameters

Type	Name	Description
KeyValuePair<String, Object>[]	array	The destination array.
Int32	arrayIndex	The zero-based index in an array at which copying begins.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" },
        { "dim", 10 }
    };
    KeyValuePair<string, object>[] dest = new KeyValuePair<string, object>[attributes.Count];
    int index = 0;
    attributes.CopyTo(dest, index);
    Console.WriteLine("Dest conatins ({0}, {1})", dest[0].Key, dest[0].Value);

Dispose()

Releases any unmanaged resources used by this object.

Declaration

public void Dispose()

API Version

3

Feature

http://tizen.org/feature/iot.ocf

Dispose(Boolean)

Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
Boolean	disposing	If true, disposes any disposable objects. If false, does not dispose disposable objects.

API Version

3

Feature

http://tizen.org/feature/iot.ocf

Finalize()

Destructor of the Attributes class.

Declaration

protected void Finalize()

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<KeyValuePair<string, object>> GetEnumerator()

Returns

Type	Description
IEnumerator<KeyValuePair<String, Object>>	An enumerator that can be used to iterate through the collection.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" },
        { "dim", 10 }
    };
    foreach (KeyValuePair<string, object> pair in attributes)
    {
        Console.WriteLine("key : {0}, value : {1}", pair.Key, pair.Value);
    }

Remove(KeyValuePair<String, Object>)

Removes an attribute from collection.

Declaration

public bool Remove(KeyValuePair<string, object> item)

Parameters

Type	Name	Description
KeyValuePair<String, Object>	item	The attributes element to remove.

Returns

Type	Description
Boolean	true if operation is successful, otherwise, false.

API Version

3

Feature

http://tizen.org/feature/iot.ocf

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" },
        { "dim", 10 }
    };
    if (attributes.Remove(new KeyValuePair<string, object>("dim", 10)))
        Console.WriteLine("Remove was successful");

Exceptions

Type	Condition
NotSupportedException	Thrown when the iotcon is not supported
ArgumentException	Thrown when there is an invalid parameter
InvalidOperationException	Thrown when the operation is invalid

Remove(String)

Removes an attribute from collection using a key.

Declaration

public bool Remove(string key)

Parameters

Type	Name	Description
String	key	The attributes element to remove.

Returns

Type	Description
Boolean	true if operation is successful, otherwise, false.

API Version

3

Feature

http://tizen.org/feature/iot.ocf

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" },
        { "dim", 10 }
    };
    if (attributes.Remove("state"))
        Console.WriteLine("Remove was successful");

Exceptions

Type	Condition
NotSupportedException	Thrown when the iotcon is not supported
ArgumentException	Thrown when there is an invalid parameter
InvalidOperationException	Thrown when the operation is invalid

TryGetValue(String, out Object)

Gets the value associated with the specified key.

Declaration

public bool TryGetValue(string key, out object value)

Parameters

Type	Name	Description
String	key	The key whose value to get.
Object	value	The value associated with the specified key.

Returns

Type	Description
Boolean	true if the attributes collection contains an element with the specified key, otherwise, false.

API Version

3

Examples

    Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
        { "state", "ON" }
    };
    object value;
    var isPresent = attributes.TryGetValue("state", out value);
    if (isPresent)
        Console.WriteLine("value : {0}", value);

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

API Version

3

Implements

System.Collections.Generic.IDictionary<TKey,TValue>

System.Collections.Generic.ICollection<T>

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable

System.IDisposable