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

  • CApiHelpdeskCommandCreator
  • CApiHelpdeskCommandCreatorMySQL
  • CApiHelpdeskCommandCreatorPostgreSQL
  • CApiHelpdeskDbStorage
  • CApiHelpdeskStorage

Class CApiHelpdeskCommandCreator

api_CommandCreator
Extended by CApiHelpdeskCommandCreator

Direct known subclasses

CApiHelpdeskCommandCreatorMySQL, CApiHelpdeskCommandCreatorPostgreSQL

Package: Helpdesk\Storages
Internal
Located at helpdesk/storages/db/command_creator.php

Methods summary

protected string
# _getUserByWhere( string $sWhere )

Parameters

$sWhere

Returns

string
public string
# getUserById( integer $iIdTenant, integer $iHelpdeskUserId )

Parameters

$iIdTenant
$iHelpdeskUserId

Returns

string
public string
# getUserByIdWithoutTenantID( integer $iHelpdeskUserId )

Parameters

$iHelpdeskUserId

Returns

string
public string
# getUserByEmail( integer $iIdTenant, string $sEmail )

Parameters

$iIdTenant
$sEmail

Returns

string
public string
# getUserByNotificationEmail( integer $iIdTenant, string $sEmail )

Parameters

$iIdTenant
$sEmail

Returns

string
public
# getUserBySocialId( $iIdTenant, $sSocialId )
public string
# getUserByActivateHash( integer $iIdTenant, string $sActivateHash )

Parameters

$iIdTenant
$sActivateHash

Returns

string
public string
# getAgentsEmailsForNotification( integer $iIdTenant )

Parameters

$iIdTenant

Returns

string
public string
# getNextHelpdeskIdForMonitoring( $iLimitAddInMin = 5 )

Returns

string
public string
# updateHelpdeskFetcherTimer( integer $iIdTenant )

Parameters

$iIdTenant

Returns

string
public string
# getHelpdeskMailboxLastUid( integer $iIdTenant, string $sEmail )

Parameters

$iIdTenant
$sEmail

Returns

string
public string
# addHelpdeskMailboxLastUid( integer $iIdTenant, string $sEmail, integer $iLastUid )

Parameters

$iIdTenant
$sEmail
$iLastUid

Returns

string
public string
# clearHelpdeskMailboxLastUid( integer $iIdTenant, string $sEmail )

Parameters

$iIdTenant
$sEmail

Returns

string
public string
# isUserExists( CHelpdeskUser $oHelpdeskUser, integer $niExceptUserId = null )

Parameters

$oHelpdeskUser
$niExceptUserId
Default value is null.

Returns

string
public string
# userInformation( CHelpdeskUser $oHelpdeskUser, array $aIdList )

Parameters

$oHelpdeskUser
$aIdList

Returns

string
public string
# createUser( CHelpdeskUser $oHelpdeskUser )

Parameters

$oHelpdeskUser

Returns

string
public string
# updateUser( CHelpdeskUser $oHelpdeskUser )

Parameters

$oHelpdeskUser

Returns

string
public string
# setUserAsBlocked( integer $iIdTenant, integer $iIdHelpdeskUser )

Parameters

$iIdTenant
$iIdHelpdeskUser

Returns

string
public string
# deleteUser( integer $iIdTenant, integer $iIdHelpdeskUser )

Parameters

$iIdTenant
$iIdHelpdeskUser

Returns

string
public string
# archiveThreads( CHelpdeskUser $oHelpdeskUser, array $aThreadIds, boolean $bSetArchive = true )

Parameters

$oHelpdeskUser
$aThreadIds
$bSetArchive
Default value is true.

Returns

string
public string
# archiveOutdatedThreads( )

Returns

string
public string
# nextOutdatedThreadForNotificate( )

Returns

string
public string
# setOutdatedThreadNotificated( integer $iIdTenant, integer $iIdHelpdeskThread )

Parameters

$iIdTenant
$iIdHelpdeskThread

Returns

string
public string
# deletePosts( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread, array $aPostIds )

Parameters

$oHelpdeskUser
$oThread
$aPostIds

Returns

string
public string
# clearUnregistredUsers( )

