nim_def.sysmsg_def.NIMSysMsgAPI

Interface: NIMSysMsgAPI

nim_def/sysmsg_def.NIMSysMsgAPI

Table of contents

Methods

• InitEventHandlers
• SendCustomNotificationMsg
• QueryMsgAsync
• QueryUnreadCount
• SetStatusAsync
• ReadAllAsync
• DeleteAsync
• DeleteAllAsync
• SetStatusByTypeAsync
• DeleteByTypeAsync

Methods

InitEventHandlers

▸ InitEventHandlers(): void

Returns

void

Defined in

ts/nim_def/sysmsg_def.ts:66

---

SendCustomNotificationMsg

▸ SendCustomNotificationMsg(msg): void

Parameters

Name	Type
msg	SysMessage

Returns

void

Defined in

ts/nim_def/sysmsg_def.ts:68

---

QueryMsgAsync

▸ QueryMsgAsync(limit_count, last_time, cb, jsonExtension): boolean

Parameters

Name	Type
limit_count	number
last_time	number
cb	null | QuerySysmsgCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/sysmsg_def.ts:70

---

QueryUnreadCount

▸ QueryUnreadCount(cb, jsonExtension): void

Parameters

Name	Type
cb	null | NotifySysmsgResCallback
jsonExtension	string

Returns

void

Defined in

ts/nim_def/sysmsg_def.ts:72

---

SetStatusAsync

▸ SetStatusAsync(msg_id, status, cb, jsonExtension): boolean

Parameters

Name	Type
msg_id	string
status	NIMSysMsgStatus
cb	null | NotifySingleSysmsgCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/sysmsg_def.ts:74

---

ReadAllAsync

▸ ReadAllAsync(cb, jsonExtension): void

Parameters

Name	Type
cb	null | NotifySysmsgResCallback
jsonExtension	string

Returns

void

Defined in

ts/nim_def/sysmsg_def.ts:76

---

DeleteAsync

▸ DeleteAsync(msg_id, cb, jsonExtension): boolean

Parameters

Name	Type
msg_id	string
cb	null | NotifySingleSysmsgCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/sysmsg_def.ts:78

---

DeleteAllAsync

▸ DeleteAllAsync(cb, jsonExtension): boolean

Parameters

Name	Type
cb	null | NotifySysmsgResCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/sysmsg_def.ts:80

---

SetStatusByTypeAsync

▸ SetStatusByTypeAsync(type, status, cb, jsonExtension): boolean

Parameters

Name	Type
type	NIMSysMsgType
status	NIMSysMsgStatus
cb	null | NotifySysmsgResCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/sysmsg_def.ts:82

---

DeleteByTypeAsync

▸ DeleteByTypeAsync(type, cb, jsonExtension): boolean

Parameters

Name	Type
type	NIMSysMsgType
cb	null | NotifySysmsgResCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/sysmsg_def.ts:84