include/externalAPI/Base/ExternalAPIBase.php
Show:
inherited
inherited
Classes
\ExternalAPIBase
Package: SugarCRM
Parameters
Returns
Base implementation for external API
- Parent(s)
- \ExternalAPIPlugin
- Children
- \OAuthPluginBase
- Api
Constants
Properties
$_appStringErrorPrefix= 'self::APP_STRING_ERROR_PREFIX'
Default value
self::APP_STRING_ERROR_PREFIXDetails- Type
- n/a
$account_name= ''
Details
- Type
- n/a
$account_password= ''
Details
- Type
- n/a
$authMethod= ''password''
Default value
'password'Details- Type
- n/a
$requireAuth= 'true'
Default value
trueDetails- Type
- n/a
$useAuth= 'true'
Default value
trueDetails- Type
- n/a
Methods
checkLogin(
\EAPM $eapmBean
=
null
)
:
voidCheck login
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $eapmBean | \EAPM |
formatCallbackURL(
\$callback_url $callback_url
)
:
StringformatCallbackURL
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
| Name | Type | Description |
|---|---|---|
| $callback_url | \$callback_url | String value of callback URL |
| Type | Description |
|---|---|
| String | value of URL with applicable formatting |
getConnectorParam(
string $name
)
:
mixedGet parameter from source
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| mixed |
getErrorStringFromCode(
\unknown_type $error_numb
)
:
voidAllow API clients to provide translated language strings for a given error code
Parameters
| Name | Type | Description |
|---|---|---|
| $error_numb | \unknown_type |
getValue(
$value
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $value |
isMimeDetectionAvailable(
)
:
boolDetermine if mime detection extensions are available.
Returns
| Type | Description |
|---|---|
| bool |
loadEAPM(
\EAPM $eapmBean
)
:
voidLoad authorization data
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $eapmBean | \EAPM |
logOff(
)
:
voidpostData(
$url, $postfields, $headers
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $url | ||
| $postfields | ||
| $headers |
quickCheckLogin(
)
:
voidsupports(
$method
=
''
)
:
voidDoes API support this method?
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $method |