Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Service_DeveloperGarden_ConferenceCall Class Reference

Public Member Functions

 createConference ($ownerId, Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail $conferenceDetails, Zend_Service_DeveloperGarden_ConferenceCall_ConferenceSchedule $conferenceSchedule=null, $account=null)
 creates a new conference, ownerId should be between 3 and 39 chars
 
 commitConference ($conferenceId)
 commits the given conference
 
 updateConference ($conferenceId, $ownerId=null, Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail $conferenceDetails=null, Zend_Service_DeveloperGarden_ConferenceCall_ConferenceSchedule $conferenceSchedule=null, $account=null)
 updates a conference with the given parameter
 
 getConferenceStatus ($conferenceId, $what=0)
 get conference status details
 
 getRunningConference ($conferenceId)
 returns the conferenceId of the running conference instance for a planned recurring conference or the current conferenceId
 
 removeConference ($conferenceId)
 remove a conference
 
 getConferenceList ($what=0, $ownerId=null)
 returns a list of conferences
 
 newParticipant ($conferenceId, Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail $participant)
 adds a new participant to the given conference
 
 getParticipantStatus ($conferenceId, $participantId)
 fetches the participant details for the given conferenceId
 
 removeParticipant ($conferenceId, $participantId)
 removes the given participant from the conference
 
 updateParticipant ($conferenceId, $participantId, $action=null, Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail $participant=null)
 updates the participant in the given conference
 
 createConferenceTemplate ($ownerId, Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail $conferenceDetails, array $participants=null)
 creates a new conference template
 
 getConferenceTemplate ($templateId)
 get a specific template
 
 updateConferenceTemplate ($templateId, $initiatorId=null, Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail $conferenceDetails=null)
 updates a conference template
 
 removeConferenceTemplate ($templateId)
 remove a conference template
 
 getConferenceTemplateList ($ownerId)
 lists all available conference templates for the given owner
 
 addConferenceTemplateParticipant ($templateId, Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail $participant)
 adds a new participants to the template
 
 getConferenceTemplateParticipant ($templateId, $participantId)
 returns a praticipant for the given templateId
 
 updateConferenceTemplateParticipant ($templateId, $participantId, Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail $participant)
 updates the participants details
 
 removeConferenceTemplateParticipant ($templateId, $participantId)
 removes a praticipant from the given templateId
 
- Public Member Functions inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
 __construct (array $options=array())
 constructor
 
 setOption ($name, $value)
 Set an option.
 
 getOption ($name)
 get an option value from the internal options object
 
 getSoapClient ()
 returns the internal soap client if not allready exists we create an instance of Zend_Soap_Client
 
 setEnvironment ($environment)
 sets new environment
 
 getEnvironment ()
 returns the current configured environemnt
 
 getWsdl ()
 returns the wsdl file path, a uri or the local path
 
 setUseLocalWsdl ($use=true)
 switch to the local wsdl file usage
 
 setWsdl ($wsdlFile=null)
 sets a new wsdl file
 
 setLocalWsdl ($wsdlFile=null)
 sets a new local wsdl file
 
 getClientOptions ()
 returns an array with configured options for this client
 
 getCredential ()
 returns the internal credential object
 

Protected Attributes

 $_wsdlFile = 'https://gateway.developer.telekom.com/p3gw-mod-odg-ccs/services/ccsPort?wsdl'
 
 $_wsdlFileLocal = 'Wsdl/ccsPort.wsdl'
 
 $_classMap
 
- Protected Attributes inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
 $_options = array()
 
 $_serviceAuthId = 'https://odg.t-online.de'
 
 $_serviceEnvironment = Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION
 
 $_wsdlFile = null
 
 $_wsdlFileLocal = null
 
 $_useLocalWsdl = true
 
 $_credential = null
 
 $_soapClient = null
 
 $_classMap = array()
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
static getParticipantActions ()
 returns an array of all available environments
 
static checkParticipantAction ($action)
 checks if the given action is valid otherwise it
 
static getEnvironments ()
 returns an array of all available environments
 
static checkEnvironment ($environment)
 checks if the given environemnt is valid otherwise it
 
- Public Attributes inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
const ENV_PRODUCTION = 1
 constants for using with the odg api
 
const ENV_SANDBOX = 2
 
