asternet/Asterisk.2013/Asterisk.NET/Manager/Originate.cs

202 lines
5.7 KiB
C#
Raw Normal View History

using System.Collections.Generic;
2014-01-08 14:16:39 +00:00
namespace AsterNET.Manager
{
2018-09-02 18:35:20 +00:00
/// <summary>
/// Originates an outbound call and connects it to a specified extension or application.<br/>
/// It will block until the outgoing call fails or gets answered.<br/>
/// At that point, it will exit with the status variable set and dialplan processing will continue.
/// </summary>
2015-01-03 15:37:29 +00:00
public class Originate
{
private string account;
private string application;
private string callerId;
private string channel;
private string context;
private string data;
private string exten;
private int priority;
private long timeout;
private Dictionary<string, string> variables;
#region Account
/// <summary>
2018-09-02 18:35:20 +00:00
/// Get/Set the account code to use for the originated call.<br/>
/// The account code is included in the call detail record generated for this call and will be used for billing.
2015-01-03 15:37:29 +00:00
/// </summary>
public string Account
{
get { return account; }
set { this.account = value; }
}
#endregion
#region CallerId
/// <summary>
/// Get/Set the caller id to set on the outgoing channel.
/// </summary>
public string CallerId
{
get { return callerId; }
set { this.callerId = value; }
}
#endregion
#region Channel
/// <summary>
/// Get/Set the name of the channel to connect to the outgoing call.
/// This property is required.
/// </summary>
public string Channel
{
get { return channel; }
set { this.channel = value; }
}
#endregion
#region Context
/// <summary>
2018-09-02 18:35:20 +00:00
/// Get/Set the name of the context of the extension to connect to.<br/>
2015-01-03 15:37:29 +00:00
/// If you set the context you also have to set the exten and priority properties.
/// </summary>
public string Context
{
get { return context; }
set { this.context = value; }
}
#endregion
#region Exten
/// <summary>
2018-09-02 18:35:20 +00:00
/// Get/Set the extension to connect to.<br/>
2015-01-03 15:37:29 +00:00
/// If you set the extension you also have to set the context and priority properties.
/// </summary>
public string Exten
{
get { return exten; }
set { this.exten = value; }
}
#endregion
#region Priority
/// <summary>
2018-09-02 18:35:20 +00:00
/// Get/Set the priority of the extension to connect to.<br/>
/// If you set the priority you also have to set the context and exten properties.
2015-01-03 15:37:29 +00:00
/// </summary>
public int Priority
{
get { return priority; }
set { this.priority = value; }
}
#endregion
#region Application
/// <summary>
/// Get/Set the name of the application to connect to.
/// </summary>
public string Application
{
get { return application; }
set { this.application = value; }
}
#endregion
#region Data
/// <summary>
/// Get/Set the parameters to pass to the application.
/// </summary>
public string Data
{
get { return data; }
set { this.data = value; }
}
#endregion
#region Timeout
/// <summary>
/// Get/Set the timeout for the origination (in seconds) for the origination.<br />
2018-09-02 18:35:20 +00:00
/// The channel must be answered within this time, otherwise the origination is considered to have failed and an OriginateFailureEvent is generated.<br />
2015-01-03 15:37:29 +00:00
/// If not set, a default value of 30 seconds.
/// </summary>
public long Timeout
{
get { return timeout/1000; }
set { this.timeout = value*1000; }
}
#endregion
#region GetVariables()
/// <summary>
/// Get the variables dictionary to set on the originated call.
/// </summary>
public Dictionary<string, string> GetVariables()
{
return variables;
}
#endregion
#region SetVariables(IDictionary vars)
/// <summary>
/// Set the variables dictionary to set on the originated call.
/// </summary>
public void SetVariables(Dictionary<string, string> vars)
{
this.variables = vars;
}
#endregion
#region GetVariable(string name, string val)
/// <summary>
/// Gets a variable on the originated call. Replaces any existing variable with the same name.
/// </summary>
public string GetVariable(string key)
{
if (variables == null)
return string.Empty;
return variables[key];
}
#endregion
#region SetVariable(string name, string val)
/// <summary>
/// Sets a variable dictionary on the originated call. Replaces any existing variable with the same name.
/// </summary>
public void SetVariable(string key, string value)
{
if (variables == null)
variables = new Dictionary<string, string>();
if (variables.ContainsKey(key))
variables[key] = value;
else
variables.Add(key, value);
}
#endregion
}
}