BxIntercomModule Class Reference

Inheritance diagram for BxIntercomModule:

Public Member Functions
	__construct (&$aModule)
	serviceIntegrationCode ()
	serviceRemoveAccount ($mixed)
	serviceUpdateAccount ($sEmail)
	actionAccountRemove ($sEmail)
	actionAccountUpdate ($sEmail)
	actionBulkAdd ($iLimit=5000)
	serviceBulkAdd ($iLimit=5000)
	actionNum ()
Public Member Functions inherited from BxDolModule
	__construct ($aModule)
	__get ($sName)
	__set ($sName, $o)
	isEnabled ()
	getName ()
	isLogged ()
	getUserId ()
	getUserPassword ()
	serviceIsSafeService ($s)
	serviceGetSafeServices ()
	serviceIsPublicService ($s)
	serviceGetPublicServices ()

Protected Member Functions
	_prepareUser ($oAccount)
	_checkForErrors ($s, $sErrorCurl, $sReturnType='json')
	_returnErrors ($mixed, $sReturnType='json')
	_request ($sURI, $sMethod, $aData, &$sError)

Protected Attributes
	$sHostnameAPI = 'https://api.intercom.io'

Additional Inherited Members
Static Public Member Functions inherited from BxDolModule
static	getInstance ($sName)
static	getTitle ($sUri)
static	getTitleKey ($sUri)
Public Attributes inherited from BxDolModule
	$_aModule

Member Function Documentation

_checkForErrors()

BxIntercomModule::_checkForErrors ( $s, $sErrorCurl, $sReturnType = 'json' )

protected

Returns

json error object on error or empty string on success

_request()

BxIntercomModule::_request ( $sURI, $sMethod, $aData, & $sError )

protected

Perform JSON request to the API endpoint and get JSON response

Returns

false on error

actionAccountRemove()

BxIntercomModule::actionAccountRemove

(

$sEmail

)

remove user from intercom by email or account id

actionAccountUpdate()

BxIntercomModule::actionAccountUpdate

(

$sEmail

)

update user by email or account id

actionBulkAdd()

BxIntercomModule::actionBulkAdd

(

$iLimit = 5000

)

Add members in bulk from local database to Intercom

actionNum()

BxIntercomModule::actionNum

(

)

Test query to return number of users registered in intercom

serviceRemoveAccount()

BxIntercomModule::serviceRemoveAccount

(

$mixed

)

remove user from intercom by email or account id

serviceUpdateAccount()

BxIntercomModule::serviceUpdateAccount

(

$sEmail

)

update user by email or account id

---

The documentation for this class was generated from the following file:

• modules/boonex/intercom/classes/BxIntercomModule.php