Pulse.Pulse Class Reference

Public Member Functions
def	DeletePulse (self, name)
def	GetPulseInfo (self, name)
def	GetPulseInfos (self, names=None)
def	GetPulseInfoSettings (self, name)
def	GetPulseInfoSettingsList (self, names=None)
def	GetPulseNames (self)
def	GetPulseSettings (self, name)
def	GetPulseSettingsList (self, names=None)
def	SavePulseInfo (self, info)
def	SavePulseSettings (self, settings)

Detailed Description

    Class used by DeadlineCon to send Pulse requests. 
    Stores the address of the Web Service for use in sending requests.

Member Function Documentation

DeletePulse()

def Pulse.Pulse.DeletePulse	(		self,
			name
	)

 Deletes the Pulse instance associated with the name provided.
    Input: name: The Pulse name to delete.
    Returns: Success message.

GetPulseInfo()

def Pulse.Pulse.GetPulseInfo	(		self,
			name
	)

 Gets a Pulse info.
    Input: name: The Pulse name.
    Returns: The Pulse info.

GetPulseInfos()

def Pulse.Pulse.GetPulseInfos	(		self,
			names = None
	)

 Gets a list of Pulse infos.
    Input: name: The Pulse names to be retrieved. If None then gets all Pulse infos.
    Returns: The Pulse infos.

GetPulseInfoSettings()

def Pulse.Pulse.GetPulseInfoSettings	(		self,
			name
	)

 Gets a Pulse info settings.
    Input: name: The Pulse name.
    Returns: The Pulse info settings.

GetPulseInfoSettingsList()

def Pulse.Pulse.GetPulseInfoSettingsList	(		self,
			names = None
	)

 Gets a list of Pulse info settings.
    Input: name: The Pulse names to be retrieved. If None then gets all Pulse info settings.
    Returns: The Pulse info settings.

GetPulseNames()

def Pulse.Pulse.GetPulseNames

(

self

)

 Gets all the Pulse names.
    Returns: The list of Pulse names.

GetPulseSettings()

def Pulse.Pulse.GetPulseSettings	(		self,
			name
	)

 Gets a Pulse settings.
    Input: name: The Pulse name.
    Returns: The Pulse settings.

GetPulseSettingsList()

def Pulse.Pulse.GetPulseSettingsList	(		self,
			names = None
	)

 Gets a list of Pulse settings.
    Input: name: The Pulse names to be retrieved. If None then gets all Pulse settings.
    Returns: The Pulse settings.

SavePulseInfo()

def Pulse.Pulse.SavePulseInfo	(		self,
			info
	)

 Saves a Pulse info to the database.
    Input: info: Json object of the Pulse info.
    Returns: Success message.

SavePulseSettings()

def Pulse.Pulse.SavePulseSettings	(		self,
			settings
	)

 Saves a Pulse settings to the database.
    Input: settings: Json object of the Pulse settings.
    Returns: Success message.