API Documentation

Service/DeveloperGarden/ConferenceCall.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
DeveloperGarden  
version
$Id: ConferenceCall.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_DeveloperGarden_ConferenceCall

Extends from
\Zend_Service_DeveloperGarden_Client_ClientAbstract
author
Marco Kaiser  
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
DeveloperGarden  

Properties

Propertyprotectedarray  $_classMap= 'array'

Response, Request Classmapping

Default valuearrayDetails
Type
array
Propertyprotectedstring  $_wsdlFile= 'https://gateway.developer.telekom.com/p3gw-mod-odg-ccs/services/ccsPort?wsdl'

wsdl file

Default valuehttps://gateway.developer.telekom.com/p3gw-mod-odg-ccs/services/ccsPort?wsdlDetails
Type
string
Propertyprotectedstring  $_wsdlFileLocal= 'Wsdl/ccsPort.wsdl'

the local WSDL file

Default valueWsdl/ccsPort.wsdlDetails
Type
string

Methods

methodpublic__construct( array $options = array ) : void
Parameters
Name Type Description
$options array Associative array of options
methodprotected_buildConstArray( ) : null
static

helper method to create const arrays

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::_buildConstArray()
Returns
Type Description
null
methodpubliccheckEnvironment( int $environment ) : void
static

checks if the given environemnt is valid otherwise it @throws Zend_Service_DeveloperGarden_Client_Exception

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::checkEnvironment()
Parameters
Name Type Description
$environment int
Throws
Exception Description
\Zend_Service_DeveloperGarden_Client_Exception
methodpubliccheckParticipantAction( int $action ) : void
static

