AfterLogic API Documentation
  • Package
  • Class

Packages

  • Calendar
    • Classes
    • Storages
  • Capability
  • Channels
    • Classes
    • Storages
  • Collaboration
  • Contacts
    • Helpers
    • Storages
  • Dav
  • Db
    • Classes
    • Enum
    • Storages
  • Domains
    • Classes
    • Storages
  • Fetchers
    • Classes
    • Storages
  • Filecache
    • Storages
  • Filestorage
    • Classes
    • Storages
  • GContacts
    • Storages
  • Helpdesk
    • Classes
    • Enum
    • Storages
  • Integrator
  • IOS
  • Logger
  • Mail
    • Classes
    • Enum
    • Storages
  • Mailsuite
    • Classes
    • Storages
  • Min
    • Storages
  • Sieve
    • Classes
    • Enum
  • Social
    • Classes
    • Storages
  • Subscription
    • Classes
  • Subscriptions
    • Storages
  • Tenants
    • Classes
    • Storages
  • Twofactorauth
    • Classes
    • Storages
  • Users
    • Classes
    • Enum
    • Storages
  • Voice
  • WebMail
    • Storages

Classes

  • CApiIntegratorManager

Class CApiIntegratorManager

CApiIntegratorManager class summary

AApiManager
Extended by CApiIntegratorManager
Package: Integrator
Located at integrator/manager.php

Methods summary

public
# __construct( CApiGlobalManager & $oManager )

Creates a new instance of the object.

Creates a new instance of the object.

Parameters

$oManager
$oManager
public string
# getLoginLanguage( )

Returns

string
public
# setLoginLanguage( string $sLanguage )

Parameters

$sLanguage
public integer
# getLogginedUserId( string $sAuthToken = '' )

Parameters

$sAuthToken
Default value is empty string.

Returns

integer
public integer
# getLogginedHelpdeskUserId( )

Returns

integer
public CAccount|null
# getLogginedDefaultAccount( )

Returns

CAccount|null
public string
# getCsrfToken( )

Returns

string
public
# setLastErrorCode( integer $iCode )

Parameters

$iCode
public integer
# getLastErrorCode( )

Returns

integer
public
# clearLastErrorCode( )
public boolean
# validateCsrfToken( string $sToken )

Parameters

$sToken

Returns

boolean
public boolean
# logoutAccount( string $sAuthToken = '' )

Parameters

$sAuthToken
Default value is empty string.

Returns

boolean
public
# setThreadIdFromRequest( integer $iThreadID, string $sThreadAction = '' )

Parameters

$iThreadID
$sThreadAction
Default value is empty string.
public array
# getThreadIdFromRequestAndClear( )

Returns

array
public
# removeUserAsActivated( )
public
# setUserAsActivated( CHelpdeskUser $oHelpdeskUser, boolean $bForgot = false )

Parameters

$oHelpdeskUser
$bForgot
Default value is false.
public integer
# getActivatedUserEmailAndClear( )

Returns

integer
public string
# setAccountAsLoggedIn( CAccount $oAccount, boolean $bSignMe = false )

Parameters

$oAccount
$bSignMe
Default value is false.

Returns

string
public
# setHelpdeskUserAsLoggedIn( CHelpdeskUser $oUser, boolean $bSignMe = false )

Parameters

$oUser
$bSignMe
Default value is false.
public boolean
# logoutHelpdeskUser( )

Returns

boolean
public
# skipMobileCheck( )
public integer
# isMobile( )

Returns

integer
public boolean
# setMobile( boolean $bMobile )

Parameters

$bMobile

Returns

boolean
public
# resetCookies( )
public CAccount|null|boolean
# loginToAccount( string $sEmail, string $sIncPassword, string $sIncLogin = '', string $sLanguage = '' )

Parameters

$sEmail
$sIncPassword
$sIncLogin
Default value is empty string.
$sLanguage
Default value is empty string.

Returns

CAccount|null|boolean

Throws

CApiManagerException(Errs::WebMailManager_AccountDisabled)
1501
CApiManagerException(Errs::Mail_AccountAuthentication)
4002
CApiManagerException(Errs::WebMailManager_AccountCreateOnLogin)
1503
public CHelpdeskUser|null|boolean
# loginToHelpdeskAccount( integer $iIdTenant, string $sEmail, string $sPassword )

Parameters

$iIdTenant
$sEmail
$sPassword

Returns

CHelpdeskUser|null|boolean

Throws

