qn-im-sdk/dist/types/index.d.ts

QnzsIM SDK

import { RequestFunc } from "../constants";

export type InitConfig = {
  userID: string;
  token: string;
  url: string;
  platformID: number;
  isBatch?: boolean;
  operationID?: string;
  censorWordsUrl?: string;
};

export type WsParams = {
  reqFuncName: RequestFunc;
  operationID: string;
  userID: string | undefined;
  data: any;
};

export type WsResponse = {
  event: RequestFunc;
  errCode: number;
  errMsg: string;
  data: any;
  operationID: string;
};

export type LoginParams = {
  userID: string;
  token: string;
};

export type AdvancedMsgParams = {
  text: string;
  messageEntityList?: MessageEntity[];
};

export type MessageEntity = {
  type: string;
  offset: number;
  length: number;
  url?: string;
  info?: string;
};

export type AtMsgParams = {
  text: string;
  atUserIDList: string[];
  atUsersInfo?: AtUsersInfoItem[];
  message?: string;
};

export type AtUsersInfoItem = {
  atUserID: string;
  groupNickname: string;
};

export type ImageMsgParams = {
  sourcePicture: PicBaseInfo;
  bigPicture: PicBaseInfo;
  snapshotPicture: PicBaseInfo;
};

export type PicBaseInfo = {
  uuid: string;
  type: string;
  size: number;
  width: number;
  height: number;
  url: string;
};

export type SoundMsgParams = {
  uuid: string;
  soundPath: string;
  sourceUrl: string;
  dataSize: number;
  duration: number;
};

export type VideoMsgParams = {
  videoPath: string;
  duration: number;
  videoType: string;
  snapshotPath: string;
  videoUUID: string;
  videoUrl: string;
  videoSize: number;
  snapshotUUID: string;
  snapshotSize: number;
  snapshotUrl: string;
  snapshotWidth: number;
  snapshotHeight: number;
};

export type FileMsgParams = {
  filePath: string;
  fileName: string;
  uuid: string;
  sourceUrl: string;
  fileSize: number;
};

export type FileMsgFullParams = {
  fileFullPath: string;
  fileName: string;
};

export type VideoMsgFullParams = {
  videoFullPath: string;
  videoType: string;
  duration: number;
  snapshotFullPath: string;
};

export type SouondMsgFullParams = {
  soundPath: string;
  duration: number;
};

export type MergerMsgParams = {
  messageList: MessageItem[];
  title: string;
  summaryList: string[];
};

export type FaceMessageParams = {
  index: number;
  data: string;
};

export type LocationMsgParams = {
  description: string;
  longitude: number;
  latitude: number;
};

export type CustomMsgParams = {
  data: string;
  extension: string;
  description: string;
};

export type QuoteMsgParams = {
  text: string;
  message: string;
};

export type AdvancedQuoteMsgParams = {
  text: string;
  message: string;
  messageEntityList: MessageEntity[]
};

export type SendMsgParams = {
  recvID: string;
  groupID: string;
  offlinePushInfo?: OfflinePush;
  message: string;
};

export type GetHistoryMsgParams = {
  userID: string;
  groupID: string;
  count: number;
  startClientMsgID: string;
  conversationID?: string;
};

export type GetAdvancedHistoryMsgParams = {
  userID: string;
  groupID: string;
  count: number;
  startClientMsgID: string;
  conversationID?: string;
  lastMinSeq: number;
};

export type setPrvParams = {
  conversationID: string;
  isPrivate: boolean;
};

export type InsertSingleMsgParams = {
  message: string;
  recvID: string;
  sendID: string;
};

export type InsertGroupMsgParams = {
  message: string;
  groupID: string;
  sendID: string;
};

export type TypingUpdateParams = {
  recvID: string;
  msgTip: string;
};

export type MarkC2CParams = {
  userID: string;
  msgIDList: string[];
};

export type MarkNotiParams = {
  conversationID: string;
  msgIDList: string[];
};

export type SplitParams = {
  offset: number;
  count: number;
};

