Avaya Client Services API Reference (OS X)
Instance Methods | Properties | List of all members
CSCallPickupAlertParameters Class Reference

The Enhance or Call Pickup alert details. More...

#import <CSCallPickupAlertParameters.h>

Inherits NSObject.

Instance Methods

(instancetype) - initWithCallingName:callingNumber:calledName:calledNumber:ringPattern:ringType:pickupRingerOn:enhancedPickupAlertOn:
 Constructs a CSCallPickupAlertParameters object from the specified parameters. More...
 

Properties

NSString * callingName
 The person's name who has initiated the call. More...
 
NSString * callingNumber
 The person's number who has initiated the call. More...
 
NSString * calledName
 The person's name to whom the call is requested. More...
 
NSString * calledNumber
 The person's number to whom the call is requested. More...
 
CSRingPattern ringPattern
 The ring pattern if configured. More...
 
CSRingType ringType
 The ring type based on which the application shall play different audio files. More...
 
BOOL pickupRingerOn
 Returns true if the pickup ringer status is ON else returns false. More...
 
BOOL enhancedPickupAlertOn
 Returns true if the enhance pickup status is ON else returns false. More...
 

Detailed Description

The Enhance or Call Pickup alert details.

Method Documentation

- (instancetype) initWithCallingName: (NSString *)  callingName
callingNumber: (NSString *)  callingNumber
calledName: (NSString *)  calledName
calledNumber: (NSString *)  calledNumber
ringPattern: (CSRingPattern ringPattern
ringType: (CSRingType ringType
pickupRingerOn: (BOOL)  pickupRingerOn
enhancedPickupAlertOn: (BOOL)  enhancedPickupAlertOn 

Constructs a CSCallPickupAlertParameters object from the specified parameters.

Parameters
callingNameThe caller name.
callingNumberThe caller number.
calledNameThe callee name.
calledNumberThe callee number.
ringPatternThe ring pattern.
ringTypeThe ring type.
pickupRingerOnYES for the pickup ringer ON otherwise NO.
enhancedPickupAlertOnYES for the enhance pickup alert ON otherwise NO.

Property Documentation

- (NSString*) calledName
readnonatomicassign

The person's name to whom the call is requested.

- (NSString*) calledNumber
readnonatomicassign

The person's number to whom the call is requested.

- (NSString*) callingName
readnonatomicassign

The person's name who has initiated the call.

- (NSString*) callingNumber
readnonatomicassign

The person's number who has initiated the call.

- (BOOL) enhancedPickupAlertOn
readnonatomicassign

Returns true if the enhance pickup status is ON else returns false.

- (BOOL) pickupRingerOn
readnonatomicassign

Returns true if the pickup ringer status is ON else returns false.

- (CSRingPattern) ringPattern
readnonatomicassign

The ring pattern if configured.

- (CSRingType) ringType
readnonatomicassign

The ring type based on which the application shall play different audio files.


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