include/externalAPI/LotusLive/ExtAPILotusLive.php

Show:

inherited

Classes
- \ExtAPILotusLive

Table of Contents

\ExtAPILotusLive
jump to top

Package:

External API based on OAuth

Parent(s): \WebDocument < \ExternalAPIBase < \ExternalAPIPlugin

Constants

 
                APP_STRING_ERROR_PREFIX
                = 'ERR_EXTERNAL_API_'

inheritedInherited from: \ExternalAPIBase::APP_STRING_ERROR_PREFIX \OAuthPluginBase::APP_STRING_ERROR_PREFIX

Inherited_from: \ExternalAPIBase::APP_STRING_ERROR_PREFIX
Inherited_from: \OAuthPluginBase::APP_STRING_ERROR_PREFIX

Properties


                 $_appStringErrorPrefix= 'self::APP_STRING_ERROR_PREFIX'

inheritedInherited from: \ExternalAPIBase::$$_appStringErrorPrefix \OAuthPluginBase::$$_appStringErrorPrefix

Default valueself::APP_STRING_ERROR_PREFIXDetails

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


                 $account_name= ''

inheritedInherited from: \ExternalAPIBase::$$account_name \OAuthPluginBase::$$account_name

Details

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


                 $account_password= ''

inheritedInherited from: \ExternalAPIBase::$$account_password \OAuthPluginBase::$$account_password

Details

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

\EAPM
                 $authData= ''

inherited

Authorization data

Inherited from: \ExternalAPIBase::$$authData \OAuthPluginBase::$$authData

Details

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


                 $authMethod= ''oauth''

Default value'oauth'Details

Type: n/a


                 $canInvite= 'false'

Default valuefalseDetails

Type: n/a


                 $connector= '"ext_eapm_lotuslive"'

Default value"ext_eapm_lotuslive"Details

Type: n/a


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

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

Type: n/a


                 $docSearch= 'true'

Default valuetrueDetails

Type: n/a


                 $hostURL= ''

Details

Type: n/a


                 $llMimeWhitelist= 'array(
        'application/msword',
        'application/pdf',
        'application/postscript',
        'application/vnd.ms-excel',
        'application/vnd.ms-powerpoint',
        'application/vnd.oasis.opendocument.formula',
        'application/vnd.oasis.opendocument.graphics',
        'application/vnd.oasis.opendocument.presentation',
        'application/vnd.oasis.opendocument.presentation-template',
        'application/vnd.oasis.opendocument.spreadsheet',
        'application/vnd.oasis.opendocument.spreadsheet-template',
        'application/vnd.oasis.opendocument.text',
        'application/vnd.oasis.opendocument.text-master',
        'application/vnd.oasis.opendocument.text-template',
        'application/vnd.oasis.opendocument.text-web',
        'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
        'application/vnd.ms-word.document.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
        'application/vnd.ms-word.template.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
        'application/vnd.ms-excel.sheet.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
        'application/vnd.ms-excel.template.macroEnabled.12',
        'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
        'application/vnd.ms-excel.addin.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.presentationml.presentation',
        'application/vnd.ms-powerpoint.presentation.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
        'application/vnd.ms-powerpoint.slideshow.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.presentationml.template',
        'application/vnd.ms-powerpoint.template.macroEnabled.12',
        'application/vnd.ms-powerpoint.addin.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.presentationml.slide',
        'application/vnd.ms-powerpoint.slide.macroEnabled.12',
        'application/vnd.ms-officetheme',
        'application/onenote',
        )'

static

Default value

array(
        'application/msword',
        'application/pdf',
        'application/postscript',
        'application/vnd.ms-excel',
        'application/vnd.ms-powerpoint',
        'application/vnd.oasis.opendocument.formula',
        'application/vnd.oasis.opendocument.graphics',
        'application/vnd.oasis.opendocument.presentation',
        'application/vnd.oasis.opendocument.presentation-template',
        'application/vnd.oasis.opendocument.spreadsheet',
        'application/vnd.oasis.opendocument.spreadsheet-template',
        'application/vnd.oasis.opendocument.text',
        'application/vnd.oasis.opendocument.text-master',
        'application/vnd.oasis.opendocument.text-template',
        'application/vnd.oasis.opendocument.text-web',
        'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
        'application/vnd.ms-word.document.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
        'application/vnd.ms-word.template.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
        'application/vnd.ms-excel.sheet.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
        'application/vnd.ms-excel.template.macroEnabled.12',
        'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
        'application/vnd.ms-excel.addin.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.presentationml.presentation',
        'application/vnd.ms-powerpoint.presentation.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
        'application/vnd.ms-powerpoint.slideshow.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.presentationml.template',
        'application/vnd.ms-powerpoint.template.macroEnabled.12',
        'application/vnd.ms-powerpoint.addin.macroEnabled.12',
        'application/vnd.openxmlformats-officedocument.presentationml.slide',
        'application/vnd.ms-powerpoint.slide.macroEnabled.12',
        'application/vnd.ms-officetheme',
        'application/onenote',
        )

