Message Management

This topic describes how to implement message management features based on the Message Management BizBundle SDK, including message content and Do Not Disturb (DND) settings.

Message content

The Message Management BizBundle SDK encapsulates three types of messages: device alerts, home messages, and notification messages.

Query messages

Query the list of messages of the specified type and show them on the page. The following code snippet shows how to query up to 15 device alert messages at a time.

let message = ThingSmartMessage()
let requestModel = ThingSmartMessageListRequestModel()
requestModel.msgType = .alarm
requestModel.limit = 15
requestModel.offset = 0
message.fetchList(with: requestModel) {[weak self] list in
    guard let self = self else {return}
    self.messageList = list
    self.tableView.reloadData()
} failure: { error in

}

Delete messages

When users want to delete messages, first record the message entities selected by users.

func change(selected: Bool, msgId: String) {
  if selected {
      deleteIds.append(msgId)
  } else {
      deleteIds.removeAll { obj in
          obj == msgId
      }
  }
}

Then, call the bulk deletion interface.

let message = ThingSmartMessage()
let requestModel = ThingSmartMessageListDeleteRequestModel()
requestModel.msgIds = deleteIds
requestModel.msgType = .family

message.delete(with: requestModel) { result in
    self.loadData()
} failure: { error in

}

DND management of device alerts

Device alert messages are triggered frequently, so it is necessary to provide users with DND management capabilities. For example, DND on/off, setting DND period, and other related capabilities.

DND on/off

Query DND on/off status

ThingSmartMessageSetting().getDeviceDNDSettingstatusSuccess { result in
	self.settingStatus = result
} failure: { error in

}

Set DND on/off status

let status = sender.isOn
ThingSmartMessageSetting().setDeviceDNDSettingStatus(status) {

} failure: { error in

}

DND settings

Add DND settings

• startTime and endTime: Indicates the start time and end time of the DND setting. No device alert messages will be received during the set period. The following example shows the DND period is from 8:00 a.m. to 12:00 p.m.
• loops: Indicates the days of the week for which this setting is effective. For example, 0111110 means the DND period is effective from Monday to Friday.
• isAllDevIDs: Indicates whether the DND setting applies to all devices.

let setting = ThingSmartMessageSetting()

let requestModel = ThingSmartMessageSettingDNDRequestModel()
requestModel.isAllDevIDs = true
requestModel.startTime = "08:00"
requestModel.endTime = "12:00"
requestModel.loops = "0111110"

setting.addDND(with: requestModel) {
    self.loadData()
} failure: { error in

}

Modify DND settings

After the DND settings are created successfully, users can modify the start time, end time, recurrence cycle, and effective devices. After the settings are modified, call this interface to save the settings.

let startCell = tableView.cellForRow(at: IndexPath(row: 0, section: 0)) as? MessageDNDTimeCell
let endCell = tableView.cellForRow(at: IndexPath(row: 1, section: 0)) as? MessageDNDTimeCell

let requestModel = ThingSmartMessageSettingDNDRequestModel()
requestModel.startTime = startCell?.inputFiled.text ?? ""
requestModel.endTime = endCell?.inputFiled.text ?? ""

var loops = ""
for i in 0..<7 {
    let choose = selectMap[i]
    if let choose = choose, choose {
        loops += "1"
    } else {
        loops += "0"
    }
}
requestModel.loops = loops
requestModel.isAllDevIDs = dndModel?.allDevIds ?? false

ThingSmartMessageSetting().modifyDND(withTimerID: dndModel!.timerId, dndRequestModel: requestModel) {
    self.navigationController?.popViewController(animated: true)
} failure: { error in

}

Delete DND settings

The DND settings can be deleted when users no longer need them.

ThingSmartMessageSetting().removeDND(withTimerID: dndModel?.timerId ?? 0) {
    self.navigationController?.popViewController(animated: true)
} failure: { error in

}

Query the list of DND settings

Users can create multiple DND settings simultaneously, query all settings, and display them on the page.

let setting = ThingSmartMessageSetting()

setting.getDNDListSuccess { result in
    var list : [MessageDNDModel] = []
    if let result = result {
        for obj in result {
            if let data = try? JSONSerialization.data(withJSONObject: obj, options: JSONSerialization.WritingOptions.init())  {
                if var model = try? JSONDecoder.init().decode(MessageDNDModel.self, from: data) {
                    list.append(model)
                }
            }
        }
    }
    self.dndList = list
    self.tableView.reloadData()
} failure: { error in

}

Device alert push notifications

Device alert messages can be pushed via system notifications, phone notifications, and SMS notifications. Each channel has a separate switch. To implement the phone notifications and SMS notifications, you need to subscribe to the value-added services. Please contact your account manager for details.

Query on/off status of push notification channels

Take the alert messages pushed by the system as an example:

let messageSetting = ThingSmartMessagePushSetting()

messageSetting.getDeviceAlarmSwitchStatus(with: .system) { result in
    self.systemSwitch.isOn = result
}

Set on/off status of push notification channels

Take the alert messages pushed by the system as an example:

let messageSetting = ThingSmartMessagePushSetting()
let requestModel = ThingSmartDeviceAlarmSwitchRequestModel()
requestModel.open = self.systemSwitch.isOn
requestModel.pushChannel = .system
messageSetting.setDeviceAlarmSwitchStatusWith(requestModel) {

}

Set a throttling time of push notification channels

The device alert messages are triggered quite frequently. If a message is pushed every time an alert is triggered during the period when push notifications can be received, it might lead to message flooding. Therefore, you need to set a throttling time.

Taking the alert messages pushed by the system as an example, if the throttling time is set to 30 minutes, the interval between alert messages will be no less than 30 minutes.

let messageSetting = ThingSmartMessagePushSetting()
let requestModel = ThingSmartDeviceAlarmThrottleTimeRequestModel()
requestModel.minute = 30
requestModel.pushChannel = .system
messageSetting.setDeviceAlarmThrottleTimeWith(requestModel) { result in

}