Interface IIvrLine

This interface exposes the main methods used to control the selected plugin.

Inherited Members

IIvrBaseLine.Management

IIvrBaseLine.LastTerminator

IIvrBaseLine.LineNumber

IIvrBaseLine.WaitRings(int)

IIvrBaseLine.WaitRingsAsync(int, CancellationToken)

IIvrBaseLine.StartIncomingListener(Func<IIvrLine, CancellationToken, Task>, IIvrLine, CancellationToken)

IIvrBaseLine.Hangup()

IIvrBaseLine.TakeOffHook()

IIvrBaseLine.Dial(string, int)

IIvrBaseLine.DialAsync(string, int, CancellationToken)

IIvrBaseLine.PlayFile(string)

IIvrBaseLine.PlayFileAsync(string, CancellationToken)

IIvrBaseLine.PlayWavStream(WavStream)

IIvrBaseLine.PlayWavStreamAsync(WavStream, CancellationToken)

IIvrBaseLine.RecordToFile(string)

IIvrBaseLine.RecordToFileAsync(string, CancellationToken)

IIvrBaseLine.RecordToFile(string, int)

IIvrBaseLine.RecordToFileAsync(string, int, CancellationToken)

IIvrBaseLine.GetDigits(int, string, int)

IIvrBaseLine.GetDigitsAsync(int, string, CancellationToken, int)

IIvrBaseLine.FlushDigitBuffer()

IIvrBaseLine.Volume

IIvrBaseLine.Reset()

IDisposable.Dispose()

IPromptMethods.Prompt(string, PromptOptions)

IPromptMethods.Prompt(ITextToSpeechCache, PromptOptions)

IPromptMethods.PromptAsync(string, CancellationToken, PromptOptions)

IPromptMethods.PromptAsync(ITextToSpeechCache, CancellationToken, PromptOptions)

IPromptMethods.MultiTryPrompt(string, Func<string, bool>, MultiTryPromptOptions)

IPromptMethods.MultiTryPrompt(ITextToSpeechCache, Func<string, bool>, MultiTryPromptOptions)

IPromptMethods.MultiTryPromptAsync(string, Func<string, bool>, CancellationToken)

IPromptMethods.MultiTryPromptAsync(ITextToSpeechCache, Func<string, bool>, CancellationToken)

IPromptMethods.MultiTryPromptAsync(string, Func<string, bool>, MultiTryPromptOptions, CancellationToken)

IPromptMethods.MultiTryPromptAsync(ITextToSpeechCache, Func<string, bool>, MultiTryPromptOptions, CancellationToken)

IPlayMethods.PlayPhoneNumber(string)

IPlayMethods.PlayPhoneNumberAsync(string, CancellationToken)

IPlayMethods.PlayDate(DateTime, string)

IPlayMethods.PlayDateAsync(DateTime, string, CancellationToken)

IPlayMethods.PlayMoney(double)

IPlayMethods.PlayMoneyAsync(double, CancellationToken)

IPlayMethods.PlayCharacters(string)

IPlayMethods.PlayCharactersAsync(string, CancellationToken)

IPlayMethods.PlayNumber(double)

IPlayMethods.PlayNumberAsync(double, CancellationToken)

IPlayMethods.PlayInteger(long)

IPlayMethods.PlayIntegerAsync(long, CancellationToken)

IPlayMethods.PlayOrdinal(int)

IPlayMethods.PlayOrdinalAsync(int, CancellationToken)

IPlayMethods.PlayString(string)

IPlayMethods.PlayStringAsync(string, CancellationToken)

IPlayMethods.PlayFileOrPhrase(string)

IPlayMethods.PlayFileOrPhraseAsync(string, CancellationToken)

IPlayMethods.PlayTextToSpeech(string)

IPlayMethods.PlayTextToSpeech(ITextToSpeechCache)

IPlayMethods.PlayTextToSpeechAsync(string, CancellationToken)

IPlayMethods.PlayTextToSpeechAsync(ITextToSpeechCache, CancellationToken)

IPlayMethods.PlayFile(ITextToSpeechCache)

IPlayMethods.PlayFileAsync(ITextToSpeechCache, CancellationToken)

Namespace: ivrToolkit.Core.Interfaces

Assembly: ivrToolkit.Core.dll

Syntax

public interface IIvrLine : IIvrBaseLine, IDisposable, IPromptMethods, IPlayMethods

Properties

Status

The Status of the line.

Declaration

LineStatusTypes Status { get; }

Property Value

Type	Description
LineStatusTypes

TextToSpeechCacheFactory

Gets the Text To Speech generator being used.

Declaration

ITextToSpeechCacheFactory TextToSpeechCacheFactory { get; }

Property Value

Type	Description
ITextToSpeechCacheFactory

Methods

CheckDispose()

Use this within long computational methods to check if the line has hung-up or stopped.

Declaration

void CheckDispose()

StartIncomingListener(Func<IIvrLine, CancellationToken, Task>, CancellationToken)

Starts an incoming call listener with a callback function.

Declaration

void StartIncomingListener(Func<IIvrLine, CancellationToken, Task> callback, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Func<IIvrLine, CancellationToken, Task>	callback	The function to execute when a call is received.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.

Extension Methods

ValidationExtensions.ThrowIfNull<T>(T, string)