Click or drag to resize
LoginAction Properties

The LoginAction type exposes the following members.

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
You can use this as a simple authentication mechanism.
Rather than have to login with a username & password, you can specify a ProxyKey that must be passed from a client before requests are processed.
This is helpful in situations where you would like to authenticate and execute an action in a single step.
(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