Returns

string
public string
# getThreadIdByHash( integer $iTenantID, string $sHash )

Parameters

$iTenantID
$sHash

Returns

string
public string
# getThreadById( CHelpdeskUser $oHelpdeskUser, integer $iIdThread )

Parameters

$oHelpdeskUser
$iIdThread

Returns

string
public string
# createThread( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )

Parameters

$oHelpdeskUser
$oHelpdeskThread

Returns

string
public string
# updateThread( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )

Parameters

$oHelpdeskUser
$oHelpdeskThread

Returns

string
public string
# getThreadsCount( CHelpdeskUser $oHelpdeskUser, integer $iFilter = EHelpdeskThreadFilterType::All, string $sSearch = '', integer $iSearchOwner = 0 )

Parameters

$oHelpdeskUser
$iFilter
Default value is 0 EHelpdeskThreadFilterType::All.
$sSearch
Default value is empty string.
$iSearchOwner
Default value is 0.

Returns

string
public string
# getThreadsPendingCount( integer $iTenantId )

Parameters

$iTenantId
Default value is 0.

Returns

string
public string
# getThreads( CHelpdeskUser $oHelpdeskUser, integer $iOffset = 0, integer $iLimit = 20, integer $iFilter = EHelpdeskThreadFilterType::All, string $sSearch = '', integer $iSearchOwner = 0 )

Parameters

$oHelpdeskUser
$iOffset
Default value is 0.
$iLimit
Default value is 20.
$iFilter
Default value is 0 EHelpdeskThreadFilterType::All.
$sSearch
Default value is empty string.
$iSearchOwner
Default value is 0.

Returns

string
public string
# getThreadsLastPostIds( CHelpdeskUser $oHelpdeskUser, array $aThreadIds )

Parameters

$oHelpdeskUser
$aThreadIds

Returns

string
public string
# verifyThreadIdsBelongToUser( CHelpdeskUser $oHelpdeskUser, array $aThreadIds )

Parameters

$oHelpdeskUser
$aThreadIds

Returns

string
public string
# verifyPostIdsBelongToUser( CHelpdeskUser $oHelpdeskUser, array $aPostIds )

Parameters

$oHelpdeskUser
$aPostIds

Returns

string
public string
# getPostsCount( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread )

Parameters

$oHelpdeskUser
$oThread

Returns

string
public string
# getExtPostsCount( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread )

Parameters

$oHelpdeskUser
$oThread

Returns

string
public string
# getPosts( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread, integer $iStartFromId = 0, integer $iLimit = 20 )

Parameters

$oHelpdeskUser
$oThread
$iStartFromId
Default value is 0.
$iLimit
Default value is 20.

Returns

string
public string
# getAttachments( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )

Parameters

$oHelpdeskUser
$oHelpdeskThread

Returns

string
public string
# addAttachments( array $aAttachments )

Parameters

$aAttachments

Returns

string
public string
# createPost( CHelpdeskUser $oHelpdeskUser, CHelpdeskPost $oHelpdeskPost )

Parameters

$oHelpdeskUser
$oHelpdeskPost

Returns

string
public string
# clearThreadSeen( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )

Parameters

$oHelpdeskUser
$oHelpdeskThread

Returns

string
public string
# setThreadSeen( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )

Parameters

$oHelpdeskUser
$oHelpdeskThread

Returns

string
public string
# getOnline( CHelpdeskUser $oHelpdeskUser, integer $iThreadID, integer $iTimeoutInMin = 5 )

Parameters

$oHelpdeskUser
$iThreadID
$iTimeoutInMin
Default value is 5.

Returns

string
public string
# clearOnline( CHelpdeskUser $oHelpdeskUser, integer $iThreadID )

Parameters

$oHelpdeskUser
$iThreadID

Returns

string
public string
# clearAllOnline( integer $iTimeoutInMin = 15 )

Parameters

$iTimeoutInMin
Default value is 15.

Returns

string
public string
# setOnline( CHelpdeskUser $oHelpdeskUser, integer $iThreadID )

Parameters

$oHelpdeskUser
$iThreadID

Returns

string
AfterLogic API Documentation API documentation generated by ApiGen