Details

Type: n/a


                 $needsUrl= 'false'

Default valuefalseDetails

Type: n/a


                 $oauthAccess= ''/manage/oauth/getAccessToken''

Default value'/manage/oauth/getAccessToken'Details

Type: n/a


                 $oauthAuth= ''/manage/oauth/authorizeToken''

Default value'/manage/oauth/authorizeToken'Details

Type: n/a


                 $oauthParams= 'array(
        'signatureMethod' => 'PLAINTEXT',
    )'

Default value

array(
        'signatureMethod' => 'PLAINTEXT',
    )

Details

Type: n/a


                 $oauthReq= '"/manage/oauth/getRequestToken"'

Default value"/manage/oauth/getRequestToken"Details

Type: n/a


                 $oauth_keys_initialized= 'false'

inheritedInherited from: \OAuthPluginBase::$$oauth_keys_initialized

Default valuefalseDetails

Type: n/a
Inherited_from: \OAuthPluginBase::$$oauth_keys_initialized


                 $requireAuth= 'true'

inheritedInherited from: \ExternalAPIBase::$$requireAuth \OAuthPluginBase::$$requireAuth

Default valuetrueDetails

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


                 $restrictUploadsByExtension= 'false'

Default valuefalseDetails

Type: n/a


                 $sendsInvites= 'false'

Default valuefalseDetails

Type: n/a


                 $supportMeetingPassword= 'false'

Default valuefalseDetails

Type: n/a


                 $supportedModules= 'array('Meetings','Notes', 'Documents')'

Default valuearray('Meetings','Notes', 'Documents')Details

Type: n/a


                 $url= ''https://apps.lotuslive.com/''

Default value'https://apps.lotuslive.com/'Details

Type: n/a


                 $useAuth= 'true'

inheritedInherited from: \ExternalAPIBase::$$useAuth \OAuthPluginBase::$$useAuth

Default valuetrueDetails

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

Methods

__construct(
          
          )
        
        :
          void

checkLogin(
          \EAPM $eapmBean
              =
              null
          )
        
        :
          void

Check login

Parameters

Name	Type	Description
$eapmBean	\EAPM

checkOauthLogin(
          
          )
        
        :
          void

inherited

Inherited from: \OAuthPluginBase::checkOauthLogin()

deleteDoc(
           $document
          )
        
        :
          void

Parameters

Name	Type	Description
$document

downloadDoc(
           $documentId,  $documentFormat
          )
        
        :
          void

Parameters

Name	Type	Description
$documentId
$documentFormat

editMeeting(
           $bean
          )
        
        :
          void

Edit an existing Lotus meeting

Parameters

Name	Type	Description
$bean

formatCallbackURL(
          \$callback_url $callback_url
          )
        
        :
          String

inherited

formatCallbackURL

Inherited from: \ExternalAPIBase::formatCallbackURL()\OAuthPluginBase::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

getClient(
          
          )
        
        :
          \Zend_Http_Client

Get HTTP client for communication with Lotus

Creates and setup the http client object, including authorization data if needed

Returns

Type	Description
\Zend_Http_Client

getConnector(
          
          )
        
        :
          \source | null

inherited

Get connector for this API

Inherited from: \ExternalAPIBase::getConnector()\OAuthPluginBase::getConnector()

Returns

Type	Description
\source \| null

getConnectorParam(
          string $name
          )
        
        :
          mixed

inherited

Get parameter from source

Inherited from: \ExternalAPIBase::getConnectorParam()\OAuthPluginBase::getConnectorParam()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

getErrorStringFromCode(
          \$error $error
              =
              ''
          )
        
        :
          String

getErrorStringFromCode

This method overrides the getErrorStringFromCode method from the ExternalAPIBase class and provides for custom error messages specific to the Lotus Live web service.