export type GetOneCveParams = {
  sourceID: string;
  sessionType: number;
};

export type SetDraftParams = {
  conversationID: string;
  draftText: string;
};

export type PinCveParams = {
  conversationID: string;
  isPinned: boolean;
};

export type isRecvParams = {
  conversationIDList: string[];
  opt: OptType;
};

declare export enum OptType {
  Nomal = 0,
  Mute = 1,
  WithoutNotify = 2,
}

export type SearchLocalParams = {
  conversationID: string;
  keywordList: string[];
  keywordListMatchType?: number;
  senderUserIDList?: string[];
  messageTypeList?: MessageType[];
  searchTimePosition?: number;
  searchTimePeriod?: number;
  pageIndex?: number;
  count?: number;
};

export type AddFriendParams = {
  toUserID: string;
  reqMsg: string;
};

export type SearchFriendParams = {
  keywordList: string[];
  isSearchUserID: boolean;
  isSearchNickname: boolean;
  isSearchRemark: boolean;
};

export type AccessFriendParams = {
  toUserID: string;
  handleMsg: string;
};

export type RemarkFriendParams = {
  toUserID: string;
  remark: string;
};

export type InviteGroupParams = {
  groupID: string;
  reason: string;
  userIDList: string[];
};

export type GroupMsgReadParams = {
  groupID: string;
  msgIDList: string[];
};

export type GetGroupMemberParams = {
  groupID: string;
  filter: number;
  offset: number;
  count: number;
};

export type GetGroupMemberByTimeParams = {
  groupID: string;
  filterUserIDList: string[];
  offset: number;
  count: number;
  joinTimeBegin: number;
  joinTimeEnd: number;
};

export type SearchGroupMemberParams = {
  groupID: string;
  keywordList: string[];
  isSearchUserID: boolean;
  isSearchMemberNickname: boolean;
  offset: number;
  count: number;
};

export type SetMemberAuthParams = {
  rule: AllowType;
  groupID: string;
}

export type CreateGroupParams = {
  groupBaseInfo: GroupInitInfo;
  memberList: Member[];
};

export type GroupInitInfo = {
  groupType: GroupType;
  groupName: string;
  introduction?: string;
  notification?: string;
  faceURL?: string;
  ex?: string;
};

export type Member = {
  userID: string;
  roleLevel: number;
};

export type GroupInfoParams = {
  groupID: string;
  groupInfo: GroupBaseInfo;
};

export type MemberNameParams = {
  groupID: string;
  userID: string;
  GroupMemberNickname: string;
};

export type GroupBaseInfo = Partial<Omit<GroupInitInfo, "groupType">>;

export type JoinGroupParams = {
  groupID: string;
  reqMsg: string;
  joinSource: GroupJoinSource;
};

export type SearchGroupParams = {
  keywordList: string[];
  isSearchGroupID: boolean;
  isSearchGroupName: boolean;
};

export type ChangeGroupMuteParams = {
  groupID: string;
  isMute: boolean;
};

export type ChangeGroupMemberMuteParams = {
  groupID: string;
  userID: string;
  mutedSeconds: number;
};

export type TransferGroupParams = {
  groupID: string;
  newOwnerUserID: string;
};

export type AccessGroupParams = {
  groupID: string;
  fromUserID: string;
  handleMsg: string;
};

export type SetGroupRoleParams = {
  groupID: string;
  userID: string;
  roleLevel: GroupRole;
};

export type SetGroupVerificationParams = {
  verification: GroupVerificationType;
  groupID: string;
};

export type RtcInvite = {
  inviterUserID: string;
  inviteeUserIDList: string[];
  groupID: string;
  roomID: string;
  timeout: number;
  mediaType: string;
  sessionType: number;
  platformID: number;
};

export type RtcActionParams = {
  opUserID: string;
  invitation: RtcInvite;
};

export type Ws2Promise = {
  oid: string;
  mname: string;
  mrsve: (value: WsResponse | PromiseLike<WsResponse>) => void;
  mrjet: (reason?: any) => void;
  flag: boolean;
};

