org.asteriskjava.fastagi.command

Class SetMusicOnCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.SetMusicOnCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class SetMusicOnCommand
extends AbstractAgiCommand

Turns on music on hold on the current channel.

Always returns 0.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetMusicOnCommand() Creates a new SetMusicOnCommand playing music from the default music on hold class.
SetMusicOnCommand(String musicOnHoldClass) Creates a new SetMusicOnCommand playing music from the default music on hold class.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getMusicOnHoldClass() Returns the music on hold class to play music from.
void	setMusicOnHoldClass(String musicOnHoldClass) Sets the music on hold class to play music from.

Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand

escapeAndQuote, escapeAndQuote, setAsteriskVersion, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SetMusicOnCommand

public SetMusicOnCommand()

Creates a new SetMusicOnCommand playing music from the default music on hold class.

SetMusicOnCommand

public SetMusicOnCommand(String musicOnHoldClass)

Creates a new SetMusicOnCommand playing music from the default music on hold class.

Parameters:

musicOnHoldClass - the music on hold class to play music from.

Method Detail

getMusicOnHoldClass

public String getMusicOnHoldClass()

Returns the music on hold class to play music from.

Returns:

the music on hold class to play music from or null for the default class.

setMusicOnHoldClass

public void setMusicOnHoldClass(String musicOnHoldClass)

Sets the music on hold class to play music from.

Parameters:

musicOnHoldClass - the music on hold class to play music from or null for the default class.

buildCommand

public String buildCommand()

Description copied from interface: AgiCommand

Returns a string suitable to be sent to asterisk.

Specified by:

buildCommand in interface AgiCommand

Specified by:

buildCommand in class AbstractAgiCommand

Returns:

a string suitable to be sent to asterisk.