uu-platform/apis/mobile-grpc-api/src/main/proto/base.proto

syntax = "proto3";

package uu.mobile;

option java_multiple_files = true;
option java_package = "com.usoftchina.uu.mobile.grpc.api";

// 响应头
message ResponseHeader {
    // 是否成功
    bool success = 1;
    // 错误码
    int32 code = 2;
    // 错误信息
    string message = 3;
}

// 分页信息
message Paging {
    // 总页数
    int32 totalPage = 1;
    // 总条数
    int64 totalCount = 2;
    // 每页条数
    int32 pageSize = 3;
    // 当前页
    int32 pageNumber = 4;
}

// 账户
message AccountInfo {
    int64 id = 1;
    // 真实姓名（考虑是企业应用，非社交类型，不需要昵称）
    string realname = 2;
    // 手机号
    string mobile = 3;
    // 邮箱
    string email = 4;
    // 头像
    string avatarUrl = 5;
    Sex sex = 6;
    // 性别
    enum Sex {
        // 女
        FEMALE = 0;
        // 男
        MALE = 1;
    }
}

// 公司
message Company {
    int64 id = 1;
    // 名称
    string name = 2;
}

// 视图类型
enum ViewType {
    // 原生
    WIDGET = 0;
    // 网页
    WEB = 1;
}

// 消息配置
message MessageConfig {
    // 唯一编码，例如 uas.todo
    string code = 1;
    // 消息名，例如 待办事项
    string name = 2;
    // 图标
    string icon = 3;
    // 打开视图类型
    ViewType viewType = 4;
    // Android
    string androidWidget = 5;
    // IOS
    string iosWidget = 6;
    // 网页
    string webUrl = 7;
}

// 未读消息统计
message UnreadMessageCount {
    // 消息编码
    string code = 1;
    // 消息数
    int32 count = 2;
}

// 消息
message MessageInfo {
    // ID
    int64 id = 1;
    // 消息内容
    string body = 2;
    // 状态
    Status status = 3;
    enum Status {
        // 未读
        UNREAD = 0;
        // 已读
        READ = 1;
    }
}

// 应用组配置
message AppGroupConfig {
    string name = 1;
    repeated AppConfig appConfig = 2;
}

// 应用配置
message AppConfig {
    int32 id = 1;
    // 应用名
    string name = 2;
    // 图标
    string icon = 3;
    // 打开视图类型
    ViewType viewType = 4;
    // Android
    string androidWidget = 5;
    // IOS
    string iosWidget = 6;
    // 网页
    string webUrl = 7;
}

// 我的主页配置
message HomeConfig {
    int32 id = 1;
    // 显示名
    string name = 2;
    // 图标
    string icon = 3;
    // 显示/打开视图类型
    ViewType viewType = 4;
    // 显示/打开Android控件
    string androidWidget = 5;
    // 显示/打开IOS控件
    string iosWidget = 6;
    // 打开网页
    string webUrl = 7;
}

// 设备信息
message DeviceInfo {
    // 客户端发行版本，例如1.0.0
    string version = 1;
    // 设备型号
    string model = 2;
    // 系统
    OS os = 3;
    enum OS {
        ANDROID = 0;
        IOS = 1;
    }
    // 系统版本，例如7.1
    string osVersion = 4;
    // 经度
    double longitude = 5;
    // 纬度
    double latitude = 6;
    // 位置
    string location = 7;
    // 语言
    string lang = 8;
    // 消息通道
    string channelId = 9;
}