SetVarAction Class

SetVarAction Class

The SetVar action sets the value of a channel variable for a given channel.

Inheritance Hierarchy

SystemObject
AsterNET.Manager.ActionManagerAction
AsterNET.Manager.ActionSetVarAction

Namespace: AsterNET.Manager.Action
Assembly: AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public class SetVarAction : ManagerAction

Public Class SetVarAction
	Inherits ManagerAction

public ref class SetVarAction : public ManagerAction

type SetVarAction =  
    class
        inherit ManagerAction
    end

The SetVarAction type exposes the following members.

Constructors

	Name	Description
	SetVarAction	Creates a new empty SetVarAction.
	SetVarAction(String, String)	Creates a new SetVarAction that sets the given global variable to a new value.
	SetVarAction(String, String, String)	Creates a new SetVarAction that sets the given channel variable of the given channel to a new value.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	(Inherited from ManagerAction.)

Fields

	Name	Description
	channel	The channel on which to set the variable.
	varName	The name of the variable to set.
	varValue	The value to store.

Properties

	Name	Description
	Action	Get the name of this action, i.e. "SetVar". (Overrides ManagerActionAction.)
	ActionId	(Inherited from ManagerAction.)
	Channel	Get/Set the name of the channel.
	ProxyKey	You can use this as a simple authentication mechanism. Rather than have to login with a username & password, you can specify a ProxyKey that must be passed from a client before requests are processed. This is helpful in situations where you would like to authenticate and execute an action in a single step. (Inherited from ManagerAction.)
	Server	Specify a server to which to send your commands (x.x.x.x or hostname). This should match the server name specified in your config file's "host" entry. If you do not specify a server, the proxy will pick the first one it finds -- fine in single-server configurations. (Inherited from ManagerAction.)
	Value	Get/Set the value to store.
	Variable	Get/Set the name of the variable to set.