org.asteriskjava.fastagi.command

Class SendImageCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.SendImageCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class SendImageCommand
extends AbstractAgiCommand

AGI Command: SEND IMAGE

Sends the given image on a channel.
Most channels do not support the transmission of images.
Returns 0 if image is sent, or if the channel does not support image transmission. Returns -1 only on error/hangup.
Image names should not include extensions.

See: AGI Command SEND IMAGE (Asterisk 18)

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendImageCommand(String image) Creates a new SendImageCommand.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getImage() Returns the image to send.
void	setImage(String image) Sets the image to send.

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

SendImageCommand

public SendImageCommand(String image)

Creates a new SendImageCommand.

Parameters:

image - the image to send, should not include extension.

Method Detail

getImage

public String getImage()

Returns the image to send.

Returns:

the image to send.

setImage

public void setImage(String image)

Sets the image to send.

Parameters:

image - the image to send, should not include extension.

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.