wiki:PloneSMS/PloneSMSCommunicator/Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html

Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator

Package Products :: Package PloneSMSCommunicator :: Module PloneSMSCommunicator :: Class PloneSMSCommunicator

Type PloneSMSCommunicator

BaseFolder --+
             |
            PloneSMSCommunicator


A not-so-basic Folder implementation, with Dublin Core Metadata included


Method Summary
  __init__(self)
  __call__(self)
Invokes the default view.
  getAvailableSMSPolicies(self)
return sms policies
  getLogs(self, size)
Parameters:
  getProperties(self, ids)
return all properties if ids == None, else return properties that in ids list
  getServerInfo(self, server_url)
Parameters:
  inheritedAttribute(class, name)
Get an attribute that would be inherited if the given (extension) class did not define it.
  LOG(self, INFO, data)
Parameters:
  Response(self, REQUEST)
write all data from response to xiam.log file
  Schema(self)
Return a (wrapped) schema instance for this object instance.
  send_Request(self, originator, destination, body)
Parameters:
  setProperties(self, **properties)
Parameters:
  write_sms(self, sms_id, request, response)
Parameters:

Class Variable Summary
tuple __ac_permissions__ = (('Modify portal content', ('getRaw...
str __call__ = '<Not Accessible>'
str __delattr__ = '<Not Accessible>'
str __getattr__ = '<Not Accessible>'
tuple __implements__ = (<Interface Products.CMFCore.interfaces...
str __setattr__ = '<Not Accessible>'
NoneType allowedContentTypes__roles__ = None                                                                  
str archetype_name = 'PloneSMSCommunicator'
NoneType contentIds__roles__ = None                                                                  
NoneType contentItems__roles__ = None                                                                  
NoneType contentValues__roles__ = None                                                                  
NoneType decodeFolderFilter__roles__ = None                                                                  
str description = ''
NoneType encodeFolderFilter__roles__ = None                                                                  
str id = 'portal_smsCommunicator'
NoneType index_html = None                                                                  
tuple manage_options = ({'action': 'manage_main', 'help': ('OF...
str meta_type = 'PloneSMSCommunicator'
tuple meta_types = ()
str portal_type = 'PloneSMSCommunicator'

Method Details

getAvailableSMSPolicies(self)

return sms policies

getLogs(self, size)

return records from log file

Parameters:

  • size: number of needed records

getProperties(self, ids=[])

return all properties if ids == None, else return properties that in ids list

getServerInfo(self, server_url)

return dictionary that contains host name and ip address

Parameters:

  • server_url: url address of server

LOG(self, INFO, data)

write all needed data to log file

Parameters:

  • INFO: this is the parameter that defines priority of log data
  • data: all needed data to write

Response(self, REQUEST=None)

write all data from response to xiam.log file

Schema(self)

Return a (wrapped) schema instance for this object instance.

send_Request(self, originator, destination, body)

This function will send message to destination.

Parameters:

  • originator: contains phone number of message originator
  • destination: contains phone number of destination
  • body: this is the text of your message

setProperties(self, **properties)

set PloneSMSCommunicator properties

Parameters:

-**properties: this is the dictionary that contains pair(property_name: value)

write_sms(self, sms_id, request=None, response=None)

write sms 'in' and sms 'out' files to sms directory

Parameters:

  • sms_id: id of your short message
  • request: this is the data that was sent
  • response: this is the data that was received from server

Class Variable Details

__ac_permissions__

Type:
tuple
Value:
(('Modify portal content',
  ('getRawContributors',
   'getRawCreators',
   'getRawEffectiveDate',
   'setExpirationDate',
   'getRawId',
   'setLanguage',
   'getRawTitle',
...                                                                    

__delattr__

Type:
str
Value:
'<Not Accessible>'                                                     

__getattr__

Type:
str
Value:
'<Not Accessible>'                                                     

__setattr__

Type:
str
Value:
'<Not Accessible>'                                                     

archetype_name

Type:
str
Value:
'PloneSMSCommunicator'                                                 

id

Type:
str
Value:
'portal_smsCommunicator'                                               

meta_type

Type:
str
Value:
'PloneSMSCommunicator'                                                 

meta_types

Type:
tuple
Value:
()                                                                     

portal_type

Type:
str
Value:
'PloneSMSCommunicator'                                                 

Generated by Epydoc 2.1 on Fri Dec 23 14:45:44 2005 http://epydoc.sf.net
Last modified 18 years ago Last modified on Dec 23, 2005 2:55:37 PM