CoreTweet  2.0.0-beta.2
Yet another .NET Twitter Library
Public Member Functions | Public Attributes | Properties | List of all members
CoreTweet.Core.DictionaryResponse< TKey, TValue > Class Template Reference

The collection of response. More...

Inheritance diagram for CoreTweet.Core.DictionaryResponse< TKey, TValue >:
CoreTweet.Core.ITwitterResponse

Public Member Functions

 DictionaryResponse (Dictionary< TKey, TValue > dictionary)
 Initializes a new instance of the CoreTweet.Core.DictionaryResponse<TKey, TValue> class with a specified dictionary. More...
 
 DictionaryResponse (Dictionary< TKey, TValue > dictionary, RateLimit rateLimit, string json)
 Initializes a new instance of the CoreTweet.Core.DictionaryResponse<TKey, TValue> class with a specified dictionary and rate limit. More...
 
bool ContainsKey (TKey key)
 Determines whether the read-only dictionary contains an element that has the specified key. More...
 
bool TryGetValue (TKey key, out TValue value)
 Gets the value that is associated with the specified key. More...
 
IEnumerator< KeyValuePair< TKey, TValue > > GetEnumerator ()
 Returns an enumerator that iterates through a collection. More...
 

Public Attributes

IEnumerable< TKey > Keys => this.innerDictionary.Keys
 Gets an enumerable collection that contains the keys in the read-only dictionary. More...
 
IEnumerable< TValue > Values => this.innerDictionary.Values
 Gets an enumerable collection that contains the values in the read-only dictionary. More...
 
TValue this[TKey key] => this.innerDictionary[key]
 Gets the element that has the specified key in the read-only dictionary. More...
 
int Count => this.innerDictionary.Count
 Gets the number of elements in the collection. More...
 

Properties

RateLimit RateLimit [get, set]
 Gets or sets the rate limit of the response. More...
 
string Json [get, set]
 Gets or sets the JSON of the response. More...
 
- Properties inherited from CoreTweet.Core.ITwitterResponse
RateLimit RateLimit [get, set]
 Gets or sets the rate limit of the response. More...
 
string Json [get, set]
 Gets or sets the JSON of the response. More...
 

Detailed Description

The collection of response.

Template Parameters
TKeyThe type of the keys in the dictionary.
TValueThe type of the values in the dictionary.

Constructor & Destructor Documentation

◆ DictionaryResponse() [1/2]

CoreTweet.Core.DictionaryResponse< TKey, TValue >.DictionaryResponse ( Dictionary< TKey, TValue >  dictionary)
inline

Initializes a new instance of the CoreTweet.Core.DictionaryResponse<TKey, TValue> class with a specified dictionary.

Parameters
dictionaryThe dictionary whose elements are copied to the new CoreTweet.Core.DictionaryResponse<TKey, TValue>.

◆ DictionaryResponse() [2/2]

CoreTweet.Core.DictionaryResponse< TKey, TValue >.DictionaryResponse ( Dictionary< TKey, TValue >  dictionary,
RateLimit  rateLimit,
string  json 
)
inline

Initializes a new instance of the CoreTweet.Core.DictionaryResponse<TKey, TValue> class with a specified dictionary and rate limit.

Parameters
dictionaryThe dictionary whose elements are copied to the new CoreTweet.Core.DictionaryResponse<TKey, TValue>.
rateLimitThe rate limit.
jsonThe JSON.

Member Function Documentation

◆ ContainsKey()

bool CoreTweet.Core.DictionaryResponse< TKey, TValue >.ContainsKey ( TKey  key)

Determines whether the read-only dictionary contains an element that has the specified key.

Parameters
keyThe key to locate.
Returns
true if the read-only dictionary contains an element that has the specified key; otherwise, false.

◆ GetEnumerator()

IEnumerator<KeyValuePair<TKey, TValue> > CoreTweet.Core.DictionaryResponse< TKey, TValue >.GetEnumerator ( )

Returns an enumerator that iterates through a collection.

Returns
An IEnumerator object that can be used to iterate through the collection.

◆ TryGetValue()

bool CoreTweet.Core.DictionaryResponse< TKey, TValue >.TryGetValue ( TKey  key,
out TValue  value 
)

Gets the value that is associated with the specified key.

Parameters
keyThe key to locate.
valueWhen 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
true if the CoreTweet.Core.DictionaryResponse<TKey, TValue> contains an element that has the specified key; otherwise, false.

Member Data Documentation

◆ Count

int CoreTweet.Core.DictionaryResponse< TKey, TValue >.Count => this.innerDictionary.Count

Gets the number of elements in the collection.

The number of elements in the collection.

◆ Keys

IEnumerable<TKey> CoreTweet.Core.DictionaryResponse< TKey, TValue >.Keys => this.innerDictionary.Keys

Gets an enumerable collection that contains the keys in the read-only dictionary.

An enumerable collection that contains the keys in the read-only dictionary.

◆ this[TKey key]

TValue CoreTweet.Core.DictionaryResponse< TKey, TValue >.this[TKey key] => this.innerDictionary[key]

Gets the element that has the specified key in the read-only dictionary.

Parameters
keyThe key to locate.
Returns
The element that has the specified key in the read-only dictionary.

◆ Values

IEnumerable<TValue> CoreTweet.Core.DictionaryResponse< TKey, TValue >.Values => this.innerDictionary.Values

Gets an enumerable collection that contains the values in the read-only dictionary.

An enumerable collection that contains the values in the read-only dictionary.

Property Documentation

◆ Json

string CoreTweet.Core.DictionaryResponse< TKey, TValue >.Json
getset

Gets or sets the JSON of the response.

◆ RateLimit

Gets or sets the rate limit of the response.


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