export type GroupApplicationItem = {
  createTime: number;
  creatorUserID: string;
  ex: string;
  gender: number;
  groupFaceURL: string;
  groupID: string;
  groupName: string;
  groupType: number;
  handleResult: number;
  handleUserID: string;
  handledMsg: string;
  handledTime: number;
  introduction: string;
  memberCount: number;
  nickname: string;
  notification: string;
  ownerUserID: string;
  reqMsg: string;
  reqTime: number;
  status: number;
  userFaceURL: string;
  userID: string;
};

export type FriendApplicationItem = {
  createTime: number;
  ex: string;
  fromFaceURL: string;
  fromGender: number;
  fromNickname: string;
  fromUserID: string;
  handleMsg: string;
  handleResult: number;
  handleTime: number;
  handlerUserID: string;
  reqMsg: string;
  toFaceURL: string;
  toGender: number;
  toNickname: string;
  toUserID: string;
};

export type TotalUserStruct = {
  blackInfo: BlackItem | null;
  friendInfo: FriendItem | null;
  publicInfo: PublicUserItem | null;
};

export type PublicUserItem = {
  gender: number;
  nickname: string;
  userID: string;
  faceURL: string;
  ex: string;
};

export type FullUserItem = {
  birth: number;
  createTime: number;
  email: string;
  ex: string;
  faceURL: string;
  gender: number;
  nickname: string;
  phoneNumber: string;
  userID: string;
};

export type PartialUserItem = Partial<Omit<FullUserItem, "userID">> & { userID: string };

export type FriendItem = {
  addSource: number;
  birth: number;
  createTime: number;
  email: string;
  ex: string;
  faceURL: string;
  userID: string;
  gender: number;
  nickname: string;
  operatorUserID: string;
  ownerUserID: string;
  phoneNumber: string;
  remark: string;
};

export type FriendRelationItem = {
  result: number;
  userID: string;
};

export type BlackItem = {
  addSource: number;
  userID: string;
  createTime: number;
  ex: string;
  faceURL: string;
  gender: number;
  nickname: string;
  operatorUserID: string;
  ownerUserID: string;
};

export type GroupItem = {
  groupID: string;
  groupName: string;
  notification: string;
  notificationUserID: string;
  notificationUpdateTime: number;
  introduction: string;
  faceURL: string;
  ownerUserID: string;
  createTime: number;
  memberCount: number;
  status: GroupStatus;
  creatorUserID: string;
  groupType: number;
  needVerification: GroupVerificationType;
  ex: string;
  applyMemberFriend: AllowType;
  lookMemberInfo: AllowType;
};

declare export enum AllowType {
  Allowed,
  NotAllowed,
}

declare export enum GroupType {
  NomalGroup,
  SuperGroup,
  WorkingGroup,
}

declare export enum GroupVerificationType {
  ApplyNeedInviteNot,
  AllNeed,
  AllNot,
}

declare export enum GroupStatus {
  Nomal = 0,
  Baned = 1,
  Dismissed = 2,
  Muted = 3,
}

export type GroupMemberItem = {
  groupID: string;
  userID: string;
  nickname: string;
  faceURL: string;
  roleLevel: GroupRole;
  muteEndTime: number;
  joinTime: number;
  joinSource: GroupJoinSource;
  inviterUserID: string;
  operatorUserID: string;
  ex: string;
};

declare export enum GroupJoinSource {
  Invitation = 2,
  Search = 3,
  QrCode = 4,
}

declare export enum GroupRole {
  Nomal = 1,
  Owner = 2,
  Admin = 3,
}

export type ConversationItem = {
  conversationID: string;
  conversationType: SessionType;
  userID: string;
  groupID: string;
  showName: string;
  faceURL: string;
  recvMsgOpt: OptType;
  unreadCount: number;
  groupAtType: GroupAtType;
  latestMsg: string;
  latestMsgSendTime: number;
  draftText: string;
  draftTextTime: number;
  isPinned: boolean;
  isNotInGroup: boolean;
  isPrivateChat: boolean;
  attachedInfo: string;
  ex: string;
};

