Skip to main content

Crate flare_grpc_proto

Crate flare_grpc_proto 

Source
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§

access_gateway
capability
conversation
flare
media
message
push
signaling
storage
sync

Structs§

AppCardAction
AppCardContent
通用应用卡片:投票、任务、日程、公告、小程序等业务卡片均走此结构或 CustomContent。
AudioContent
AudioInfo
AuditContext
/ 审计上下文(敏感操作记录)
CapabilityPacket
CardContent
通用名片/卡片:类型 + 业务 id + 展示字段;attributes 扩展键值
ConversationDetailSync
ConversationDetailSyncRes
ConversationSummaryProto
会话列表/增量补丁的唯一读模型。
ConversationSyncSlice
ConversationUserSettingsSync
ConversationUserSettingsSyncRes
ConversationsSync
/ 会话列表快照同步(编排层走 SyncSnapshot;与增量补丁 ConversationsIncrementalSync 并存)
ConversationsSyncRes
CustomContent
DataPacket
/ DATA 统一包:SDK 与网关按 payload oneof 解析。
FileContent
ForwardContent
MESSAGE_TYPE_MERGE_FORWARD + MessageContent.forward;单条/合并由 mode 与 items 表达。
GetSyncCursorSync
GetSyncCursorSyncRes
ImageContent
稳定媒体引用在 ImageInfo.image_id(原图、缩略图各自一条,便于独立鉴权与缓存)。
ImageInfo
LocationContent
与业务层 LocationMessageContent 对齐:坐标、标题、地址、可选缩放与缩略图
MediaAttachment
/ 媒体附件(消息内引用;上传走 Media 服务)
Mention
Message
MessageContent
MessageReadRecord
单条已读记录(GetReadReceipts / 已读列表查询)
MessageRetentionExpiredEvent
MessageRetentionPolicy
MessageRetentionPurgedEvent
MessageRetentionScheduledEvent
MessageRetentionState
MessageTimeline
消息时间线(持久化/投递/已读等,SendMessageResponse 等按需返回)
MqEnvelope
/ 主 MQ 记录:Message 或 Event(由 oneof 保证单选);含接收者用户 ID 列表。
MultiConversationSync
MultiConversationSyncRes
MultiDeviceCursor
NotificationContent
OfflinePushInfo
离线推送展示(可选)
Pagination
/ 分页(cursor/limit/has_more;Sync、历史消息、会话列表通用)
PresenceHintPacket
QueryEventsSync
QueryEventsSyncRes
RealtimeControlPacket
SingleConversationSync
SingleConversationSyncRes
Sync
SyncRes
SyncSliceItem
TextContent
TypingStatePacket
UpdateSyncCursorSync
UpdateSyncCursorSyncRes
VideoContent
VideoInfo

Enums§

ConflictResolution
/ 多端冲突策略(互斥/同平台互斥/共存/强制下线)
ContentVisibility
ConversationDeviceState
/ 设备在线状态(多端在线)
DeleteType
/ 删除类型:软删仅当前用户隐藏,硬删仅管理员/合规
MarkType
/ 标记类型:重要/待办/已处理/自定义
MessageRetentionLifecycle
MessageSource
消息来源
MessageStatus
消息状态(author / persistence lifecycle)。投递与已读是用户维度事件/读模型,不进入本 FSM。
MessageType
MqPayloadKind
PushTaskPayloadKind
ReactionAction
/ 反应操作:添加/移除(emoji 等)
RetentionMode
RetentionTrigger

Functions§

ensure_conversation_request
「确保会话存在」的建群请求约定(唯一实现):