org.asteriskjava.manager.action

Class SkypeBuddiesAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.SkypeBuddiesAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction

public class SkypeBuddiesAction
extends AbstractManagerAction
implements EventGeneratingAction

The SkypeBuddiesAction retrieves the buddy list of a Skype for Asterisk user including the full name and status of each buddy.

For each agent a SkypeBuddyEntryEvent is generated. After the full buddy list has been reported a SkypeBuddyListCompleteEvent is generated.

Available with Skype for Asterisk.

Since:

1.0.0

See Also:

SkypeBuddyEntryEvent, SkypeBuddyListCompleteEvent, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SkypeBuddiesAction() Creates a new SkypeBuddiesAction.
SkypeBuddiesAction(String user) Creates a new SkypeBuddiesAction that retrieves the buddy list for the given user.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
Class<? extends ResponseEvent>	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.
String	getUser() Returns the Skype username of the user to retrieve the buddy list for.
void	setUser(String user) Sets the Skype username of the user to retrieve the buddy list for.

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction

getActionId, setActionId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.asteriskjava.manager.action.ManagerAction

getActionId, setActionId

Constructor Detail

SkypeBuddiesAction

public SkypeBuddiesAction()

Creates a new SkypeBuddiesAction.

SkypeBuddiesAction

public SkypeBuddiesAction(String user)

Creates a new SkypeBuddiesAction that retrieves the buddy list for the given user.

Parameters:

user - the Skype username of the user to retrieve the buddy list for.

Method Detail

getUser

public String getUser()

Returns the Skype username of the user to retrieve the buddy list for.

This property is mandatory.

Returns:

the Skype username of the user to retrieve the buddy list for.

setUser

public void setUser(String user)

Sets the Skype username of the user to retrieve the buddy list for.

Parameters:

user - the Skype username of the user to retrieve the buddy list for.

getAction

public String getAction()

Returns the name of this action, i.e. "SkypeBuddies".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getActionCompleteEventClass

public Class<? extends ResponseEvent> getActionCompleteEventClass()

Description copied from interface: EventGeneratingAction

Returns the event type that indicates that Asterisk is finished sending response events for this action.

Specified by:

getActionCompleteEventClass in interface EventGeneratingAction

Returns:

a Class that is an instance of ResponseEvent.

See Also:

ResponseEvent