2c0ac124d7
- 新增 Android SDK 使用文档，包含模块结构、集成方式和快速开始指南 - 添加 SDK API 重设计规范，统一初始化和登录接口设计 - 补充安全设计规范，完善 UserSig 鉴权和敏感数据处理方案 - 创建平台 REST API 规范，定义服务端到服务端的调用接口 - 添加离线推送架构设计，集成各大厂商推送服务与 IM 联动方案
144 行
2.7 KiB
TypeScript
144 行
2.7 KiB
TypeScript
export interface SDKConfig {
|
|
appKey: string
|
|
appSecret: string
|
|
debug?: boolean
|
|
}
|
|
|
|
export type MsgType =
|
|
| 'TEXT'
|
|
| 'IMAGE'
|
|
| 'VIDEO'
|
|
| 'AUDIO'
|
|
| 'FILE'
|
|
| 'CUSTOM'
|
|
| 'LOCATION'
|
|
| 'NOTIFY'
|
|
| 'RICH_TEXT'
|
|
| 'CALL_AUDIO'
|
|
| 'CALL_VIDEO'
|
|
| 'REVOKED'
|
|
| 'FORWARD'
|
|
|
|
export type ChatType = 'SINGLE' | 'GROUP'
|
|
|
|
export type MsgStatus = 'SENDING' | 'SENT' | 'DELIVERED' | 'READ' | 'FAILED' | 'REVOKED'
|
|
|
|
export interface ImMessage {
|
|
id: string
|
|
appId: string
|
|
fromUserId: string
|
|
fromId?: string
|
|
toId: string
|
|
chatType: ChatType
|
|
msgType: MsgType
|
|
content: string
|
|
status: MsgStatus
|
|
mentionedUserIds?: string
|
|
groupReadCount?: number
|
|
revoked?: boolean
|
|
createdAt: string
|
|
}
|
|
|
|
export interface ConversationView {
|
|
targetId: string
|
|
chatType: ChatType
|
|
lastMsgContent?: string | null
|
|
lastMsgType?: string | null
|
|
lastMsgTime: number
|
|
unreadCount: number
|
|
isMuted: boolean
|
|
isPinned: boolean
|
|
}
|
|
|
|
export interface PageResult<T> {
|
|
content: T[]
|
|
totalElements: number
|
|
totalPages: number
|
|
size: number
|
|
number: number
|
|
numberOfElements: number
|
|
first: boolean
|
|
last: boolean
|
|
empty: boolean
|
|
}
|
|
|
|
export interface HistoryQuery {
|
|
msgType?: MsgType
|
|
keyword?: string
|
|
startTime?: string | Date
|
|
endTime?: string | Date
|
|
page?: number
|
|
size?: number
|
|
}
|
|
|
|
export interface UserProfile {
|
|
id?: string
|
|
appId?: string
|
|
userId: string
|
|
nickname?: string | null
|
|
avatar?: string | null
|
|
gender?: string | null
|
|
status?: string | null
|
|
createdAt?: string | number | null
|
|
}
|
|
|
|
export interface ImGroup {
|
|
id: string
|
|
appId?: string
|
|
name: string
|
|
groupType?: string
|
|
creatorId: string
|
|
memberIds: string
|
|
adminIds: string
|
|
announcement?: string | null
|
|
createdAt?: string | number | null
|
|
}
|
|
|
|
export interface FriendRequest {
|
|
id: string
|
|
appId?: string
|
|
fromUserId: string
|
|
toUserId: string
|
|
remark?: string | null
|
|
status: 'PENDING' | 'ACCEPTED' | 'REJECTED'
|
|
createdAt: string | number
|
|
reviewedAt?: string | number | null
|
|
}
|
|
|
|
export interface GroupJoinRequest {
|
|
id: string
|
|
appId?: string
|
|
groupId: string
|
|
requesterId: string
|
|
remark?: string | null
|
|
status: 'PENDING' | 'ACCEPTED' | 'REJECTED'
|
|
createdAt: string | number
|
|
reviewedAt?: string | number | null
|
|
}
|
|
|
|
export interface SendMessageParams {
|
|
messageId?: string
|
|
toId: string
|
|
chatType: ChatType
|
|
msgType: MsgType
|
|
content: string
|
|
extra?: string
|
|
mentionedUserIds?: string
|
|
}
|
|
|
|
export interface ImEventMap {
|
|
message: (msg: ImMessage) => void
|
|
read: (msg: ImMessage) => void
|
|
revoke: (data: { msgId: string; operatorId: string }) => void
|
|
connected: () => void
|
|
disconnected: (code: number, reason: string) => void
|
|
error: (err: Event) => void
|
|
}
|
|
|
|
export interface ApiResponse<T> {
|
|
code: number
|
|
status: string
|
|
data: T
|
|
message: string
|
|
}
|
