Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Instance Methods | List of all members
<CSContactServiceDelegate> Protocol Reference

Describes methods that are implemented by the delegate of a `CSContactService`. More...

`#import <CSContactService.h>`

Inherits <NSObjectNSObject>.

## Instance Methods
(void) | - contactServiceAvailable:
| Called when the contact service becomes available for use. More...
(void) | - contactServiceUnavailable:
| Called when the contact service becomes unavailable for use. More...
(void) | - contactService:providerForSourceType:didFailWithError:
| Called when an underlying contact provider fails. More...
(void) | - contactService:loadContactsCompleteForSource:doneLoadingAllSources:
| Called when contact loading from an underlying provider completed. More...
(void) | - contactService:loadContactsFailedWithError:forSource:doneLoadingAllSources:
| Called when contact loading from an underlying provider fails. More...
(void) | - contactService:loadContactGroupsFailedWithError:forSource:
| Called when contact groups loading from an underlying provider fails. More...
(void) | - contactServiceDidReloadData:
| Called when the list of available contact providers changes. More...
(void) | - contactServiceDidChangeCapabilities:
| Called when any of the contact service's capabilities changes. More...
(void) | - contactService:didAddContacts:
| Called when contact were added. More...
(void) | - contactService:didDeleteContacts:
| Called when contacts were deleted. More...
(void) | - contactService:didAddContactGroups:
| Called when contact groups were added. More...
(void) | - contactService:didDeleteContactGroups:
| Called when contact groups were deleted. More...
(void) | - contactService:didUpdateSelfContact:
| Called when there is an update to contact information for the currently logged-in user. More...

## Detailed Description

Describes methods that are implemented by the delegate of a `CSContactService`.

## Method Documentation

- (void) contactService: |  | (CSContactService *) | contactService
didAddContactGroups: |  | (NSSet< CSContactGroup * > *) | contactGroups

Called when contact groups were added.

Parameters

  contactService | The contact service associated with the callback.
  contactGroups | set of added contact groups.

- (void) contactService: |  | (CSContactService *) | contactService
didAddContacts: |  | (NSArray *) | contacts

Called when contact were added.

Parameters

  contactService | The contact service associated with the callback.
  contacts | vector of added contacts.

- (void) contactService: |  | (CSContactService *) | contactService
didDeleteContactGroups: |  | (NSSet< CSContactGroup * > *) | contactGroups

Called when contact groups were deleted.

Parameters

  contactService | The contact service associated with the callback.
  contactGroups | set of deleted contact groups.

- (void) contactService: |  | (CSContactService *) | contactService
didDeleteContacts: |  | (NSArray *) | contacts

Called when contacts were deleted.

Parameters

  contactService | The contact service associated with the callback.
  contacts | vector of deleted contacts.

- (void) contactService: |  | (CSContactService *) | contactService
didUpdateSelfContact: |  | (CSContact *) | contact

Called when there is an update to contact information for the currently logged-in user.

Parameters

  contactService | The contact service associated with the callback.
  contact | contact information for the currently logged-in user.

See also
  -[retrieveSelfContactWithCompletionHandler:]

- (void) contactService: |  | (CSContactService *) | contactService
loadContactGroupsFailedWithError: |  | (NSError *) | error
forSource: |  | (CSContactSourceType) | source

Called when contact groups loading from an underlying provider fails.

Parameters

  contactService | The contact service associated with the callback.
  error | The reason for contact groups not being loaded
  source | The source that could not loading contact groups

- (void) contactService: |  | (CSContactService *) | contactService
loadContactsCompleteForSource: |  | (CSContactSourceType) | source
doneLoadingAllSources: |  | (BOOL) | done

Called when contact loading from an underlying provider completed.

Parameters

  contactService | The contact service associated with the callback.
  source | The source that is done loading contacts
  done | YES when all sources have completed their attempt to load contacts.

- (void) contactService: |  | (CSContactService *) | contactService
loadContactsFailedWithError: |  | (NSError *) | error
forSource: |  | (CSContactSourceType) | source
doneLoadingAllSources: |  | (BOOL) | done

Called when contact loading from an underlying provider fails.

Parameters

  contactService | The contact service associated with the callback.
  error | the reason for contacts not being loaded
  source | The source that is done loading contacts
  done | YES when all sources have completed their attempt to load contacts, UI can ignore the source type when this set to YES, NO if some sources are still loading.

- (void) contactService: |  | (CSContactService *) | contactService
providerForSourceType: |  | (CSContactSourceType) | sourceType
didFailWithError: |  | (NSError *) | error

Called when an underlying contact provider fails.

Parameters

  contactService | The contact service associated with the callback.
  sourceType | The contact source type that the failed provider is responsible for.
  error | The error code for the failure.

- (void) contactServiceAvailable: |  | (CSContactService *) | contactService |

Called when the contact service becomes available for use.

Parameters

  contactService | The contact service associated with the callback.

- (void) contactServiceDidChangeCapabilities: |  | (CSContactService *) | contactService |

Called when any of the contact service's capabilities changes.

Parameters

  contactService | The contact service associated with the callback.

- (void) contactServiceDidReloadData: |  | (CSContactService *) | contactService |

Called when the list of available contact providers changes.

For example, if ACS provider has stopped working, an event will be triggered.

Parameters

  contactService | The contact service associated with the callback.

- (void) contactServiceUnavailable: |  | (CSContactService *) | contactService |

Called when the contact service becomes unavailable for use.

Parameters

  contactService | The contact service associated with the callback.

The documentation for this protocol was generated from the following file:

- CSContactService.h