Click or drag to resize
LoginAction Class
The LoginAction authenticates the connection.
A successful login is the precondition for sending any other action except for the ChallengeAction.
An unsuccessful login results in an ManagerError being received from the server with a message set to "Authentication failed" and the socket being closed by Asterisk.
Inheritance Hierarchy

Namespace: AsterNET.Manager.Action
Assembly: AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class LoginAction : ManagerAction

The LoginAction type exposes the following members.

Constructors
  NameDescription
Public methodLoginAction
Creates a new empty LoginAction.
Public methodLoginAction(String, String)
Creates a new LoginAction that performs a cleartext login.
You should not use cleartext login if you are concerned about security and login with a password hash instead.
Public methodLoginAction(String, String, String)
Creates a new LoginAction that performs a login via challenge/response.
Public methodLoginAction(String, String, String, String)
Creates a new LoginAction that performs a login via challenge/response.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString (Inherited from ManagerAction.)
Top
Properties
  NameDescription
Public propertyAction
Get the name of this action, i.e. "Login".
(Overrides ManagerActionAction.)
Public propertyActionId (Inherited from ManagerAction.)
Public propertyAuthType
Get/Set the digest alogrithm when using challenge/response.
The digest algorithm is used to create the key based on the challenge and the user's password.
Currently Asterisk supports only "MD5".
Public propertyEvents
Get/Set the event mask.
Set to "on" if all events should be send, "off" if not events should be sent or a combination of "system", "call" and "log" (separated by ',') to specify what kind of events should be sent.
Public propertyKey
Get/Set the key.
Public propertyProxyKey (Inherited from ManagerAction.)
Public propertySecret
Get/Set the secret to use when using cleartext login.
The secret contains the user's password as configured in Asterisk's manager.conf.
The secret and key properties are mutually exclusive.
Public propertyServer
Specify a server to which to send your commands (x.x.x.x or hostname).
This should match the server name specified in your config file's "host" entry. If you do not specify a server, the proxy will pick the first one it finds -- fine in single-server configurations.
(Inherited from ManagerAction.)
Public propertyUsername
Get/Set the username as configured in asterik's manager.conf.
Top
See Also