NIMSystemNotificationManager Protocol Reference

Conforms to NSObject
Declared in NIMSystemNotificationManagerProtocol.h

Overview

System notification protocol

– fetchSystemNotifications:limit: required method

Get a system message stored locally

- (nullable NSArray<NIMSystemNotification*> *)fetchSystemNotifications:(nullable NIMSystemNotification *)notification limit:(NSInteger)limit

Parameters

notification

The current earliest system message, if not system notification exist, pass in nil.
limit

the maximum allowed messages

Return Value

list of system notifications

Discussion

Get a system message stored locally

Declared In

NIMSystemNotificationManagerProtocol.h

– fetchSystemNotifications:limit:filter: required method

Get a system message stored locally

- (nullable NSArray<NIMSystemNotification*> *)fetchSystemNotifications:(nullable NIMSystemNotification *)notification limit:(NSInteger)limit filter:(nullable NIMSystemNotificationFilter *)filter

Parameters

notification

The current earliest system message, if not system notification exist, pass in nil.
limit

the maximum allowed messages
filter

filter

Return Value

list of system notifications

Discussion

Get a system message stored locally

Declared In

NIMSystemNotificationManagerProtocol.h

– allUnreadCount required method

Unread count of system messages

- (NSInteger)allUnreadCount

Return Value

Unread count of system messages

Discussion

Unread count of system messages

Declared In

NIMSystemNotificationManagerProtocol.h

– allUnreadCount: required method

Unread count of system messages

- (NSInteger)allUnreadCount:(nullable NIMSystemNotificationFilter *)filter

Parameters

filter

filter

Return Value

Unread count of system messages

Discussion

Unread count of system messages

Declared In

NIMSystemNotificationManagerProtocol.h

– deleteNotification: required method

Delete a system message

- (void)deleteNotification:(NIMSystemNotification *)notification

Parameters

notification

system message

Discussion

Delete a system message

Declared In

NIMSystemNotificationManagerProtocol.h

– deleteAllNotifications required method

Delete all system notifications

- (void)deleteAllNotifications

Discussion

Delete all system notifications

Declared In

NIMSystemNotificationManagerProtocol.h

– deleteAllNotifications: required method

Delete all system messages hit by the filter

- (void)deleteAllNotifications:(nullable NIMSystemNotificationFilter *)filter

Parameters

filter

filter

Discussion

Delete all system messages hit by the filter

Declared In

NIMSystemNotificationManagerProtocol.h

– markNotificationsAsRead: required method

Mark a system notification as read

- (void)markNotificationsAsRead:(NIMSystemNotification *)notification

Parameters

notification

system message

Discussion

Mark a system notification as read

Declared In

NIMSystemNotificationManagerProtocol.h

– markAllNotificationsAsRead required method

Mark all system notifications as read

- (void)markAllNotificationsAsRead

Discussion

Mark all system notifications as read

Declared In

NIMSystemNotificationManagerProtocol.h

– markAllNotificationsAsRead: required method

Mark all system messages hit by the filter read

- (void)markAllNotificationsAsRead:(nullable NIMSystemNotificationFilter *)filter

Parameters

filter

filter

Discussion

Mark all system messages hit by the filter read

Declared In

NIMSystemNotificationManagerProtocol.h

– sendCustomNotification:toSession:completion: required method

Send custom system notifications

- (void)sendCustomNotification:(NIMCustomSystemNotification *)notification toSession:(NIMSession *)session completion:(nullable NIMSystemNotificationHandler)completion

Parameters

notification

system notification
session

receipient
completion

Completion callback

Discussion

Send custom system notifications

only supports P2P chats and groups. Chat rooms are not supported

Declared In

NIMSystemNotificationManagerProtocol.h

– addDelegate: required method

Add a delegate for system notifications

- (void)addDelegate:(id<NIMSystemNotificationManagerDelegate>)delegate

Parameters

delegate

System notification callback

Discussion

Add a delegate for system notifications

Declared In

NIMSystemNotificationManagerProtocol.h

– removeDelegate: required method

Remove a delegate for system notifications

- (void)removeDelegate:(id<NIMSystemNotificationManagerDelegate>)delegate

Parameters

delegate

System notification callback

Discussion

Remove a delegate for system notifications

Declared In

NIMSystemNotificationManagerProtocol.h