C# Class SteamKit2.WebAPI.Interface

Represents a single interface that exists within the Web API. This is a dynamic object that allows function calls to interfaces with minimal code.

Inheritance: System.Dynamic.DynamicObject, IDisposable

Show file Open project: Top-Cat/SteamBot

Public Methods

Method	Description
Call ( string func, int version = 1, string>.Dictionary args = null, string method = WebRequestMethods.Http.Get, bool secure = false ) : KeyValue	Manually calls the specified Web API function with the provided details.
Dispose ( ) : void	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
TryInvokeMember ( InvokeMemberBinder binder, object args, object &result ) : bool	Provides the implementation for operations that invoke a member. Classes derived from the T:System.Dynamic.DynamicObject class can override this method to specify dynamic behavior for operations such as calling a method. This method should not be called directly, it is called through dynamic method calls.

Private Methods

Method	Description
Interface ( string iface, string apiKey ) : System

Method Details

Call() public method

Manually calls the specified Web API function with the provided details.

The function name or request method provided were null. An network error occurred when performing the request. An error occured when parsing the response from the WebAPI.

public Call ( string func, int version = 1, string>.Dictionary args = null, string method = WebRequestMethods.Http.Get, bool secure = false ) : KeyValue
func	string	The function name to call.
version	int	The version of the function to call.
args	string>.Dictionary	A dictionary of string key value pairs representing arguments to be passed to the API.
method	string	The http request method. Either "POST" or "GET".
secure	bool	if set to true this method will be called through the secure API.
return	KeyValue

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public Dispose ( ) : void
return	void

TryInvokeMember() public method

Provides the implementation for operations that invoke a member. Classes derived from the T:System.Dynamic.DynamicObject class can override this method to specify dynamic behavior for operations such as calling a method. This method should not be called directly, it is called through dynamic method calls.

/// Dynamic method is called with non-named argument. /// All parameters must be passed as name arguments to API calls. /// - or - /// The dynamic method name was not in the correct format. /// All API function calls must be in the format 'FunctionName###' where the optional ###'s represent a version number. /// /// The reserved named parameter 'secure' was not a boolean value. /// This parameter is used when requests must go through the secure API. /// /// The function version number specified was out of range. ///

public TryInvokeMember ( InvokeMemberBinder binder, object args, object &result ) : bool
binder	System.Dynamic.InvokeMemberBinder	/// Provides information about the dynamic operation. /// The binder.Name property provides the name of the member on which the dynamic operation is performed. /// For example, for the statement sampleObject.SampleMethod(100), where sampleObject is an instance of the /// class derived from the class, binder.Name returns "SampleMethod". /// The binder.IgnoreCase property specifies whether the member name is case-sensitive. ///
args	object	/// The arguments that are passed to the object member during the invoke operation. For example, /// for the statement sampleObject.SampleMethod(100), where sampleObject is derived from the /// class, the first argument to is equal to 100. ///
result	object	The result of the member invocation.
return	bool