CApiManagerException(Errs::HelpdeskManager_AccountSystemAuthentication)
6008
CApiManagerException(Errs::HelpdeskManager_UnactivatedUser)
6010
CApiManagerException(Errs::HelpdeskManager_AccountAuthentication)
6004
public CHelpdeskUser|boolean
# registerHelpdeskAccount( integer $iIdTenant, string $sEmail, string $sName, string $sPassword, boolean $bCreateFromFetcher = false )

Parameters

$iIdTenant
$sEmail
$sName
$sPassword
$bCreateFromFetcher
Default value is false.

Returns

CHelpdeskUser|boolean

Throws

CApiManagerException(Errs::HelpdeskManager_UserAlreadyExists)
6001
CApiManagerException(Errs::HelpdeskManager_UserCreateFailed)
6002
public boolean
# registerSocialAccount( integer $iIdTenant, string $sTenantHash, string $sNotificationEmail, string $sSocialId, string $sSocialType, string $sSocialName )

Parameters

$iIdTenant
$sTenantHash
$sNotificationEmail
$sSocialId
$sSocialType
$sSocialName

Returns

boolean

Throws

CApiManagerException(Errs::HelpdeskManager_UserAlreadyExists)
6001
CApiManagerException(Errs::HelpdeskManager_UserCreateFailed)
6002
public integer|boolean
# getTenantIdByHash( string $sTenantHash )

Parameters

$sTenantHash

Returns

integer|boolean
public array
# getLanguageList( )

Returns

array
public array
# getThemeList( )

Returns

array
public array
# getTabList( CDomain $oDomain )

Parameters

$oDomain

Returns

array
public array
# appData( boolean $bHelpdesk = false, integer $iHelpdeskIdTenant = null, string $sHelpdeskTenantHash = '', string $sCalendarPubHash = '', string $sFileStoragePubHash = '', string $sAuthToken = '' )

Parameters

$bHelpdesk
Default value is false.
$iHelpdeskIdTenant
Default value is null.
$sHelpdeskTenantHash
Default value is empty string.
$sCalendarPubHash
Default value is empty string.
$sFileStoragePubHash
Default value is empty string.
$sAuthToken
Default value is empty string.

Returns

array
public CUser|boolean
# getAhdSocialUser( string $sHelpdeskTenantHash = '', string $sUserId = '' )

Parameters

$sHelpdeskTenantHash
Default value is empty string.
$sUserId
Default value is empty string.

Returns

CUser|boolean

Throws

ProjectCore\Exceptions\ClientException(\ProjectCore\Notifications::InvalidInputParameter)
103
public string
# getAppDirValue( boolean $bHelpdesk = false )

Parameters

$bHelpdesk
Default value is false.

Returns

string
public string
# buildHeadersLink( string $sWebPath = '.', boolean $bHelpdesk = false, integer $iHelpdeskIdTenant = null, string $sHelpdeskHash = '', string $sCalendarPubHash = '', string $sFileStoragePubHash = '', boolean $bMobile = false )

Parameters

$sWebPath
Default value is '.'.
$bHelpdesk
Default value is false.
$iHelpdeskIdTenant
Default value is null.
$sHelpdeskHash
Default value is empty string.
$sCalendarPubHash
Default value is empty string.
$sFileStoragePubHash
Default value is empty string.
$bMobile
Default value is false.

Returns

string
public string
# buildBody( string $sWebPath = '.', boolean $bHelpdesk = false, integer $iHelpdeskIdTenant = null, string $sHelpdeskHash = '', string $sCalendarPubHash = '', string $sFileStoragePubHash = '', boolean $bMobile = false )

Parameters

$sWebPath
Default value is '.'.
$bHelpdesk
Default value is false.
$iHelpdeskIdTenant
Default value is null.
$sHelpdeskHash
Default value is empty string.
$sCalendarPubHash
Default value is empty string.
$sFileStoragePubHash
Default value is empty string.
$bMobile
Default value is false.

Returns

string
public static
# getAuthKey( )

Constants summary

string AUTH_KEY

Type

string
# 'p7auth'
string MOBILE_KEY

Type

string
# 'p7mobile'
string AUTH_HD_KEY

Type

string
# 'p7hdauth'
string TOKEN_KEY

Type

string
# 'p7token'
string TOKEN_LAST_CODE

Type

string
# 'p7lastcode'
string TOKEN_LANGUAGE

Type

string
# 'p7lang'
string TOKEN_HD_THREAD_ID

Type

string
# 'p7hdthread'
string TOKEN_HD_ACTIVATED

Type

string
# 'p7hdactivated'
string TOKEN_SKIP_MOBILE_CHECK

Type

string
# 'p7skipmobile'
AfterLogic API Documentation API documentation generated by ApiGen