Class ArasHeaders

Headers to send with each request to Aras

Inheritance

System.Object

ArasHeaders

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Innovator.Client

Assembly: Innovator.Client.dll

Syntax

public class ArasHeaders : IDictionary<string, string>, ICollection<KeyValuePair<string, string>>, IEnumerable<KeyValuePair<string, string>>, IEnumerable

Properties

| Improve this Doc View Source

Count

Gets the number of headers contained in the ArasHeaders.

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

Implements

System.Collections.Generic.ICollection<T>.Count

| Improve this Doc View Source

IsReadOnly

Returns false to indicate that the collection is editable

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean

Implements

System.Collections.Generic.ICollection<T>.IsReadOnly

| Improve this Doc View Source

Item[String]

Gets or sets the header with the specified name.

Declaration

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

Parameters

Type	Name	Description
System.String	key	The name of the header.

Property Value

Type	Description
System.String	The header value.

Implements

System.Collections.Generic.IDictionary<TKey, TValue>.Item[TKey]

| Improve this Doc View Source

Keys

Gets an System.Collections.Generic.ICollection<T> containing the keys of the ArasHeaders.

Declaration

public ICollection<string> Keys { get; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.String>

Implements

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

| Improve this Doc View Source

Locale

Locale to use when logging in

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

TimeZone

Time zone to use with each request

Declaration

public string TimeZone { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

UserAgent

User agent string to send with each request

Declaration

public string UserAgent { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Values

Gets an System.Collections.Generic.ICollection<T> containing the values of the ArasHeaders.

Declaration

public ICollection<string> Values { get; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.String>

Implements

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

Methods

| Improve this Doc View Source

Add(String, String)

Adds a header with the provided name and value to the ArasHeaders.

Declaration

public void Add(string key, string value)

Parameters

Type	Name	Description
System.String	key	The header name.
System.String	value	The header value.

Implements

System.Collections.Generic.IDictionary<TKey, TValue>.Add(TKey, TValue)

Exceptions

Type	Condition
System.ArgumentException

| Improve this Doc View Source

Clear()

Removes all headers from the ArasHeaders.

Declaration

public void Clear()

Implements

System.Collections.Generic.ICollection<T>.Clear()

| Improve this Doc View Source

ContainsKey(String)

Determines whether the System.Collections.Generic.IDictionary<TKey, TValue> contains an element with the specified key.

Declaration

public bool ContainsKey(string key)

Parameters

Type	Name	Description
System.String	key	The key to locate in the System.Collections.Generic.IDictionary<TKey, TValue>.

Returns

Type	Description
System.Boolean	true if the System.Collections.Generic.IDictionary<TKey, TValue> contains an element with the key; otherwise, false.

Implements

System.Collections.Generic.IDictionary<TKey, TValue>.ContainsKey(TKey)

| Improve this Doc View Source

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

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

Returns

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

Implements

System.Collections.Generic.IEnumerable<T>.GetEnumerator()

| Improve this Doc View Source

Remove(String)

Removes the element with the specified key from the System.Collections.Generic.IDictionary<TKey, TValue>.

Declaration

public bool Remove(string key)

Parameters

Type	Name	Description
System.String	key	The key of the element to remove.

Returns

Type	Description
System.Boolean	true if the element is successfully removed; otherwise, false. This method also returns false if `key` was not found in the original System.Collections.Generic.IDictionary<TKey, TValue>.

Implements

System.Collections.Generic.IDictionary<TKey, TValue>.Remove(TKey)

| Improve this Doc View Source

TryGetValue(String, out String)

Gets the value associated with the specified key.

Declaration

public bool TryGetValue(string key, out string value)

Parameters

Type	Name	Description
System.String	key	The key whose value to get.
System.String	value	When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the `value` parameter. This parameter is passed uninitialized.

Returns

Type	Description
System.Boolean	true if the object that implements System.Collections.Generic.IDictionary<TKey, TValue> contains an element with the specified key; otherwise, false.

Implements

System.Collections.Generic.IDictionary<TKey, TValue>.TryGetValue(TKey, TValue)

Explicit Interface Implementations

| Improve this Doc View Source

ICollection<KeyValuePair<String, String>>.Add(KeyValuePair<String, String>)

Declaration

void ICollection<KeyValuePair<string, string>>.Add(KeyValuePair<string, string> item)

Parameters

Type	Name	Description
System.Collections.Generic.KeyValuePair<System.String, System.String>	item

Implements

System.Collections.Generic.ICollection<T>.Add(T)

| Improve this Doc View Source

ICollection<KeyValuePair<String, String>>.Contains(KeyValuePair<String, String>)

Declaration

bool ICollection<KeyValuePair<string, string>>.Contains(KeyValuePair<string, string> item)

Parameters

Type	Name	Description
System.Collections.Generic.KeyValuePair<System.String, System.String>	item

Returns

Type	Description
System.Boolean

Implements

System.Collections.Generic.ICollection<T>.Contains(T)

| Improve this Doc View Source

ICollection<KeyValuePair<String, String>>.CopyTo(KeyValuePair<String, String>[], Int32)

Declaration

void ICollection<KeyValuePair<string, string>>.CopyTo(KeyValuePair<string, string>[] array, int arrayIndex)

Parameters

Type	Name	Description
System.Collections.Generic.KeyValuePair<System.String, System.String>[]	array
System.Int32	arrayIndex

Implements

System.Collections.Generic.ICollection<T>.CopyTo(T[], System.Int32)

| Improve this Doc View Source

ICollection<KeyValuePair<String, String>>.Remove(KeyValuePair<String, String>)

Declaration

bool ICollection<KeyValuePair<string, string>>.Remove(KeyValuePair<string, string> item)

Parameters

Type	Name	Description
System.Collections.Generic.KeyValuePair<System.String, System.String>	item

Returns

Type	Description
System.Boolean

Implements

System.Collections.Generic.ICollection<T>.Remove(T)

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

Implements

System.Collections.IEnumerable.GetEnumerator()

Extension Methods

Extensions.GroupConcat<T>(IEnumerable<T>, String, Func<T, String>)