public
|
#
__construct( CApiGlobalManager & $oManager, string $sForcedStorage = '' )
Parameters
- $oManager
- $oManager
- $sForcedStorage
- Default value is empty string.
|
public
boolean
|
#
createUser( CHelpdeskUser & $oHelpdeskUser, boolean $bCreateFromFetcher = false )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $bCreateFromFetcher
- Default value is false.
Returns
boolean
|
public
CHelpdeskUser |false
|
#
getUserById( integer $iIdTenant, integer $iHelpdeskUserId )
Parameters
- $iIdTenant
- $iHelpdeskUserId
Returns
|
public
CHelpdeskUser |false
|
#
getUserByIdWithoutTenantID( integer $iHelpdeskUserId )
|
public
CHelpdeskUser |false
|
#
getUserByActivateHash( integer $iIdTenant, string $sActivateHash )
Parameters
- $iIdTenant
- $sActivateHash
Returns
|
public
CHelpdeskUser |false
|
#
getHelpdeskMainSettings( integer $iIdTenant )
|
public
array
|
#
getAgentsEmailsForNotification( integer $iIdTenant, array $aExcludeEmails = array() )
Parameters
- $iIdTenant
- $aExcludeEmails
- = array()
Returns
array
|
public
CHelpdeskUser |null|false
|
#
getUserByEmail( integer $iIdTenant, string $sEmail )
|
public
CHelpdeskUser |null|false
|
#
getUserByNotificationEmail( integer $iIdTenant, string $sEmail )
|
public
CHelpdeskUser |null|false
|
#
getUserBySocialId( integer $iIdTenant, string $sSocialId )
|
public
boolean
|
#
forgotUser( CHelpdeskUser $oHelpdeskUser )
Parameters
Returns
boolean
|
public
boolean
|
#
isUserExists( CHelpdeskUser $oHelpdeskUser )
Parameters
- $oHelpdeskUser
- Helpdesk user object
Returns
boolean
|
public
array|boolean
|
#
userInformation( CHelpdeskUser $oHelpdeskUser, array $aIdList )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $aIdList
Returns
array|boolean
|
public
boolean
|
#
updateUser( CHelpdeskUser $oHelpdeskUser )
Parameters
- $oHelpdeskUser
- Helpdesk user object
Returns
boolean
|
public
boolean
|
#
setUserAsBlocked( integer $iIdTenant, integer $iIdHelpdeskUser )
Parameters
- $iIdTenant
- $iIdHelpdeskUser
Returns
boolean
|
public
boolean
|
#
deleteUser( integer $iIdTenant, integer $iIdHelpdeskUser )
Parameters
- $iIdTenant
- $iIdHelpdeskUser
Returns
boolean
|
public
boolean
|
#
deletePosts( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread, array $aPostIds )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $oThread
- Helpdesk thread object
- $aPostIds
Returns
boolean
|
public
boolean
|
#
verifyThreadIdsBelongToUser( CHelpdeskUser $oHelpdeskUser, array $aThreadIds )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $aThreadIds
Returns
boolean
|
public
boolean
|
#
verifyPostIdsBelongToUser( CHelpdeskUser $oHelpdeskUser, array $aPostIds )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $aPostIds
Returns
boolean
|
public
boolean
|
#
archiveThreads( CHelpdeskUser $oHelpdeskUser, array $aThreadIds, boolean $bSetArchive = true )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $aThreadIds
- $bSetArchive
- = true
Returns
boolean
|
public
boolean
|
#
archiveOutdatedThreads( )
|
public
boolean
|
#
notificateOutdatedThreads( )
|
public
CHelpdeskThread |false
|
#
getThreadById( CHelpdeskUser $oHelpdeskUser, integer $iIdThread )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $iIdThread
Returns
|
public
integer
|
#
getThreadIdByHash( integer $iTenantID, string $sHash )
Parameters
Returns
integer
|
public
boolean
|
#
createThread( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread & $oHelpdeskThread )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $oHelpdeskThread
- Helpdesk thread object
Returns
boolean
|
public
boolean
|
#
updateThread( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $oHelpdeskThread
- Helpdesk thread object
Returns
boolean
|
public
boolean|integer
|
#
getNextHelpdeskIdForMonitoring( )
|
public
boolean
|
#
startHelpdeskMailboxMonitor( )
|
public
integer
|
#
getHelpdeskMailboxLastUid( $iIdTenant, $sEmail )
|
public
boolean
|
#
setHelpdeskMailboxLastUid( $iIdTenant, $sEmail, $iLastUid )
|
public
boolean
|
#
startMailboxMonitor( integer $iIdTenant )
Parameters
Returns
boolean
|
public
boolean
|
#
startMailboxMonitorPrev( integer $iIdTenant )
Parameters
Returns
boolean
|
public
integer
|
#
getThreadsCount( CHelpdeskUser $oHelpdeskUser, integer $iFilter = EHelpdeskThreadFilterType::All , string $sSearch = '' )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $iFilter
- Default value is 0 EHelpdeskThreadFilterType::All.
- $sSearch
- = ''
Returns
integer
|
public
integer
|
#
getThreadsPendingCount( integer $iTenantId )
Parameters
- $iTenantId
- Default value is 0.
Returns
integer
|
public
array|boolean
|
#
getThreads( CHelpdeskUser $oHelpdeskUser, integer $iOffset = 0, integer $iLimit = 20, integer $iFilter = EHelpdeskThreadFilterType::All , string $sSearch = '' )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $iOffset
- Default value is 0.
- $iLimit
- Default value is 20.
- $iFilter
- Default value is 0 EHelpdeskThreadFilterType::All
- $sSearch
- Default value is empty string.
Returns
array|boolean
|
public
integer
|
#
getPostsCount( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $oThread
- Helpdesk thread object
Returns
integer
|
public
array|boolean
|
#
getThreadsLastPostIds( CHelpdeskUser $oHelpdeskUser, array $aThreadIds )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $aThreadIds
Returns
array|boolean
|
public
array|boolean
|
#
getAttachments( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $oHelpdeskThread
- Helpdesk thread object
Returns
array|boolean
|
public
array|boolean
|
#
getPosts( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread, integer $iStartFromId = 0, integer $iLimit = 20 )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $oThread
- Helpdesk thread object
- $iStartFromId
- Default value is 0.
- $iLimit
- Default value is 20.
Returns
array|boolean
|
public
array|boolean
|
#
getExtPostsCount( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $oThread
- Helpdesk thread object
Returns
array|boolean
|
public
boolean
|
#
clearAllOnline( integer $iTimeoutInMin = 15 )
Parameters
- $iTimeoutInMin
- Default value is 15.
Returns
boolean
|
public
array|boolean
|
#
getOnline( CHelpdeskUser $oHelpdeskUser, integer $iThreadID )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $iThreadID
Returns
array|boolean
|
public
boolean
|
#
setOnline( CHelpdeskUser $oHelpdeskUser, integer $iThreadID )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $iThreadID
Returns
boolean
|
public
|
#
NotifyForgot( CHelpdeskUser $oHelpdeskUser )
Parameters
- $oHelpdeskUser
- Helpdesk user object
|
public
boolean
|
#
NotifyRegistration( CHelpdeskUser $oHelpdeskUser, boolean $bCreateFromFetcher = false )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $bCreateFromFetcher
- Default value is false.
Returns
boolean
|
public
|
#
sendPostNotify( CHelpdeskThread $oThread, CHelpdeskPost $oPost, boolean $bIsNew, string $sCc, string $sBcc )
Parameters
- $oThread
- Helpdesk thread object
- $oPost
- Helpdesk post object
- $bIsNew
- Default value is false.
- $sCc
- Default value is empty string.
- $sBcc
- Default value is empty string.
|
public
|
#
notifyOutdated( CHelpdeskThread $oThread )
Parameters
- $oThread
- Helpdesk thread object
|
public
boolean
|
#
createPost( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread, CHelpdeskPost $oPost, boolean $bIsNew = false, boolean $bSendNotify = true, string $sCc = '', string $sBcc = '' )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $oThread
- Helpdesk thread object
- $oPost
- Helpdesk post object
- $bIsNew
- Default value is false.
- $bSendNotify
- Default value is true.
- $sCc
- Default value is empty string.
- $sBcc
- Default value is empty string.
Returns
boolean
|
public
boolean
|
#
setThreadSeen( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )
Parameters
- $oHelpdeskUser
- Helpdesk user object
- $oHelpdeskThread
- Helpdesk thread object
Returns
boolean
|
public
boolean
|
#
clearUnregistredUsers( )
|