@openim/protocol
Version:
OpenIM protocol
299 lines (298 loc) • 10 kB
TypeScript
import { type RequestPagination } from "../sdkws/sdkws";
import { type BoolValue, type Int32Value, type Int64Value, type StringValue } from "../wrapperspb/wrapperspb";
export declare const protobufPackage = "openim.conversation";
export interface Conversation {
ownerUserID: string;
conversationID: string;
recvMsgOpt: number;
conversationType: number;
userID: string;
groupID: string;
isPinned: boolean;
attachedInfo: string;
isPrivateChat: boolean;
groupAtType: number;
ex: string;
burnDuration: number;
minSeq: number;
maxSeq: number;
msgDestructTime: number;
latestMsgDestructTime: number;
isMsgDestruct: boolean;
}
export interface ConversationReq {
conversationID: string;
conversationType: number;
userID: string;
groupID: string;
recvMsgOpt: Int32Value | undefined;
isPinned: BoolValue | undefined;
attachedInfo: StringValue | undefined;
isPrivateChat: BoolValue | undefined;
ex: StringValue | undefined;
burnDuration: Int32Value | undefined;
minSeq: Int64Value | undefined;
maxSeq: Int64Value | undefined;
groupAtType: Int32Value | undefined;
msgDestructTime: Int64Value | undefined;
isMsgDestruct: BoolValue | undefined;
}
export interface SetConversationReq {
conversation: Conversation | undefined;
}
export interface SetConversationResp {
}
export interface GetConversationReq {
conversationID: string;
ownerUserID: string;
}
export interface GetConversationResp {
conversation: Conversation | undefined;
}
export interface GetSortedConversationListReq {
userID: string;
conversationIDs: string[];
pagination: RequestPagination | undefined;
}
export interface GetSortedConversationListResp {
conversationTotal: number;
unreadTotal: number;
conversationElems: ConversationElem[];
}
export interface ConversationElem {
conversationID: string;
recvMsgOpt: number;
unreadCount: number;
IsPinned: boolean;
msgInfo: MsgInfo | undefined;
}
export interface MsgInfo {
serverMsgID: string;
clientMsgID: string;
sessionType: number;
sendID: string;
recvID: string;
senderName: string;
faceURL: string;
groupID: string;
groupName: string;
groupFaceURL: string;
groupType: number;
groupMemberCount: number;
LatestMsgRecvTime: number;
msgFrom: number;
contentType: number;
content: string;
ex: string;
}
export interface GetConversationsReq {
ownerUserID: string;
conversationIDs: string[];
}
export interface GetConversationsResp {
conversations: Conversation[];
}
export interface GetAllConversationsReq {
ownerUserID: string;
}
export interface GetAllConversationsResp {
conversations: Conversation[];
}
export interface GetRecvMsgNotNotifyUserIDsReq {
groupID: string;
}
export interface GetRecvMsgNotNotifyUserIDsResp {
userIDs: string[];
}
export interface CreateSingleChatConversationsReq {
recvID: string;
sendID: string;
conversationID: string;
conversationType: number;
}
export interface CreateSingleChatConversationsResp {
}
export interface CreateGroupChatConversationsReq {
userIDs: string[];
groupID: string;
}
export interface CreateGroupChatConversationsResp {
}
export interface SetConversationMaxSeqReq {
conversationID: string;
ownerUserID: string[];
maxSeq: number;
}
export interface SetConversationMaxSeqResp {
}
export interface SetConversationMinSeqReq {
conversationID: string;
ownerUserID: string[];
minSeq: number;
}
export interface SetConversationMinSeqResp {
}
export interface GetConversationIDsReq {
userID: string;
}
export interface GetConversationIDsResp {
conversationIDs: string[];
}
export interface SetConversationsReq {
userIDs: string[];
conversation: ConversationReq | undefined;
}
export interface SetConversationsResp {
}
export interface GetUserConversationIDsHashReq {
ownerUserID: string;
}
export interface GetUserConversationIDsHashResp {
hash: number;
}
export interface GetConversationsByConversationIDReq {
conversationIDs: string[];
}
export interface GetConversationsByConversationIDResp {
conversations: Conversation[];
}
export interface GetConversationOfflinePushUserIDsReq {
conversationID: string;
userIDs: string[];
}
export interface GetConversationOfflinePushUserIDsResp {
userIDs: string[];
}
export interface GetConversationNotReceiveMessageUserIDsReq {
conversationID: string;
}
export interface GetConversationNotReceiveMessageUserIDsResp {
userIDs: string[];
}
export interface UpdateConversationReq {
conversationID: string;
userIDs: string[];
recvMsgOpt: Int32Value | undefined;
isPinned: BoolValue | undefined;
attachedInfo: StringValue | undefined;
isPrivateChat: BoolValue | undefined;
ex: StringValue | undefined;
burnDuration: Int32Value | undefined;
minSeq: Int64Value | undefined;
maxSeq: Int64Value | undefined;
groupAtType: Int32Value | undefined;
msgDestructTime: Int64Value | undefined;
isMsgDestruct: BoolValue | undefined;
latestMsgDestructTime: Int64Value | undefined;
}
export interface UpdateConversationResp {
}
export interface GetFullOwnerConversationIDsReq {
idHash: number;
userID: string;
}
export interface GetFullOwnerConversationIDsResp {
version: number;
versionID: string;
equal: boolean;
conversationIDs: string[];
}
export interface GetIncrementalConversationReq {
userID: string;
versionID: string;
version: number;
}
export interface GetIncrementalConversationResp {
version: number;
versionID: string;
full: boolean;
delete: string[];
insert: Conversation[];
update: Conversation[];
}
export interface GetOwnerConversationReq {
userID: string;
pagination: RequestPagination | undefined;
}
export interface GetOwnerConversationResp {
total: number;
conversations: Conversation[];
}
export interface GetConversationsNeedDestructMsgsReq {
}
export interface GetConversationsNeedDestructMsgsResp {
conversations: Conversation[];
}
export interface GetNotNotifyConversationIDsReq {
userID: string;
}
export interface GetNotNotifyConversationIDsResp {
conversationIDs: string[];
}
export interface GetPinnedConversationIDsReq {
userID: string;
}
export interface GetPinnedConversationIDsResp {
conversationIDs: string[];
}
export interface ConversationPinnedMsg {
userID: string;
seq: number;
createTime: number;
read: {
[key: string]: number;
};
}
export interface ConversationPinnedMsg_ReadEntry {
key: string;
value: number;
}
export interface GetConversationPinnedMsgReq {
conversationID: string;
}
export interface GetConversationPinnedMsgResp {
msgs: ConversationPinnedMsg[];
}
export interface SetConversationPinnedMsgReq {
conversationID: string;
userID: string;
seq: number;
pinned: boolean;
}
export interface SetConversationPinnedMsgResp {
}
export interface ReadConversationPinnedMsgReq {
conversationID: string;
userID: string;
seq: number;
}
export interface ReadConversationPinnedMsgResp {
}
export interface conversation {
GetConversation(request: GetConversationReq): Promise<GetConversationResp>;
GetSortedConversationList(request: GetSortedConversationListReq): Promise<GetSortedConversationListResp>;
GetAllConversations(request: GetAllConversationsReq): Promise<GetAllConversationsResp>;
GetConversations(request: GetConversationsReq): Promise<GetConversationsResp>;
SetConversation(request: SetConversationReq): Promise<SetConversationResp>;
GetRecvMsgNotNotifyUserIDs(request: GetRecvMsgNotNotifyUserIDsReq): Promise<GetRecvMsgNotNotifyUserIDsResp>;
CreateSingleChatConversations(request: CreateSingleChatConversationsReq): Promise<CreateSingleChatConversationsResp>;
CreateGroupChatConversations(request: CreateGroupChatConversationsReq): Promise<CreateGroupChatConversationsResp>;
SetConversationMaxSeq(request: SetConversationMaxSeqReq): Promise<SetConversationMaxSeqResp>;
SetConversationMinSeq(request: SetConversationMinSeqReq): Promise<SetConversationMinSeqResp>;
GetConversationIDs(request: GetConversationIDsReq): Promise<GetConversationIDsResp>;
SetConversations(request: SetConversationsReq): Promise<SetConversationsResp>;
GetUserConversationIDsHash(request: GetUserConversationIDsHashReq): Promise<GetUserConversationIDsHashResp>;
GetConversationsByConversationID(request: GetConversationsByConversationIDReq): Promise<GetConversationsByConversationIDResp>;
GetConversationOfflinePushUserIDs(request: GetConversationOfflinePushUserIDsReq): Promise<GetConversationOfflinePushUserIDsResp>;
GetConversationNotReceiveMessageUserIDs(request: GetConversationNotReceiveMessageUserIDsReq): Promise<GetConversationNotReceiveMessageUserIDsResp>;
UpdateConversation(request: UpdateConversationReq): Promise<UpdateConversationResp>;
GetFullOwnerConversationIDs(request: GetFullOwnerConversationIDsReq): Promise<GetFullOwnerConversationIDsResp>;
GetIncrementalConversation(request: GetIncrementalConversationReq): Promise<GetIncrementalConversationResp>;
GetOwnerConversation(request: GetOwnerConversationReq): Promise<GetOwnerConversationResp>;
GetConversationsNeedDestructMsgs(request: GetConversationsNeedDestructMsgsReq): Promise<GetConversationsNeedDestructMsgsResp>;
GetNotNotifyConversationIDs(request: GetNotNotifyConversationIDsReq): Promise<GetNotNotifyConversationIDsResp>;
GetPinnedConversationIDs(request: GetPinnedConversationIDsReq): Promise<GetPinnedConversationIDsResp>;
GetConversationPinnedMsg(request: GetConversationPinnedMsgReq): Promise<GetConversationPinnedMsgResp>;
SetConversationPinnedMsg(request: SetConversationPinnedMsgReq): Promise<SetConversationPinnedMsgResp>;
ReadConversationPinnedMsg(request: ReadConversationPinnedMsgReq): Promise<ReadConversationPinnedMsgResp>;
}