Expand description
Flare IM gRPC 服务 proto 生成层(tonic client/server + 各服务消息类型)。
依赖 flare_proto 中的 flare.common.v1 等基础类型;业务 crate 按需依赖本 crate。
Re-exports§
pub use storage::VisibilityStatus;pub use signaling::online::DeviceInfo;pub use signaling::online::GetOnlineStatusRequest as SignalingGetOnlineStatusRequest;pub use signaling::online::GetOnlineStatusResponse as SignalingGetOnlineStatusResponse;pub use signaling::online::HeartbeatRequest;pub use signaling::online::HeartbeatResponse;pub use signaling::online::LoginRequest as SignalingLoginRequest;pub use signaling::online::LoginResponse as SignalingLoginResponse;pub use signaling::online::LogoutRequest;pub use signaling::online::LogoutResponse;pub use signaling::online::UserPresence;pub use signaling::router::PushStrategy;pub use signaling::router::RouteTarget;pub use signaling::router::RouterDownstreamPushAckRequest;pub use signaling::router::RouterDownstreamPushCustomRequest;pub use signaling::router::RouterDownstreamPushEventRequest;pub use signaling::router::RouterDownstreamPushMessageRequest;pub use signaling::router::RouterDownstreamPushNotificationRequest;pub use push::DevicePushProvider;pub use push::Notification as PushNotificationContent;pub use push::PushCustomRequest as PushPushCustomRequest;pub use push::PushCustomResponse as PushPushCustomResponse;pub use push::PushFailure;pub use push::PushMessageRequest as PushPushMessageRequest;pub use push::PushMessageResponse as PushPushMessageResponse;pub use push::PushNotificationRequest as PushPushNotificationRequest;pub use push::PushNotificationResponse as PushPushNotificationResponse;pub use push::PushOptions;pub use push::QueryPushStatusRequest;pub use push::QueryPushStatusResponse;pub use push::RegisterDevicePushTokenRequest;pub use push::RegisterDevicePushTokenResponse;pub use push::UnregisterDevicePushTokenRequest;pub use push::UnregisterDevicePushTokenResponse;pub use storage::ExportMessagesRequest;pub use storage::ExportMessagesResponse;pub use storage::FailedMessage;pub use storage::GetMessageRequest as StorageGetMessageRequest;pub use storage::GetMessageResponse as StorageGetMessageResponse;pub use storage::QueryMessagesRequest as StorageQueryMessagesRequest;pub use storage::QueryMessagesResponse as StorageQueryMessagesResponse;pub use storage::SearchMessagesRequest;pub use storage::SearchMessagesResponse;pub use media::AbortMultipartUploadRequest;pub use media::AbortMultipartUploadResponse;pub use media::AccessControlEntry;pub use media::CleanupOrphanedAssetsRequest;pub use media::CleanupOrphanedAssetsResponse;pub use media::CompleteMultipartUploadRequest;pub use media::CompressOperation;pub use media::CompressVideoOperation;pub use media::CreateReferenceRequest;pub use media::CreateReferenceResponse;pub use media::DeleteFileRequest as MediaDeleteFileRequest;pub use media::DeleteFileResponse as MediaDeleteFileResponse;pub use media::DeleteReferenceRequest;pub use media::DeleteReferenceResponse;pub use media::DescribeBucketRequest;pub use media::DescribeBucketResponse;pub use media::FileInfo;pub use media::GenerateUploadUrlRequest;pub use media::GenerateUploadUrlResponse;pub use media::GetFileInfoRequest;pub use media::GetFileInfoResponse;pub use media::GetFileUrlRequest;pub use media::GetFileUrlResponse;pub use media::ImageOperation;pub use media::InitiateMultipartUploadRequest;pub use media::InitiateMultipartUploadResponse;pub use media::ListObjectsRequest;pub use media::ListObjectsResponse;pub use media::ListReferencesRequest;pub use media::ListReferencesResponse;pub use media::MediaReferenceInfo;pub use media::ProcessImageRequest;pub use media::ProcessImageResponse;pub use media::ProcessVideoRequest;pub use media::ProcessVideoResponse;pub use media::ResizeOperation;pub use media::SetObjectAclRequest;pub use media::SubtitleBurnOperation;pub use media::ThumbnailOperation;pub use media::UploadFileMetadata;pub use media::UploadFileRequest;pub use media::UploadFileResponse;pub use media::UploadMultipartChunkRequest;pub use media::UploadMultipartChunkResponse;pub use media::VideoOperation;pub use media::WatermarkOperation;pub use capability::ConversationLifecycleHookRequest;pub use capability::ConversationLifecycleHookResponse;pub use capability::CustomHookRequest;pub use capability::CustomHookResponse;pub use capability::DeliveryHookRequest as ProtoDeliveryHookRequest;pub use capability::DeliveryHookResponse as ProtoDeliveryHookResponse;pub use capability::GenericRequest;pub use capability::GenericResponse;pub use capability::HookDeliveryEvent as ProtoHookDeliveryEvent;pub use capability::HookInvocationContext as ProtoHookInvocationContext;pub use capability::HookMessageDraft as ProtoHookMessageDraft;pub use capability::HookMessageRecord as ProtoHookMessageRecord;pub use capability::HookRecallEvent as ProtoHookRecallEvent;pub use capability::PostSendHookRequest as ProtoPostSendHookRequest;pub use capability::PostSendHookResponse as ProtoPostSendHookResponse;pub use capability::PreSendHookRequest as ProtoPreSendHookRequest;pub use capability::PreSendHookResponse as ProtoPreSendHookResponse;pub use capability::PresenceHookRequest;pub use capability::PresenceHookResponse;pub use capability::RecallHookRequest as ProtoRecallHookRequest;pub use capability::RecallHookResponse as ProtoRecallHookResponse;pub use conversation::ConversationBootstrapRequest;pub use conversation::ConversationBootstrapResponse;pub use conversation::ConversationPolicy;pub use conversation::DevicePresence as ConversationDevicePresence;pub use conversation::ForceConversationSyncRequest;pub use conversation::ListConversationsRequest as ConversationListConversationsRequest;pub use conversation::ListConversationsResponse as ConversationListConversationsResponse;pub use conversation::SortOrder as ConversationSortOrder;pub use conversation::SyncMessagesRequest as ConversationSyncMessagesRequest;pub use conversation::SyncMessagesResponse as ConversationSyncMessagesResponse;pub use conversation::UpdateCursorRequest;pub use conversation::UpdatePresenceRequest;
Modules§
Structs§
- AppCard
Action - AppCard
Content - 通用应用卡片:投票、任务、日程、公告、小程序等业务卡片均走此结构或 CustomContent。
- Audio
Content - Audio
Info - Audit
Context - / 审计上下文(敏感操作记录)
- Capability
Packet - Card
Content - 通用名片/卡片:类型 + 业务 id + 展示字段;attributes 扩展键值
- Conversation
Detail Sync - Conversation
Detail Sync Res - Conversation
Summary Proto - 会话列表/增量补丁的唯一读模型。
- Conversation
Sync Slice - Conversation
User Settings Sync - Conversation
User Settings Sync Res - Conversations
Sync - / 会话列表快照同步(编排层走 SyncSnapshot;与增量补丁 ConversationsIncrementalSync 并存)
- Conversations
Sync Res - Custom
Content - Data
Packet - / DATA 统一包:SDK 与网关按 payload oneof 解析。
- File
Content - Forward
Content - MESSAGE_TYPE_MERGE_FORWARD + MessageContent.forward;单条/合并由 mode 与 items 表达。
- GetSync
Cursor Sync - GetSync
Cursor Sync Res - Image
Content - 稳定媒体引用在 ImageInfo.image_id(原图、缩略图各自一条,便于独立鉴权与缓存)。
- Image
Info - Location
Content - 与业务层 LocationMessageContent 对齐:坐标、标题、地址、可选缩放与缩略图
- Media
Attachment - / 媒体附件(消息内引用;上传走 Media 服务)
- Mention
- Message
- Message
Content - Message
Read Record - 单条已读记录(GetReadReceipts / 已读列表查询)
- Message
Retention Expired Event - Message
Retention Policy - Message
Retention Purged Event - Message
Retention Scheduled Event - Message
Retention State - Message
Timeline - 消息时间线(持久化/投递/已读等,SendMessageResponse 等按需返回)
- MqEnvelope
- / 主 MQ 记录:
Message或Event(由 oneof 保证单选);含接收者用户 ID 列表。 - Multi
Conversation Sync - Multi
Conversation Sync Res - Multi
Device Cursor - Notification
Content - Offline
Push Info - 离线推送展示(可选)
- Pagination
- / 分页(cursor/limit/has_more;Sync、历史消息、会话列表通用)
- Presence
Hint Packet - Query
Events Sync - Query
Events Sync Res - Realtime
Control Packet - Single
Conversation Sync - Single
Conversation Sync Res - Sync
- SyncRes
- Sync
Slice Item - Text
Content - Typing
State Packet - Update
Sync Cursor Sync - Update
Sync Cursor Sync Res - Video
Content - Video
Info
Enums§
- Conflict
Resolution - / 多端冲突策略(互斥/同平台互斥/共存/强制下线)
- Content
Visibility - Conversation
Device State - / 设备在线状态(多端在线)
- Delete
Type - / 删除类型:软删仅当前用户隐藏,硬删仅管理员/合规
- Mark
Type - / 标记类型:重要/待办/已处理/自定义
- Message
Retention Lifecycle - Message
Source - 消息来源
- Message
Status - 消息状态(author / persistence lifecycle)。投递与已读是用户维度事件/读模型,不进入本 FSM。
- Message
Type - MqPayload
Kind - Push
Task Payload Kind - Reaction
Action - / 反应操作:添加/移除(emoji 等)
- Retention
Mode - Retention
Trigger
Functions§
- ensure_
conversation_ request - 「确保会话存在」的建群请求约定(唯一实现):