checks if the given action is valid otherwise it @throws Zend_Service_DeveloperGarden_Exception

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::checkParticipantAction()
Parameters
Name Type Description
$action int
Throws
Exception Description
\Zend_Service_DeveloperGarden_Client_Exception
methodpubliccommitConference( string $conferenceId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CommitConferenceResponse

commits the given conference

Parameters
Name Type Description
$conferenceId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CommitConferenceResponse
methodpubliccreateConference( string $ownerId, \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail $conferenceDetails, \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceSchedule $conferenceSchedule = null, integer $account = null ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CreateConferenceResponseType

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

methodpubliccreateConferenceTemplate( string $ownerId, \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail $conferenceDetails, array $participants = null ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CreateConferenceTemplateResponseType

creates a new conference template

Parameters
Name Type Description
$ownerId string
$conferenceDetails \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail
$participants array
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CreateConferenceTemplateResponseType
methodpublicgetClientOptions( ) : array

returns an array with configured options for this client

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getClientOptions()
Returns
Type Description
array
methodpublicgetConferenceList( integer $what = 0, string $ownerId = null ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceListResponseType

returns a list of conferences

Parameters
Name Type Description
$what integer
$ownerId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceListResponseType
methodpublicgetConferenceStatus( string $conferenceId, integer $what = 0 ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceStatusResponseType

get conference status details

Parameters
Name Type Description
$conferenceId string
$what integer
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceStatusResponseType
methodpublicgetConferenceTemplate( string $templateId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceTemplateResponseType

get a specific template

Parameters
Name Type Description
$templateId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceTemplateResponseType
methodpublicgetConferenceTemplateList( string $ownerId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceTemplateListResponseType

lists all available conference templates for the given owner

Parameters
Name Type Description
$ownerId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceTemplateListResponseType
methodpublicgetConferenceTemplateParticipant( string $templateId, string $participantId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceTemplateParticipantResponseType

returns a praticipant for the given templateId

Parameters
Name Type Description
$templateId string
$participantId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_GetConferenceTemplateParticipantResponseType
methodpublicgetCredential( ) : \Zend_Service_DeveloperGarden_Credential

returns the internal credential object

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getCredential()
Returns
Type Description
\Zend_Service_DeveloperGarden_Credential
methodpublicgetEnvironment( ) : int

returns the current configured environemnt

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironment()
Returns
Type Description
int
methodpublicgetEnvironments( ) : array
static

returns an array of all available environments

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironments()
Returns
Type Description
array
methodpublicgetOption( string $name ) : mixed

get an option value from the internal options object

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getOption()
Parameters
Name Type Description
$name string
Returns
Type Description
mixed
methodpublicgetParticipantActions( ) : array
static

returns an array of all available environments

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getParticipantActions()
Returns
Type Description
array
methodpublicgetParticipantStatus( string $conferenceId, string $participantId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_GetParticipantStatusResponseType

fetches the participant details for the given conferenceId

Parameters
Name Type Description
$conferenceId string
$participantId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_GetParticipantStatusResponseType
methodpublicgetRunningConference(  $conferenceId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_GetRunningConferenceResponseType

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

Parameters
Name Type Description
$conferenceId
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_GetRunningConferenceResponseType
methodpublicgetSoapClient( ) : \Zend_Service_DeveloperGarden_Client_Soap
final

returns the internal soap client if not allready exists we create an instance of Zend_Soap_Client

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getSoapClient()
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_Soap
Details
final
 
methodpublicgetWsdl( ) : string

returns the wsdl file path, a uri or the local path

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getWsdl()
Returns
Type Description
string
methodpublicnewParticipant( string $conferenceId, \Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail $participant ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_NewParticipantResponseType

adds a new participant to the given conference

Parameters
Name Type Description
$conferenceId string
$participant \Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_NewParticipantResponseType
methodpublicremoveConference( string $conferenceId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType

remove a conference

Parameters
Name Type Description
$conferenceId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
methodpublicremoveConferenceTemplate( string $templateId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType

remove a conference template

Parameters
Name Type Description
$templateId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
methodpublicremoveConferenceTemplateParticipant( string $templateId, string $participantId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType

removes a praticipant from the given templateId

Parameters
Name Type Description
$templateId string
$participantId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
methodpublicremoveParticipant( string $conferenceId, string $participantId ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType

removes the given participant from the conference

Parameters
Name Type Description
$conferenceId string
$participantId string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
methodpublicsetEnvironment( int $environment ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
Parameters
Name Type Description
$environment int
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetLocalWsdl( string $wsdlFile = null ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

sets a new local wsdl file

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setLocalWsdl()
Parameters
Name Type Description
$wsdlFile string
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetOption( string $name, mixed $value ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
Throws
Exception Description
\Zend_Service_DeveloperGarden_Client_Exception
methodpublicsetUseLocalWsdl( \boolen $use = true ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract

switch to the local wsdl file usage

Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setUseLocalWsdl()
Parameters
Name Type Description
$use \boolen
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicsetWsdl( string $wsdlFile = null ) : \Zend_Service_DeveloperGarden_Client_ClientAbstract
Parameters
Name Type Description
$wsdlFile string
Returns
Type Description
\Zend_Service_DeveloperGarden_Client_ClientAbstract
methodpublicupdateConference( string $conferenceId, string $ownerId = null, \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail $conferenceDetails = null, \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceSchedule $conferenceSchedule = null, string $account = null ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType

updates a conference with the given parameter

Parameters
Name Type Description
$conferenceId string
$ownerId string
$conferenceDetails \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail
$conferenceSchedule \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceSchedule
$account string
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
methodpublicupdateConferenceTemplate( string $templateId, string $initiatorId = null, \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail $conferenceDetails = null ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType

updates a conference template

Parameters
Name Type Description
$templateId string
$initiatorId string
$conferenceDetails \Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
methodpublicupdateConferenceTemplateParticipant( string $templateId, string $participantId, \Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail $participant ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType

updates the participants details

Parameters
Name Type Description
$templateId string
$participantId string
$participant \Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
methodpublicupdateParticipant( string $conferenceId, string $participantId, integer $action = null, \Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail $participant = null ) : \Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType

updates the participant in the given conference

Parameters
Name Type Description
$conferenceId string
$participantId string
$action integer
$participant \Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail
Returns
Type Description
\Zend_Service_DeveloperGarden_Response_ConferenceCall_CCSResponseType
Documentation was generated by DocBlox 0.13.3.