Class CApiGcontactsManager

Class CApiGcontactsManager is used for work with global contacts.

AApiManagerWithStorage

Extended by

CApiGcontactsManager

Package: GContacts
Located at gcontacts/manager.php

Methods summary

`public`	# `__construct( CApiGlobalManager & $oManager, string $sForcedStorage = '' )` Creates a new instance of the object. Creates a new instance of the object. Parameters `$oManager` $oManager Global manager object. `$sForcedStorage` = ''. If it is specified it is used as storage name instead of name obtained by type.
`protected CAccount`	# `_getDefaultAccount( CAccount $oAccount )` Obtains default account for another account of it's bundle. Obtains default account for another account of it's bundle. Parameters `$oAccount` Account object belonging to the found default account. Returns `CAccount` \| null
`public integer`	# `getContactItemsCount( CAccount $oAccount, string $sSearch = '' )` Obtains count of all global contacts found by search string for specified account. Obtains count of all global contacts found by search string for specified account. Parameters `$oAccount` Account object. `$sSearch` = ''. Search string. Returns integer
`public array\|boolean`	# `getContactItems( CAccount $oAccount, integer $iSortField = EContactSortField::Name, integer $iSortOrder = ESortOrder::ASC, integer $iOffset = 0, integer $iRequestLimit = 20, string $sSearch = '' )` Obtains all global contacts by search-string for specified account. Obtains all global contacts by search-string for specified account. Parameters `$oAccount` Account object. `$iSortField` = EContactSortField::Name. Sort field for sorting contact list. `$iSortOrder` = ESortOrder::ASC. Sort order for sorting contact list. `$iOffset` = 0. Offset value for obtaining a partial list. `$iRequestLimit` = 20. Limit value for obtaining a partial list. `$sSearch` = ''. Search string. Returns array\|boolean
`public CContact\|boolean`	# `getContactById( CAccount $oAccount, mixed $mGlobalContactId, boolean $bIgnoreHideInGab = false )` Obtains contact by identifier for specified account. Obtains contact by identifier for specified account. Parameters `$oAccount` Account object. `$mGlobalContactId` Global contact identifier. `$bIgnoreHideInGab` = false. If true all global contacts will be checked including marked as "hide in global address book". Returns CContact\|boolean
`public CContact\|boolean`	# `getContactByTypeId( CAccount $oAccount, mixed $mGlobalContactTypeId, boolean $bIgnoreHideInGab = false )` Obtains contact by type identifier for specified account. Obtains contact by type identifier for specified account. Parameters `$oAccount` Account object. `$mGlobalContactTypeId` Global contact type identifier. `$bIgnoreHideInGab` = false. If true all global contacts will be checked including marked as "hide in global address book". Returns CContact\|boolean
`public CContact\|boolean`	# `getContactByMailingListId( mixed $iMailingListID )` Obtains contact by mailing list identifier. Obtains contact by mailing list identifier. Parameters `$iMailingListID` Mailing list identifier. Returns CContact\|boolean
`public CContact\|boolean`	# `getContactByEmail( CAccount $oAccount, string $sEmail )` Obtains contact by email for specified account. Obtains contact by email for specified account. Parameters `$oAccount` Account object. `$sEmail` Contact email. Returns CContact\|boolean
`public boolean`	# `updateContact( CContact $oContact )` Updates contact data by contact object. Updates contact data by contact object. Parameters `$oContact` Contact object. Returns boolean
`public boolean`	# `syncMissingGlobalContacts( )` Looks for contacts in the address book belonging to the user or the mailing list, and if not found, adds them to the address book. Looks for contacts in the address book belonging to the user or the mailing list, and if not found, adds them to the address book. Returns boolean