declare export enum GroupAtType {
  AtNormal = 0,
  AtMe = 1,
  AtAll = 2,
  AtAllAtMe = 3,
  AtGroupNotice = 4,
}

export type MessageItem = {
  clientMsgID: string;
  serverMsgID: string;
  createTime: number;
  sendTime: number;
  sessionType: SessionType;
  sendID: string;
  recvID: string;
  msgFrom: number;
  contentType: MessageType;
  platformID: Platform;
  senderNickname: string;
  senderFaceUrl: string;
  groupID: string;
  content: string;
  seq: number;
  isRead: boolean;
  status: MessageStatus;
  offlinePush: OfflinePush;
  attachedInfo: string;
  attachedInfoElem: AttachedInfoElem;
  ex: string;
  pictureElem: PictureElem;
  soundElem: SoundElem;
  videoElem: VideoElem;
  fileElem: FileElem;
  faceElem: FaceElem;
  mergeElem: MergeElem;
  atElem: AtElem;
  locationElem: LocationElem;
  customElem: CustomElem;
  quoteElem: QuoteElem;
  notificationElem: NotificationElem;
  progress?: number;
  downloadProgress?: number;
  downloaded?: boolean;
};

declare export enum MessageStatus {
  Sending = 1,
  Succeed = 2,
  Failed = 3,
}

declare export enum Platform {
  iOS = 1,
  Android = 2,
  Windows = 3,
  MacOSX = 4,
  Web = 5,
  Linux = 7,
  Admin = 8,
}

declare export enum MessageType {
  TEXTMESSAGE = 101,
  PICTUREMESSAGE = 102,
  VOICEMESSAGE = 103,
  VIDEOMESSAGE = 104,
  FILEMESSAGE = 105,
  ATTEXTMESSAGE = 106,
  MERGERMESSAGE = 107,
  CARDMESSAGE = 108,
  LOCATIONMESSAGE = 109,
  CUSTOMMESSAGE = 110,
  REVOKEMESSAGE = 111,
  HASREADRECEIPTMESSAGE = 112,
  TYPINGMESSAGE = 113,
  QUOTEMESSAGE = 114,
  FACEMESSAGE = 115,
  ADVANCETEXTMESSAGE = 117,
  ADVANCEREVOKEMESSAGE = 118,
  CUSTOMMSGNOTTRIGGERCONVERSATION = 119,
  CUSTOMMSGONLINEONLY = 120,
  FRIENDAPPLICATIONAPPROVED = 1201,
  FRIENDAPPLICATIONREJECTED = 1202,
  FRIENDAPPLICATIONADDED = 1203,
  FRIENDADDED = 1204,
  FRIENDDELETED = 1205,
  FRIENDREMARKSET = 1206,
  BLACKADDED = 1207,
  BLACKDELETED = 1208,
  SELFINFOUPDATED = 1303,
  NOTIFICATION = 1400,
  GROUPCREATED = 1501,
  GROUPINFOUPDATED = 1502,
  JOINGROUPAPPLICATIONADDED = 1503,
  MEMBERQUIT = 1504,
  GROUPAPPLICATIONACCEPTED = 1505,
  GROUPAPPLICATIONREJECTED = 1506,
  GROUPOWNERTRANSFERRED = 1507,
  MEMBERKICKED = 1508,
  MEMBERINVITED = 1509,
  MEMBERENTER = 1510,
  GROUPDISMISSED = 1511,
  GROUPMEMBERMUTED = 1512,
  GROUPMEMBERCANCELMUTED = 1513,
  GROUPMUTED = 1514,
  GROUPCANCELMUTED = 1515,
  GROUPMEMBERINFOUPDATED = 1516,
  BURNMESSAGECHANGE = 1701,
}

declare export enum SessionType {
  Single = 1,
  Group = 2,
  SuperGroup = 3,
  Notification = 4,
}

