NotificationManager Protocol Reference

Declared in NotificationManager.h

Overview

Interface for the notification delivery system.

Responsible for processing received topic/notification updates, subscribing for optional topic updates and unsubscribing from them.

– addTopicListDelegate: required method

Add delegate for notification topics' list updates.

- (void)addTopicListDelegate:(id<NotificationTopicListDelegate>)delegate

Parameters

delegate

The delegate to receive updates.

Discussion

Add delegate for notification topics' list updates.

Declared In

NotificationManager.h

– removeTopicListDelegate: required method

Remove delegate of notification topics' list updates.

- (void)removeTopicListDelegate:(id<NotificationTopicListDelegate>)delegate

Parameters

delegate

The delegate which no longer needs updates.

Discussion

Remove delegate of notification topics' list updates.

Declared In

NotificationManager.h

– getTopics required method

Retrieve a list of available notification topics.

- (NSArray *)getTopics

Return Value

Array of available topics.

Discussion

Retrieve a list of available notification topics.

Declared In

NotificationManager.h

– addNotificationDelegate: required method

Add delegate to receive all notifications (both for mandatory and optional topics).

- (void)addNotificationDelegate:(id<NotificationDelegate>)delegate

Parameters

delegate

Delegate to receive notifications

Discussion

Add delegate to receive all notifications (both for mandatory and optional topics).

Declared In

NotificationManager.h

– addNotificationDelegate:forTopicId: required method

Add listener to receive notifications relating to the specified topic.

- (void)addNotificationDelegate:(id<NotificationDelegate>)delegate forTopicId:(int64_t)topicId

Parameters

delegate

Delegate to receive notifications.

topicId

Id of topic (both mandatory and optional).

Discussion

Add listener to receive notifications relating to the specified topic.

Listener(s) for optional topics may be added/removed irrespective to whether subscription existed or not.

Exceptions

UnavailableTopicException

Unknown topic id is provided.

Declared In

NotificationManager.h

– removeNotificationDelegate: required method

Remove listener receiving all notifications (both for mandatory and optional topics).

- (void)removeNotificationDelegate:(id<NotificationDelegate>)delegate

Parameters

delegate

Delegate to receive notifications

Discussion

Remove listener receiving all notifications (both for mandatory and optional topics).

Declared In

NotificationManager.h

– removeNotificationDelegate:forTopicId: required method

Remove delegate receiving notifications for the specified topic.

- (void)removeNotificationDelegate:(id<NotificationDelegate>)delegate forTopicId:(int64_t)topicId

Parameters

delegate

Delegate to receive notifications.

topicId

Id of topic (both mandatory and optional).

Discussion

Remove delegate receiving notifications for the specified topic.

Delegate(s) for optional topics may be added/removed irrespective to whether subscription existed or not.

Exceptions

UnavailableTopicException

Unknown topic id is provided.

Declared In

NotificationManager.h

– subscribeToTopicWithId:forceSync: required method

Subscribe to notifications relating to the specified optional topic.

- (void)subscribeToTopicWithId:(int64_t)topicId forceSync:(BOOL)forceSync

Parameters

topicId

Id of a optional topic.

forceSync

Define whether current subscription update should be accepted immediately

Discussion

Subscribe to notifications relating to the specified optional topic.

Exceptions

UnavailableTopicException

Unknown topic id is provided or topic isn’t optional.

Declared In

NotificationManager.h

– subscribeToTopicsWithIDs:forceSync: required method

Subscribe to notifications relating to the specified list of optional topics.

- (void)subscribeToTopicsWithIDs:(NSArray *)topicIds forceSync:(BOOL)forceSync

Parameters

topicIds

Array of optional topic ids.

forceSync

Define whether current subscription update should be accepted immediately.

Discussion

Subscribe to notifications relating to the specified list of optional topics.

Exceptions

UnavailableTopicException

Unknown topic id is provided or topic isn’t optional.

Declared In

NotificationManager.h

– unsubscribeFromTopicWithId:forceSync: required method

Unsubscribe from notifications relating to the specified optional topic.

- (void)unsubscribeFromTopicWithId:(int64_t)topicId forceSync:(BOOL)forceSync

Parameters

topicId

Id of a optional topic.

forceSync

Define whether current subscription update should be accepted immediately.

Discussion

Unsubscribe from notifications relating to the specified optional topic.

All previously added listeners will be removed automatically.

Exceptions

UnavailableTopicException

Unknown topic id is provided or topic isn’t optional.

Declared In

NotificationManager.h

– unsubscribeFromTopicsWithIDs:forceSync: required method

Unsubscribe from notifications relating to the specified array of optional topics.

- (void)unsubscribeFromTopicsWithIDs:(NSArray *)topicIds forceSync:(BOOL)forceSync

Parameters

topicIds

Array of optional topic ids. < NSString >

forceSync

Define whether current subscription update should be accepted immediately.

Discussion

Unsubscribe from notifications relating to the specified array of optional topics.

All previously added listeners will be removed automatically.

Exceptions

UnavailableTopicException

Unknown topic id is provided or topic isn’t optional.

Declared In

NotificationManager.h

– sync required method

Accept optional subscription changes.

- (void)sync

Discussion

Accept optional subscription changes.

Declared In

NotificationManager.h