include/externalAPI/WebEx/ExtAPIWebEx.php

Show:

inherited

Classes
- \ExtAPIWebEx

Table of Contents

\ExtAPIWebEx
jump to top

Package:

Base implementation for external API

Parent(s): \ExternalAPIBase < \ExternalAPIPlugin

Constants

 
                APP_STRING_ERROR_PREFIX
                = 'ERR_EXTERNAL_API_'

inheritedInherited from: \ExternalAPIBase::APP_STRING_ERROR_PREFIX

Inherited_from: \ExternalAPIBase::APP_STRING_ERROR_PREFIX

Properties


                 $_appStringErrorPrefix= 'self::APP_STRING_ERROR_PREFIX'

inheritedInherited from: \ExternalAPIBase::$$_appStringErrorPrefix

Default valueself::APP_STRING_ERROR_PREFIXDetails

Type: n/a
Inherited_from: \ExternalAPIBase::$$_appStringErrorPrefix


                 $account_name= ''

inheritedInherited from: \ExternalAPIBase::$$account_name

Details

Type: n/a
Inherited_from: \ExternalAPIBase::$$account_name


                 $account_password= ''

inheritedInherited from: \ExternalAPIBase::$$account_password

Details

Type: n/a
Inherited_from: \ExternalAPIBase::$$account_password

\EAPM
                 $authData= ''

inherited

Authorization data

Inherited from: \ExternalAPIBase::$$authData

Details

Type: \EAPM
Inherited_from: \ExternalAPIBase::$$authData


                 $authMethod= ''password''

Default value'password'Details

Type: n/a


                 $canInvite= 'true'

Default valuetrueDetails

Type: n/a


                 $connector= '"ext_eapm_webex"'

Default value"ext_eapm_webex"Details

Type: n/a


                 $dateFormat= ''m/d/Y H:i:s''

Default value'm/d/Y H:i:s'Details

Type: n/a


                 $needsUrl= 'true'

Default valuetrueDetails

Type: n/a


                 $requireAuth= 'true'

inheritedInherited from: \ExternalAPIBase::$$requireAuth

Default valuetrueDetails

Type: n/a
Inherited_from: \ExternalAPIBase::$$requireAuth


                 $sendsInvites= 'true'

Default valuetrueDetails

Type: n/a


                 $supportMeetingPassword= 'true'

Default valuetrueDetails

Type: n/a


                 $supportedModules= 'array('Meetings')'

Default valuearray('Meetings')Details

Type: n/a


                 $urlExtension= ''/WBXService/XMLService''

Default value'/WBXService/XMLService'Details

Type: n/a


                 $useAuth= 'true'

inheritedInherited from: \ExternalAPIBase::$$useAuth

Default valuetrueDetails

Type: n/a
Inherited_from: \ExternalAPIBase::$$useAuth

Methods

__construct(
          
          )
        
        :
          void

addAuthenticationInfo(
          \SimpleXMLElement $doc
          )
        
        :
          void

Adds values to the security context header for a WebEx XML request.

Parameters

Name	Type	Description
$doc	\SimpleXMLElement

checkLogin(
          \EAPM $eapmBean
              =
              null
          )
        
        :
          void

Check login

Parameters

Name	Type	Description
$eapmBean	\EAPM

editMeeting(
           $bean
          )
        
        :
          void

Edit an existing webex meeting

Parameters

Name	Type	Description
$bean

fixUrl(
           $url
          )
        
        :
          void

Parameters

Name	Type	Description
$url

formatCallbackURL(
          \$callback_url $callback_url
          )
        
        :
          String

inherited

formatCallbackURL

Inherited from: \ExternalAPIBase::formatCallbackURL()

This function takes a callback_url and checks the $_REQUEST variable to see if additional parameters should be appended to the callback_url value. The $_REQUEST variables that are being checked deal with handling the behavior of closing/hiding windows/tabs that are displayed when prompting for OAUTH validation

Parameters

Name	Type	Description
$callback_url	\$callback_url	String value of callback URL

Returns

Type	Description
String	value of URL with applicable formatting

getConnector(
          
          )
        
        :
          \source | null