export type NotificationElem = {
  detail: string;
  defaultTips: string;
};

export type AtElem = {
  text: string;
  atUserList: string[];
  atUsersInfo?: AtUsersInfoItem[];
  quoteMessage?: string;
  isAtSelf?: boolean;
};

export type CustomElem = {
  data: string;
  description: string;
  extension: string;
};

export type FileElem = {
  filePath: string;
  uuid: string;
  sourceUrl: string;
  fileName: string;
  fileSize: number;
};

export type FaceElem = {
  index: number;
  data: string;
};

export type LocationElem = {
  description: string;
  longitude: number;
  latitude: number;
};

export type MergeElem = {
  title: string;
  abstractList: string[];
  multiMessage: MessageItem[];
};

export type OfflinePush = {
  title: string;
  desc: string;
  ex: string;
  iOSPushSound: string;
  iOSBadgeCount: boolean;
};

export type PictureElem = {
  sourcePath: string;
  sourcePicture: Picture;
  bigPicture: Picture;
  snapshotPicture: Picture;
};

export type AttachedInfoElem = {
  groupHasReadInfo: GroupHasReadInfo;
  isPrivateChat: boolean;
  hasReadTime: number;
  notSenderNotificationPush: boolean;
};

export type GroupHasReadInfo = {
  hasReadCount: number;
  hasReadUserIDList: string[];
  groupMemberCount: number;
};

export type Picture = {
  uuid: string;
  type: string;
  size: number;
  width: number;
  height: number;
  url: string;
};

export type QuoteElem = {
  text: string;
  quoteMessage: MessageItem;
};

export type SoundElem = {
  uuid: string;
  soundPath: string;
  sourceUrl: string;
  dataSize: number;
  duration: number;
};

export type VideoElem = {
  videoPath: string;
  videoUUID: string;
  videoUrl: string;
  videoType: string;
  videoSize: number;
  duration: number;
  snapshotPath: string;
  snapshotUUID: string;
  snapshotSize: number;
  snapshotUrl: string;
  snapshotWidth: number;
  snapshotHeight: number;
};

export type SearchLocalLogData = {
  conversationID: string;
  conversationType: number;
  faceURL: string;
  messageCount: number;
  messageList: MessageItem[];
  showName: string;
  sendTime?: string;
  latestMsg?: string;
};

export type GetSubDepParams = {
  departmentID: string;
  offset: number;
  count: number;
};

export type SearchInOrzParams = {
  input: SearchInputType;
  offset: number;
  count: number;
};

export type SearchInputType = {
  keyWord: string;
  isSearchUserName: boolean;
  isSearchEnglishName: boolean;
  isSearchPosition: boolean;
  isSearchUserID: boolean;
  isSearchMobile: boolean;
  isSearchEmail: boolean;
  isSearchTelephone: boolean;
};

export interface DepartmentItem {
  attachedInfo: string;
  createTime: number;
  departmentID: string;
  departmentType: number;
  ex: string;
  faceURL: string;
  memberNum: number;
  name: string;
  order: number;
  parentID: string;
  subDepartmentNum: number;
}

export interface DepartmentMemberItem {
  userID: string;
  nickname: string;
  englishName: string;
  faceURL: string;
  gender: number;
  mobile: string;
  telephone: string;
  birth: number;
  email: string;
  departmentID: string;
  order: number;
  position: string;
  leader: number;
  status: number;
  createTime: number;
  ex: string;
  attachedInfo: string;
}

export interface DepartmentSearchResult {
  departmentList: DepartmentItem[];
  departmentMemberList: DepartmentMemberSearchItem[];
}

export interface DepartmentMemberSearchItem extends DepartmentMemberItem {
  departmentName: string;
  parentDepartmentList: {
    name: string;
    departmentID: string;
  };
}

export type FindMessageParams = {
    conversationID: string;
    clientMsgIDList: string[]
  }

export type SensitiveConfig = {
  mode: 1 | 2;
  words?: string[];
}