| Methods |
public
|
__construct(AbstractModule $oModule = null)
Creates a new instance of the object.
Creates a new instance of the object.
Overrides
|
#
|
public
|
getContactById(int $iUserId, mixed $mContactId, $sAddressBookName = Constants::ADDRESSBOOK_DEFAULT_NAME): Contact|bool
Returns contact item identified by user ID and contact ID.
Returns contact item identified by user ID and contact ID.
|
#
|
public
|
GetContactByTypeId(mixed $mTypeId, int $iContactType): Contact|bool
//TODO
|
#
|
public
|
getContactByEmail(int $iUserId, string $sEmail): Contact|bool
Returns contact item identified by email address.
Returns contact item identified by email address.
|
#
|
public
|
getContactByStrId(int $iUserId, string $sContactStrId, int $iSharedTenantId = null): Contact
Returns contact item identified by str_id value.
Returns contact item identified by str_id value.
Parameters
| $iSharedTenantId |
. Default value is null
|
|
#
|
public
|
getVCardObjectById(
int $iUserId,
mixed $mContactId,
$sAddressBookName = Constants::ADDRESSBOOK_DEFAULT_NAME,
): resource|bool
Returns contact item identified by user ID and contact ID.
Returns contact item identified by user ID and contact ID.
|
#
|
public
|
getSharedContactIds(int $iUserId, int $iSharedTenantId = null): array|bool
Returns list of shared contacts by str_id value.
Returns list of shared contacts by str_id value.
Parameters
| $iSharedTenantId |
Default value is null
|
|
#
|
public
|
getContactGroupIds(Contact $oContact): array|bool
|
#
|
public
|
getGroupById(int $iUserId, mixed $mGroupId): Group
|
#
|
public
|
getGroupByStrId(int $iUserId, string $sGroupStrId): Group
|
#
|
public
|
getGroupByName(int $iUserId, string $sName): Group
|
#
|
public
|
updateContact(Contact $oContact): bool
|
#
|
public
|
updateContactUserId(Contact $oContact, int $iUserId): string
|
#
|
public
|
updateGroup(Group $oGroup): bool
|
#
|
public
|
getContactItemsCount(
int $iUserId,
string $sSearch = '',
string $sFirstCharacter = '',
int $iGroupId = 0,
int $iTenantId = null,
bool $bAll = false,
): int
Parameters
| $sSearch |
Default value is empty string
|
| $sFirstCharacter |
Default value is empty string
|
| $iGroupId |
Default value is 0
|
| $iTenantId |
Default value is null
|
| $bAll |
Default value is false
|
|
#
|
public
|
getContactItemsWithoutOrder(int $iUserId, int $iOffset = 0, int $iRequestLimit = 20): bool|array
Parameters
| $iOffset |
Default value is 0
|
| $iRequestLimit |
Default value is 20
|
|
#
|
public
|
getContactItems(
int $iSortField = SortField::Email,
int $iSortOrder = SortOrder::ASC,
int $iOffset = 0,
int $iRequestLimit = 20,
array $aFilters = [],
int $iIdGroup = 0,
): boolean
|
#
|
public
|
GetContactItemObjects(string $mUserId): bool|array
|
#
|
public
|
GetMyGlobalContact(int $iUserId): Contact|null
|
#
|
public
|
getGroupItemsCount(int $iUserId, string $sSearch = '', string $sFirstCharacter = ''): int
Parameters
| $sSearch |
Default value is empty string
|
| $sFirstCharacter |
Default value is empty string
|
|
#
|
public
|
getGroupItems(
int $iUserId,
int $iSortField = SortField::Name,
int $iSortOrder = SortOrder::ASC,
int $iOffset = 0,
int $iRequestLimit = 20,
string $sSearch = '',
string $sFirstCharacter = '',
int $iContactId = 0,
): bool|array
Parameters
| $iSortField |
Default value is \Aurora\Modules\Contacts\Enums\SortField::Name 1,
|
| $iSortOrder |
Default value is \Aurora\System\Enums\SortOrder::ASC 0,
|
| $iOffset |
Default value is 0
|
| $iRequestLimit |
Default value is 20
|
| $sSearch |
Default value is empty string
|
| $sFirstCharacter |
Default value is empty string
|
| $iContactId |
Default value is 0
|
|
#
|
public
|
GetAllContactsNamesWithPhones(Account $oAccount): bool|array
|
#
|
public
|
createContact(Contact $oContact): bool
|
#
|
public
|
copyContact($iUserId, $sUID, $sFromAddressbook, $sToAddressbook)
|
#
|
public
|
createGroup(Group $oGroup): bool
|
#
|
public
|
deleteContacts(int $iUserId, array $aContactIds, $sAddressBook = Constants::ADDRESSBOOK_DEFAULT_NAME): bool
|
#
|
public
|
deleteSuggestContacts(int $iUserId, array $aContactIds): bool
|
#
|
public
|
deleteGroups(int $iUserId, array $aGroupIds): bool
|
#
|
public
|
deleteGroup(int $iUserId, mixed $mGroupId): bool
|
#
|
public
|
updateSuggestTable(int $iUserId, array $aEmails): bool
|
#
|
public
|
clearAllContactsAndGroups(int $iUserId): bool
|
#
|
public
|
flushContacts(): bool
|
#
|
public
|
addContactsToGroup(Group $oGroup, array $aContactIds): bool
|
#
|
public
|
removeContactsFromGroup(Group $oGroup, array $aContactIds): bool
|
#
|
public
|
ConvertedContactLocalId(Account $oAccount, mixed $mContactId, string $sStorage = 'global'): mixed
|
#
|
public
|
ConvertedContactLocalIdCollection(Account $oAccount, string $sStorage = 'global'): mixed
|
#
|
public
|
ContactIdsLinkedToGroups(array $aIds): mixed
|
#
|
public
|
GetGlobalContactById(int $iUserId, mixed $mContactId): Contact|bool
|
#
|
public
|
getGroupEvents(int $iGroupId): bool
|
#
|
public
|
getGroupEvent(string $sCalendarId, string $sEventId): bool
|
#
|
public
|
addEventToGroup(int $iGroupId, string $sCalendarId, string $sEventId): bool
|
#
|
public
|
removeEventFromGroup(int $iGroupId, string $sCalendarId, string $sEventId): bool
|
#
|
public
|
removeEventFromAllGroups(string $sCalendarId, string $sEventId): bool
|
#
|
public
|
getAddressBook($iUserId, $sUri)
|
#
|
public
|
createAddressBook($iUserId, $sUri, $sName)
|
#
|
public
|
updateAddressBook($iUserId, $sName, $sNewName)
|
#
|
public
|
deleteAddressBook($iUserId, $sName)
|
#
|