asternet/Asterisk.2013/Asterisk.NET/FastAGI/Command/WaitForDigitCommand.cs
2014-01-08 14:16:39 +00:00

45 lines
1.3 KiB
C#

namespace AsterNET.FastAGI.Command
{
/// <summary>
/// Waits up to 'timeout' milliseconds for channel to receive a DTMF digit.<br/>
/// Returns -1 on channel failure, 0 if no digit is received in the timeout, or
/// the numerical value of the ascii of the digit if one is received. Use -1 for
/// the timeout value if you desire the call to block indefinitely.
/// </summary>
public class WaitForDigitCommand : AGICommand
{
/// <summary> The milliseconds to wait for the channel to receive a DTMF digit.</summary>
private long timeout;
/// <summary>
/// Get/Set the milliseconds to wait for the channel to receive a DTMF digit.
/// </summary>
public long Timeout
{
get { return timeout; }
set { this.timeout = value; }
}
/// <summary>
/// Creates a new WaitForDigitCommand with a default timeout of -1 which blocks the channel indefinitely.
/// </summary>
public WaitForDigitCommand()
{
this.timeout = - 1;
}
/// <summary>
/// Creates a new WaitForDigitCommand.
/// </summary>
/// <param name="timeout">the milliseconds to wait for the channel to receive a DTMF digit.</param>
public WaitForDigitCommand(int timeout)
{
this.timeout = timeout;
}
public override string BuildCommand()
{
return "WAIT FOR DIGIT " + timeout.ToString();
}
}
}