const ENV_MOCK = 3
 
const PARTICIPANT_MUTE_OFF = 0
 
const PARTICIPANT_MUTE_ON = 1
 
const PARTICIPANT_RECALL = 2
 
- Static Protected Member Functions inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
static _buildConstArray ()
 helper method to create const arrays
 
- Static Protected Attributes inherited from Zend_Service_DeveloperGarden_Client_ClientAbstract
static $_consts = null
 

Member Function Documentation

addConferenceTemplateParticipant (   $templateId,
Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail  $participant 
)
commitConference (   $conferenceId)

commits the given conference

Parameters
string$conferenceId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CommitConferenceResponse
createConference (   $ownerId,
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail  $conferenceDetails,
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceSchedule  $conferenceSchedule = null,
  $account = null 
)

creates a new conference, ownerId should be between 3 and 39 chars

Parameters
string$ownerId
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail$conferenceDetails
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceSchedule$conferenceSchedule
integer$account
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CreateConferenceResponseType
createConferenceTemplate (   $ownerId,
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail  $conferenceDetails,
array  $participants = null 
)

creates a new conference template

Parameters
string$ownerId
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail$conferenceDetails
array$participants
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CreateConferenceTemplateResponseType
getConferenceList (   $what = 0,
  $ownerId = null 
)

returns a list of conferences

Parameters
integer$what
string$ownerId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceListResponseType
getConferenceStatus (   $conferenceId,
  $what = 0 
)

get conference status details

Parameters
string$conferenceId
integer$what
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceStatusResponseType
getConferenceTemplate (   $templateId)

get a specific template

Parameters
string$templateId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceTemplateResponseType
getConferenceTemplateList (   $ownerId)

lists all available conference templates for the given owner

Parameters
string$ownerId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceTemplateListResponseType
getConferenceTemplateParticipant (   $templateId,
  $participantId 
)

returns a praticipant for the given templateId

Parameters
string$templateId
string$participantId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceTemplateParticipantResponseType
getParticipantStatus (   $conferenceId,
  $participantId 
)

fetches the participant details for the given conferenceId

Parameters
string$conferenceId
string$participantId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_GetParticipantStatusResponseType
getRunningConference (   $conferenceId)

returns the conferenceId of the running conference instance for a planned recurring conference or the current conferenceId

Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_GetRunningConferenceResponseType
newParticipant (   $conferenceId,
Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail  $participant 
)

adds a new participant to the given conference

Parameters
string$conferenceId
Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail$participant
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_NewParticipantResponseType
removeConference (   $conferenceId)

remove a conference

Parameters
string$conferenceId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
removeConferenceTemplate (   $templateId)

remove a conference template

Parameters
string$templateId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
removeConferenceTemplateParticipant (   $templateId,
  $participantId 
)

removes a praticipant from the given templateId

Parameters
string$templateId
string$participantId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
removeParticipant (   $conferenceId,
  $participantId 
)

removes the given participant from the conference

Parameters
string$conferenceId
string$participantId
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
updateConference (   $conferenceId,
  $ownerId = null,
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail  $conferenceDetails = null,
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceSchedule  $conferenceSchedule = null,
  $account = null 
)

updates a conference with the given parameter

Parameters
string$conferenceId
string$ownerId
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail$conferenceDetails
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceSchedule$conferenceSchedule
string$account
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
updateConferenceTemplate (   $templateId,
  $initiatorId = null,
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail  $conferenceDetails = null 
)

updates a conference template

Parameters
string$templateId
string$initiatorId
Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail$conferenceDetails
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
updateConferenceTemplateParticipant (   $templateId,
  $participantId,
Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail  $participant 
)

updates the participants details

Parameters
string$templateId
string$participantId
Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail$participant
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
updateParticipant (   $conferenceId,
  $participantId,
  $action = null,
Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail  $participant = null 
)

updates the participant in the given conference

Parameters
string$conferenceId
string$participantId
integer$action
Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail$participant
Returns
Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType

Member Data Documentation

$_classMap
protected
$_wsdlFile = 'https://gateway.developer.telekom.com/p3gw-mod-odg-ccs/services/ccsPort?wsdl'
protected
$_wsdlFileLocal = 'Wsdl/ccsPort.wsdl'
protected