inherited

Get connector for this API

Inherited from: \ExternalAPIBase::getConnector()

Returns

Type	Description
\source \| null

getConnectorParam(
          string $name
          )
        
        :
          mixed

inherited

Get parameter from source

Inherited from: \ExternalAPIBase::getConnectorParam()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

getErrorStringFromCode(
          \unknown_type $error_numb
          )
        
        :
          void

inherited

Allow API clients to provide translated language strings for a given error code

Inherited from: \ExternalAPIBase::getErrorStringFromCode()

Parameters

Name	Type	Description
$error_numb	\unknown_type

getMeetingDetails(
          string $bean
          )
        
        :
          void

Get detailed information about the meeting with key $meeting.

Parameters

Name	Type	Description
$bean	string	meeting- The WebEx meeting key. return: The XML response from the WebEx server.

getValue(
           $value
          )
        
        :
          void

inherited

Inherited from: \ExternalAPIBase::getValue()

Parameters

Name	Type	Description
$value

hostMeeting(
          string $bean
          )
        
        :
          void

Get the url for hosting the meeting with key $meeting.

Parameters

Name	Type	Description
$bean	string	meeting - The WebEx meeting key. return: The XML response from the WebEx server.

inviteAttendee(
           $bean, array $attendee,  $sendInvites
              =
              false
          )
        
        :
          void

Invite $attendee to the meeting with key $session.

Parameters

Name	Type	Description
$bean
$attendee	array	An array with entries for 'name' and 'email' return: The XML response from the WebEx server.
$sendInvites

isMimeDetectionAvailable(
          
          )
        
        :
          bool

inherited

Determine if mime detection extensions are available.

Inherited from: \ExternalAPIBase::isMimeDetectionAvailable()

Returns

Type	Description
bool

joinMeeting(
          string $bean, string $attendeeName
          )
        
        :
          void

Get the url for joining the meeting with key $meeting as attendee $attendeeName.

Parameters

Name	Type	Description
$bean	string	meeting - The WebEx meeting key.
$attendeeName	string	attendeeName - Name of joining attendee return: The XML response from the WebEx server.

listMyMeetings(
          
          )
        
        :
          void

List all meetings created by this object's WebEx user.

loadEAPM(
          \EAPM $eapmBean
          )
        
        :
          void

Load authorization data

Parameters

Name	Type	Description
$eapmBean	\EAPM

logOff(
          
          )
        
        :
          void

inherited

Inherited from: \ExternalAPIBase::logOff()

postData(
           $url,  $postfields,  $headers
          )
        
        :
          void

inherited

Inherited from: \ExternalAPIBase::postData()

Parameters

Name	Type	Description
$url
$postfields
$headers

postMessage(
          \SimpleXMLElement $doc
          )
        
        :
          void

Sends a request to the WebEx XML API.

Parameters

Name	Type	Description
$doc	\SimpleXMLElement

quickCheckLogin(
          
          )
        
        :
          void

inherited

Inherited from: \ExternalAPIBase::quickCheckLogin()

scheduleMeeting(
           $bean
          )
        
        :
          void

Create a new WebEx meeting.

Parameters

Name	Type	Description
$bean

supports(
           $method
              =
              ''
          )
        
        :
          void

inherited

Does API support this method?

Inherited from: \ExternalAPIBase::supports()

Parameters

Name	Type	Description
$method

Details

See: \ExternalAPIPlugin::supports()

uninviteAttendee(
           $bean, array $attendeeID
          )
        
        :
          void

Uninvite the attendee with ID $attendeeID from the meeting.

Note: attendee ID is returned as part of the response to inviteAtendee(). The attendee ID refers to a specific person and a specific meeting.

Parameters

Name	Type	Description
$bean
$attendeeID	array	WebEx attendee ID. return: The XML response from the WebEx server.

unscheduleMeeting(
           $bean
          )
        
        :
          void

Delete an existing WebEx meeting.

Parameters

Name	Type	Description
$bean

include/externalAPI/WebEx/ExtAPIWebEx.php

\ExtAPIWebExjump to top

Constants

Properties

Methods

\ExtAPIWebEx
jump to top