Parameters

Name	Type	Description
$error	\$error	Mixed variable of the error message, number or object returned from Lotus Live web service

Returns

Type	Description
String	Translated string label for the error message

getMeetingDetails(
          string $bean
          )
        
        :
          void

Get detailed information about the meeting with key $meeting.

Parameters

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

getOauth(
          
          )
        
        :
          \SugarOauth

inherited

Get OAuth client

Inherited from: \OAuthPluginBase::getOauth()

Returns

Type	Description
\SugarOauth

getOauthAccessURL(
          
          )
        
        :
          void

inherited

Inherited from: \OAuthPluginBase::getOauthAccessURL()

getOauthAuthURL(
          
          )
        
        :
          void

inherited

Inherited from: \OAuthPluginBase::getOauthAuthURL()

getOauthParams(
          
          )
        
        :
          void

inherited

Inherited from: \OAuthPluginBase::getOauthParams()

getOauthRequestURL(
          
          )
        
        :
          void

inherited

Inherited from: \OAuthPluginBase::getOauthRequestURL()

getValue(
           $value
          )
        
        :
          void

inherited

Inherited from: \ExternalAPIBase::getValue()\OAuthPluginBase::getValue()

Parameters

Name	Type	Description
$value

getVersion(
          
          )
        
        :
          void

Check the API version

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

NOT SUPPORTED BY LOTUS Invite $attendee to the meeting with key $session.

Parameters

Name	Type	Description
$bean
$attendee	array	An array with entries for 'name' and 'email' return: boolean.
$sendInvites

isMimeDetectionAvailable(
          
          )
        
        :
          bool

inherited

Determine if mime detection extensions are available.

Inherited from: \ExternalAPIBase::isMimeDetectionAvailable()\OAuthPluginBase::isMimeDetectionAvailable()

Returns

Type	Description
bool

listMyMeetings(
          
          )
        
        :
          void

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

loadDocCache(
           $forceReload
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$forceReload

loadEAPM(
          \EAPM $eapmBean
          )
        
        :
          void

Load data from EAPM bean

Parameters

Name	Type	Description
$eapmBean	\EAPM

logOff(
          
          )
        
        :
          void

inherited

Inherited from: \ExternalAPIBase::logOff()\OAuthPluginBase::logOff()

makeRequest(
           $urlReq, \unknown_type $method
              =
              'GET', \unknown_type $json
              =
              true
          )
        
        :
          void

Make request to a service

Parameters

Name	Type	Description
$urlReq
$method	\unknown_type
$json	\unknown_type

oauthLogin(
          
          )
        
        :
          void

inherited

Inherited from: \OAuthPluginBase::oauthLogin()

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

inherited

Inherited from: \ExternalAPIBase::postData()\OAuthPluginBase::postData()

Parameters

Name	Type	Description
$url
$postfields
$headers

quickCheckLogin(
          
          )
        
        :
          void

scheduleMeeting(
           $bean
          )
        
        :
          void

Create a new Lotus meeting.

Parameters

Name	Type	Description
$bean

searchDoc(
           $keywords,  $flushDocCache
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$keywords
$flushDocCache

setupOauthKeys(
          
          )
        
        :
          void

inherited

Setup oauth parameters from connector

Inherited from: \OAuthPluginBase::setupOauthKeys()

shareDoc(
           $documentId,  $emails
          )
        
        :
          void

Parameters

Name	Type	Description
$documentId
$emails

supports(
           $method
              =
              ''
          )
        
        :
          void

inherited

Does API support this method?

Inherited from: \ExternalAPIBase::supports()\OAuthPluginBase::supports()

Parameters

Name	Type	Description
$method

Details

See: \ExternalAPIPlugin::supports()

uninviteAttendee(
           $bean, array $attendeeID
          )
        
        :
          void

NOT SUPPORTED BY LOTUS 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	Lotus attendee ID. return: boolean.

unscheduleMeeting(
           $bean
          )
        
        :
          void

Delete an existing Lotus meeting.

Parameters

Name	Type	Description
$bean

uploadDoc(
           $bean,  $fileToUpload,  $docName,  $mimeType
          )
        
        :
          void

Parameters

Name	Type	Description
$bean
$fileToUpload
$docName
$mimeType

include/externalAPI/LotusLive/ExtAPILotusLive.php

\ExtAPILotusLivejump to top

Constants

Properties

Methods

\ExtAPILotusLive
jump to top