Avaya Client Services API Reference (iOS)
|
Represents contact group object which exposes all possible contact group details. More...
#import <CSContactGroup.h>
Inherits NSObject.
Instance Methods | |
(void) | - renameGroup:completionHandler: |
Renames group. More... | |
(void) | - addContacts:completionHandler: |
Adds new contacts to a group. More... | |
(void) | - removeContacts:completionHandler: |
Removes contacts from a group. More... | |
Properties | |
id< CSContactGroupDelegate > | delegate |
This delegate responsible for handling updates for this contact group. More... | |
NSString * | name |
Name of the group of contacts. More... | |
NSSet< CSContact * > * | groupMembers |
Set of contacts associated with group. More... | |
CSCapability * | renameGroupCapability |
Capability indicating whether this contact group can be renamed. More... | |
CSCapability * | addContactsCapability |
Capability indicating whether this contact group can add new contacts. More... | |
CSCapability * | removeContactsCapability |
Capability indicating whether this contact group can remove contacts. More... | |
Represents contact group object which exposes all possible contact group details.
It allows to add and remove contacts to/from group and update name of the group.
Contact groups can be created by using ContactService method createContactGroupWithName:name members:members completionHandler:completionHandler and deleted by method deleteContactGroup:(CSContactGroup *)group completionHandler:completionHandler.
- (void) addContacts: | (NSSet< CSContact * > *) | contacts | |
completionHandler: | (void(^)(NSError *error)) | completionHandler | |
Adds new contacts to a group.
Operation fails if at least one contact can't be added to a group due to capability not allowed. Entire collection remains unchanged in this case. Providing contact as argument which already exists in group treated as Success operation.
contacts | Set of CSContact objects to be added to a group |
completionHandler | A block to be called when the operation is completed. If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error. |
- (void) removeContacts: | (NSSet< CSContact * > *) | contacts | |
completionHandler: | (void(^)(NSError *error)) | completionHandler | |
Removes contacts from a group.
Operation fails if at least one contact can't be removed from group due to capability not allowed. Entire collection remains unchanged in this case. Providing contact as argument which doesn't exist in group treated as Success operation.
contacts | array of CSContact objects to be removed from a group |
completionHandler | A block to be called when the operation is completed. If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error. |
- (void) renameGroup: | (NSString *) | newName | |
completionHandler: | (void(^)(NSError *error)) | completionHandler | |
Renames group.
Renaming of the group results in raising 2 events on CSContactServiceDelegate - didDeleteContactGroups and didAddContactGroups.
newName | New name of the group of contacts. Group name length is limited by the server. There are some characters not allowed to be present in group name (< > , "). |
completionHandler | A block to be called when the operation is completed. If the operation was successful this parameter is nil. If an error occurred it contains an object describing the error. |
|
readnonatomicassign |
Capability indicating whether this contact group can add new contacts.
|
readwritenonatomicweak |
This delegate responsible for handling updates for this contact group.
|
readnonatomicassign |
Set of contacts associated with group.
|
readnonatomicassign |
Name of the group of contacts.
|
readnonatomicassign |
Capability indicating whether this contact group can remove contacts.
|
readnonatomicassign |
Capability indicating whether this contact group can be renamed.