Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

- File List
- File Members

Classes | Enumerations | Variables
CSContact.h File Reference
`#import <Foundation/Foundation.h>`
`#import "CSCapability.h"`
`#import "CSContactBoolField.h"`
`#import "CSContactDoubleField.h"`
`#import "CSContactEmailAddressField.h"`
`#import "CSContactField.h"`
`#import "CSContactIMAddressField.h"`
`#import "CSContactPhoneField.h"`
`#import "CSContactStringField.h"`
`#import "CSPhysicalAddress.h"`
`#import "CSPresence.h"`
`#import "CSContactEmailFieldList.h"`
`#import "CSContactPhoneFieldList.h"`
`#import "CSContactIMAddressFieldList.h"`
`#import "CSContactStringFieldList.h"`
`#import "CSContactProtocol.h"`
`#import "CSDefines.h"`

## Classes
class | CSContact
| Represents an immutable contact object which exposes all possible contact details. More...
protocol | <CSContactDelegate>
| Describes methods that are implemented by the delegate of a `CSContact`. More...

## Enumerations
enum | CSContactSourceType { CSContactSourceTypeLocal, CSContactSourceTypeEnterprise, CSContactSourceTypeAll }
| The contact source type used at the binding to filter the get contacts. More...
enum | CSMatchedContactLevel { CSMatchedContactExactType1, CSMatchedContactExactType2, CSMatchedContactExactType3, CSMatchedContactExactType4, CSMatchedContactExactType5, CSMatchedContactPartialType1, CSMatchedContactPartialType2, CSMatchedContactPartialType3, CSMatchedContactPartialType4, CSMatchedContactPartialType5, CSNoMatch }
enum | CSAccessControlBehavior { CSAccessControlBehaviorNone, CSAccessControlBehaviorPrompt }
| Enumeration that describes the types of the ACL-confirm policy handling. More...

## Variables
CS_EXTERN NSString *const | kCSContactExtraFieldNativeId
| Unique ID for contacts from ContactSourceType.Local source. More...

## Enumeration Type Documentation

enum CSAccessControlBehavior

Enumeration that describes the types of the ACL-confirm policy handling.

When a request to start watching presence of some user is issued by the client the presence server the client is connected to relies on Access Information Control policy, also known as Access Control List (ACL), to decide whether the requesting user has permissions to get the presence of the desired user.

The ACL policy applies to a particular presentity and has the following three options:

- "ALLOW" means all requests are to be serviced and presence is provided to the requesting user.
- "BLOCK" means all requests are politely ignored by a presence server and presence is not provided.
- "CONFIRM" means that a presence request is serviced only if the remote user (presentity) explicitly allows that via a pop-up dialog.

The "CONFIRM" option implies that each presence watcher request results in a pop-up message displayed on a presentity side which may introduce undesired distraction and bad experience for the remote user.

The CSAccessControlBehavior setting can be used to avoid this behavior when the start presence request is issued.

- If set to CSAccessControlBehaviorNone, "CONFIRM" policy would be treated as "BLOCK" by the presence server.
- If set to CSAccessControlBehaviorPrompt, "CONFIRM" policy will result in requesting the remote user to explicitly allow watching their presence.

Enumerator
CSAccessControlBehaviorNone | "CONFIRM" policy would be treated as "BLOCK" by the presence server.
CSAccessControlBehaviorPrompt | "CONFIRM" policy will result in requesting the remote user to explicitly allow watching their presence.

enum CSContactSourceType

The contact source type used at the binding to filter the get contacts.

Enumerator
CSContactSourceTypeLocal |
CSContactSourceTypeEnterprise |
CSContactSourceTypeAll |

enum CSMatchedContactLevel

Enumerator
CSMatchedContactExactType1 | If the addresses being compared are dialstrings, feature access codes, or phone numbers then this is an exact match after any alphanumeric characters are converted to digits and any visual separators are removed If the addresses being compared are URI's then this an exact match as defined by RFC3261 section 19.1.4.
CSMatchedContactExactType2 | At least one of the addresses was a URI. The phone number(s) extracted from the URI match in a normalized format.
CSMatchedContactExactType3 | Reserved for future use.
CSMatchedContactExactType4 | Reserved for future use.
CSMatchedContactExactType5 | Reserved for future use.
CSMatchedContactPartialType1 | The phone number and/or phone numbers extracted from a URI match the rightmost 10 digits.
CSMatchedContactPartialType2 | Reserved for future use.
CSMatchedContactPartialType3 | Reserved for future use.
CSMatchedContactPartialType4 | Reserved for future use.
CSMatchedContactPartialType5 | Reserved for future use.
CSNoMatch | There is no matched contact.

## Variable Documentation

CS_EXTERN NSString* const kCSContactExtraFieldNativeId

Unique ID for contacts from ContactSourceType.Local source.