nim_def.session_def.NIMSessionAPI

Interface: NIMSessionAPI

nim_def/session_def.NIMSessionAPI

Table of contents

Methods

• InitEventHandlers
• QueryStickTopSessionList
• SetToStickTopSession
• UpdateToStickTopSession
• CancelToStickTopSession
• QueryLastFewSessionAsync
• QueryAllRecentSessionAsync
• DeleteRecentSession
• DeleteAllRecentSession
• DeleteSessionRoamingMessage
• SetUnreadCountZeroAsync
• SetMultiUnreadCountZeroAsync
• SetSessionTop
• SetSessionExtendData
• SetAllUnreadCountZeroAsync
• QuerySessionDataById
• QueryHasmoreRoammsg
• QueryAllHasmoreRoammsg
• UpdateHasmoreRoammsg
• DeleteHasmoreRoammsg

Methods

InitEventHandlers

▸ InitEventHandlers(): void

Returns

void

Defined in

ts/nim_def/session_def.ts:105

---

QueryStickTopSessionList

▸ QueryStickTopSessionList(cb): void

Parameters

Name	Type
cb	null | QueryStickTopSessionListCallback

Returns

void

Defined in

ts/nim_def/session_def.ts:107

---

SetToStickTopSession

▸ SetToStickTopSession(session_id, to_type, ext, cb): void

Parameters

Name	Type
session_id	string
to_type	number
ext	string
cb	null | SetToStickTopSessionCallback

Returns

void

Defined in

ts/nim_def/session_def.ts:109

---

UpdateToStickTopSession

▸ UpdateToStickTopSession(session_id, to_type, ext, cb): void

Parameters

Name	Type
session_id	string
to_type	number
ext	string
cb	null | UpdateStickTopSessionCallback

Returns

void

Defined in

ts/nim_def/session_def.ts:111

---

CancelToStickTopSession

▸ CancelToStickTopSession(session_id, to_type, cb): void

Parameters

Name	Type
session_id	string
to_type	number
cb	null | CancelToStickTopSessionCallback

Returns

void

Defined in

ts/nim_def/session_def.ts:113

---

QueryLastFewSessionAsync

▸ QueryLastFewSessionAsync(limit, cb, jsonExtension): void

Parameters

Name	Type
limit	number
cb	null | QuerySessionListCallback
jsonExtension	string

Returns

void

Defined in

ts/nim_def/session_def.ts:115

---

QueryAllRecentSessionAsync

▸ QueryAllRecentSessionAsync(msg_excluded_type_list, cb, jsonExtension): void

Parameters

Name	Type
msg_excluded_type_list	NIMMessageType[]
cb	null | QuerySessionListCallback
jsonExtension	string

Returns

void

Defined in

ts/nim_def/session_def.ts:117

---

DeleteRecentSession

▸ DeleteRecentSession(type, id, cb, delete_roaming): void

Parameters

Name	Type
type	NIMSessionType
id	string
cb	null | SessionChangeCallback
delete_roaming	boolean

Returns

void

Defined in

ts/nim_def/session_def.ts:119

---

DeleteAllRecentSession

▸ DeleteAllRecentSession(cb, jsonExtension): void

Parameters

Name	Type
cb	null | SessionChangeCallback
jsonExtension	string

Returns

void

Defined in

ts/nim_def/session_def.ts:121

---

DeleteSessionRoamingMessage

▸ DeleteSessionRoamingMessage(to_type, session_id, cb, ext): boolean

Parameters

Name	Type
to_type	number
session_id	string
cb	null | DeleteSessionRoamingMessageCallback
ext	string

Returns

boolean

Defined in

ts/nim_def/session_def.ts:123

---

SetUnreadCountZeroAsync

▸ SetUnreadCountZeroAsync(type, id, cb, jsonExtension): boolean

Parameters

Name	Type
type	NIMSessionType
id	string
cb	null | SessionChangeCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/session_def.ts:125

---

SetMultiUnreadCountZeroAsync

▸ SetMultiUnreadCountZeroAsync(is_super_team, zero_list, cb): boolean

Parameters

Name	Type
is_super_team	boolean
zero_list	MultiUnreadCountZeroInfo[]
cb	null | SetMultiUnreadCountZeroAsyncCallback

Returns

boolean

Defined in

ts/nim_def/session_def.ts:127

---

SetSessionTop

▸ SetSessionTop(type, id, top, cb, jsonExtension): boolean

Parameters

Name	Type
type	NIMSessionType
id	string
top	boolean
cb	null | SessionChangeCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/session_def.ts:129

---

SetSessionExtendData

▸ SetSessionExtendData(type, id, data, cb, jsonExtension): boolean

Parameters

Name	Type
type	NIMSessionType
id	string
data	string
cb	null | SessionChangeCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/session_def.ts:131

---

SetAllUnreadCountZeroAsync

▸ SetAllUnreadCountZeroAsync(cb, jsonExtension): boolean

Parameters

Name	Type
cb	null | SessionChangeCallback
jsonExtension	string

Returns

boolean

Defined in

ts/nim_def/session_def.ts:133

---

QuerySessionDataById

▸ QuerySessionDataById(type, id, cb, jsonExtension): void

Parameters

Name	Type
type	NIMSessionType
id	string
cb	null | QuerySessionDataCallback
jsonExtension	string

Returns

void

Defined in

ts/nim_def/session_def.ts:135

---

QueryHasmoreRoammsg

▸ QueryHasmoreRoammsg(session_id, to_type, cb): void

Parameters

Name	Type
session_id	string
to_type	number
cb	null | QueryHasmoreRoammsgCallback

Returns

void

Defined in

ts/nim_def/session_def.ts:137

---

QueryAllHasmoreRoammsg

▸ QueryAllHasmoreRoammsg(cb): void

Parameters

Name	Type
cb	null | QueryAllHasmoreRoammsgCallback

Returns

void

Defined in

ts/nim_def/session_def.ts:139

---

UpdateHasmoreRoammsg

▸ UpdateHasmoreRoammsg(msg, cb): void

Parameters

Name	Type
msg	IMMessage
cb	null | UpdateHasmoreRoammsgCallback

Returns

void

Defined in

ts/nim_def/session_def.ts:141

---

DeleteHasmoreRoammsg

▸ DeleteHasmoreRoammsg(session_id, to_type, cb): void

Parameters

Name	Type
session_id	string
to_type	NIMSessionType
cb	null | DeleteHasmoreRoammsgCallback

Returns

void

Defined in

ts/nim_def/session_def.ts:143