Avaya Client Services API Reference (iOS)
Instance Methods | Properties | List of all members
CSVisualVoiceMailService Class Reference

Service interface for visual voicemail, providing visual voicemail service retrieve and delete voice messages, mark messages as read and unread. More...

#import <CSVisualVoiceMailService.h>

Inherits NSObject.

Instance Methods

(void) - retrieveAllMessages:
 Retrieve visual voicemail messages for the user. More...
 
(void) - deleteMessage:completionHandler:
 Delete visual voicemail message. More...
 

Properties

id< CSVisualVoiceMailServiceDelegatedelegate
 The delegate responsible for visual voicemail events. More...
 
CSCapabilityretrieveMessagesCapability
 Returns an indication of whether the visual voicemail messages can be retrieved. More...
 
CSCapabilitydeleteMessagesCapability
 Returns an indication of whether the visual voicemail messages can be deleted. More...
 
BOOL hasUnreadMessages
 Returns whether the user has unread voice messages. More...
 
NSUInteger unreadMessageCount
 Get number of unread voice messages. More...
 
BOOL serviceAvailable
 Report the service availability status. More...
 

Detailed Description

Service interface for visual voicemail, providing visual voicemail service retrieve and delete voice messages, mark messages as read and unread.

Method Documentation

- (void) deleteMessage: (CSVisualVoiceMailMessage *)  visualVoiceMailMessage
completionHandler: (CSVisualVoiceMailCompletionHandler handler 

Delete visual voicemail message.

Parameters
visualVoiceMailMessageThe CSVisualVoiceMailMessage for this operation.
handlerCSMessagingCompletionHandler for this operation
- (void) retrieveAllMessages: (CSDataRetrievalWatcher *)  watcher

Retrieve visual voicemail messages for the user.

Parameters
watcherWatcher.

Property Documentation

- (id<CSVisualVoiceMailServiceDelegate>) delegate
readwritenonatomicweak

The delegate responsible for visual voicemail events.

- (CSCapability*) deleteMessagesCapability
readnonatomicassign

Returns an indication of whether the visual voicemail messages can be deleted.

Returns
Capability object describing whether the visual voicemail messages can be deleted.
- (BOOL) hasUnreadMessages
readnonatomicassign

Returns whether the user has unread voice messages.

Returns
True if user has unread voice messages.
- (CSCapability*) retrieveMessagesCapability
readnonatomicassign

Returns an indication of whether the visual voicemail messages can be retrieved.

Returns
Capability object describing whether the visual voicemail messages can be retrieved.
- (BOOL) serviceAvailable
readnonatomicassign

Report the service availability status.

- (NSUInteger) unreadMessageCount
readnonatomicassign

Get number of unread voice messages.

Returns
The unread message count.

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