• IMLib / IMKit >
 
• 无 UI SDK（IMLib） >
 
• 全局配置 >
 
• 全局免打扰

SDK 支持为当前用户设置全局免打扰时段与免打扰级别。

• 该功能可设置一个从任意时间点（HH:MM:SS）开始的免打扰时间窗口。在再次设置或删除用户免打扰时间段之前，当次设置的免打扰时间窗口会每日重复生效。例如，App 用户希望设置永久全天免打扰，可设置 startTime 为 00:00:00，period 为 1439。
• 单个用户仅支持设置一个时间段，重复设置会覆盖该用户之前设置的时间窗口。

（推荐）在 App 自行实现本地通知处理时，如果检测到客户端 App 已转至后台运行，可通过 SDK 提供的全局免打扰接口决定是否弹出本地通知，以实现全局免打扰的效果。

支持的免打扰级别

为当前用户设置免打扰时间段时，可使用以下免打扰级别：

设置免打扰时间

设置消息通知免打扰时间。在免打扰时间内接收到消息时，会根据该接口设置的免打扰级别判断是否需要推送消息通知。

方法

 
Future<int> changeNotificationQuietHours(String startTime, int spanMinutes, RCIMIWPushNotificationQuietHoursLevel level, {IRCIMIWChangeNotificationQuietHoursCallback? callback});
              

                
已复制
                复制代码
              
              
1

参数说明

返回值

代码示例

 
IRCIMIWChangeNotificationQuietHoursCallback? callback = IRCIMIWChangeNotificationQuietHoursCallback(onNotificationQuietHoursChanged: (int? code) {
//...
});

int? ret = await engine?.changeNotificationQuietHours(startTime, spanMinutes, level, callback:callback);
              

                
已复制
                复制代码
              
              
1
2
3
4
5

回调方法

• onConversationNotificationLevelChanged

 
Function(int? code, RCIMIWConversationType? type, String? targetId, String? channelId, RCIMIWPushNotificationLevel? level)? onConversationNotificationLevelChanged;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onConversationNotificationLevelChanged = (int? code, RCIMIWConversationType? type, String? targetId, String? channelId, RCIMIWPushNotificationLevel? level) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3

移除免打扰时间

您可以调用以下方法, level设置为 none 将免打扰时间段设置移除。

方法

 
Future<int> removeNotificationQuietHours({IRCIMIWRemoveNotificationQuietHoursCallback? callback});
              

                
已复制
                复制代码
              
              
1

返回值

代码示例

 
IRCIMIWRemoveNotificationQuietHoursCallback? callback = IRCIMIWRemoveNotificationQuietHoursCallback(onNotificationQuietHoursRemoved: (int? code) {
//...
});

int? ret = await engine?.removeNotificationQuietHours(callback:callback);
              

                
已复制
                复制代码
              
              
1
2
3
4
5

回调方法

• onNotificationQuietHoursRemoved

 
Function(int? code)? onNotificationQuietHoursRemoved;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onNotificationQuietHoursRemoved = (int? code) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3

获取免打扰时间

您可以通过以下方法获取免打扰时间段设置。在免打扰时间内接收到消息时，会根据当前免打扰级别判断是否需要推送消息通知。

方法

 
Future<int> getNotificationQuietHours({IRCIMIWGetNotificationQuietHoursCallback? callback});
              

                
已复制
                复制代码
              
              
1

返回值

代码示例

 
IRCIMIWGetNotificationQuietHoursCallback? callback = IRCIMIWGetNotificationQuietHoursCallback(onSuccess: (String? startTime, int? spanMinutes, RCIMIWPushNotificationQuietHoursLevel? level) {
//...
}, onError: (int? code) {
//...
});

int? ret = await engine?.getNotificationQuietHours(callback:callback);
              

                
已复制
                复制代码
              
              
1
2
3
4
5
6
7

回调方法

• onNotificationQuietHoursLoaded

 
Function(int? code, String? startTime, int? spanMinutes, RCIMIWPushNotificationQuietHoursLevel? level)? onNotificationQuietHoursLoaded;
              

                
已复制
                复制代码
              
              
1

参数说明

代码示例

 
engine?.onNotificationQuietHoursLoaded = (int? code, String? startTime, int? spanMinutes, RCIMIWPushNotificationQuietHoursLevel? level) {
//...
};
              

                
已复制
                复制代码
              
              
1
2
3