convergenceMessage.proto

/*
 * Copyright (C) Convergence Labs, Inc
 *
 * This file is subject to the terms and conditions defined in
 * file 'LICENSE', which is part of this source code package.
 */
syntax = "proto3";


package com.convergencelabs.convergence.proto;

import "google/protobuf/wrappers.proto";

import "core/heartbeatMessages.proto";
import "core/connectionMessages.proto";
import "core/permissions.proto";
import "core/commonMessages.proto";
import "core/utilityMessages.proto";

import "activity/activityMessages.proto";
import "chat/chatMessages.proto";
import "identity/identityMessages.proto";
import "model/modelMessages.proto";
import "presence/presenceMessages.proto";

/*
 * The ConvergenceMessage is the root of the client-server protocol. It is
 * essentially a message envelope that will hold a single client-server
 * message.
 */
message ConvergenceMessage {

  // An optional request correlation id, if the sender expects a response to
  // this message. This will be set if this message is a request message.
  google.protobuf.Int32Value requestId = 1;

  // An optional response correlation id that corresponds to request id of
  // the message this message is in response to. This will be set if this
  // message is a response message.
  google.protobuf.Int32Value responseId = 2;

  // The body holds the specific message that was sent / received.
  oneof body {
    //
    // Core
    //
    core.OkResponse ok = 3;
    core.ErrorMessage error = 4;

    core.PingMessage ping = 5;
    core.PongMessage pong = 6;

    core.ConnectionRequestMessage connectionRequest = 7;
    core.ConnectionResponseMessage connectionResponse = 8;

    core.GetServerTimeRequestMessage serverTimeRequest = 20;
    core.GetServerTimeResponseMessage serverTimeResponse = 21;

    //
    // Models
    //
    model.OpenRealtimeModelRequestMessage openRealTimeModelRequest = 100;
    model.OpenRealtimeModelResponseMessage openRealTimeModelResponse = 101;

    model.CloseRealtimeModelRequestMessage closeRealTimeModelRequest = 102;
    model.CloseRealTimeModelResponseMessage closeRealTimeModelResponse = 103;

    model.CreateRealtimeModelRequestMessage createRealTimeModelRequest = 104;
    model.CreateRealtimeModelResponseMessage createRealTimeModelResponse = 105;

    model.DeleteRealtimeModelRequestMessage deleteRealtimeModelRequest = 106;
    model.DeleteRealtimeModelResponseMessage deleteRealtimeModelResponse = 107;

    model.ModelForceCloseMessage forceCloseRealTimeModel = 108;

    model.RemoteClientOpenedMessage remoteClientOpenedModel = 109;
    model.RemoteClientClosedMessage remoteClientClosedModel = 110;

    model.AutoCreateModelConfigRequestMessage modelAutoCreateConfigRequest = 111;
    model.AutoCreateModelConfigResponseMessage modelAutoCreateConfigResponse = 112;

    model.RemoteOperationMessage remoteOperation = 113;

    model.OperationSubmissionMessage operationSubmission = 114;
    model.OperationAcknowledgementMessage operationAck = 115;

    model.ShareReferenceMessage shareReference = 116;
    model.SetReferenceMessage setReference = 117;
    model.ClearReferenceMessage clearReference = 118;
    model.UnshareReferenceMessage unshareReference = 119;

    model.RemoteReferenceSharedMessage referenceShared = 120;
    model.RemoteReferenceSetMessage referenceSet = 121;
    model.RemoteReferenceClearedMessage referenceCleared = 122;
    model.RemoteReferenceUnsharedMessage referenceUnshared = 123;

    model.ModelsQueryRequestMessage modelsQueryRequest = 124;
    model.ModelsQueryResponseMessage modelsQueryResponse = 125;

    model.GetModelPermissionsRequestMessage getModelPermissionsRequest = 126;
    model.GetModelPermissionsResponseMessage getModelPermissionsResponse = 127;

    model.SetModelPermissionsRequestMessage setModelPermissionsRequest = 128;
    model.SetModelPermissionsResponseMessage setModelPermissionsResponse = 129;

    model.ModelPermissionsChangedMessage modelPermissionsChanged = 130;

    model.ModelResyncRequestMessage modelResyncRequest = 131;
    model.ModelResyncResponseMessage modelResyncResponse = 132;
    model.ModelResyncClientCompleteMessage modelResyncClientComplete = 133;
    model.ModelResyncServerCompleteMessage modelResyncServerComplete = 134;
    model.RemoteClientResyncStartedMessage remoteClientResyncStarted = 135;
    model.RemoteClientResyncCompletedMessage remoteClientResyncCompleted = 136;

    model.ModelOfflineSubscriptionChangeRequestMessage modelOfflineSubscriptionChange = 137;
    model.OfflineModelUpdatedMessage modelOfflineUpdated = 138;

    model.HistoricalDataRequestMessage historicalDataRequest = 139;
    model.HistoricalDataResponseMessage historicalDataResponse = 140;

    model.HistoricalOperationRequestMessage historicalOperationsRequest = 141;
    model.HistoricalOperationsResponseMessage historicalOperationsResponse = 142;

    model.ModelGetVersionAtTimeRequestMessage modelGetVersionAtTimeRequest = 143;
    model.ModelGetVersionAtTimeResponseMessage modelGetVersionAtTimeResponse = 144;

    //
    // Identity
    //
    identity.IdentityCacheUpdateMessage identityCacheUpdate = 200;

    identity.GetUsersRequestMessage usersGetRequest = 201;
    identity.SearchUsersRequestMessage userSearchRequest = 202;
    identity.UserListMessage userListResponse = 203;

    identity.UserGroupsRequestMessage userGroupsRequest = 204;
    identity.UserGroupsResponseMessage userGroupsResponse = 205;

    identity.UserGroupsForUsersRequestMessage userGroupsForUsersRequest = 206;
    identity.UserGroupsForUsersResponseMessage userGroupsForUsersResponse = 207;

    //
    // Activity
    //
    activity.ActivityParticipantsRequestMessage activityParticipantsRequest = 300;
    activity.ActivityParticipantsResponseMessage activityParticipantsResponse = 301;

    activity.ActivityCreateRequestMessage activityCreateRequest = 302;
    // 303 reserved for ActivityCreateResponseMessage

    activity.ActivityDeleteRequestMessage activityDeleteRequest = 304;
    // 304 reserved for ActivityCreateResponseMessage

    activity.ActivityJoinRequestMessage activityJoinRequest = 306;
    activity.ActivityJoinResponseMessage activityJoinResponse = 307;

    activity.ActivityLeaveRequestMessage activityLeaveRequest = 308;
    // 309 reserved for response message.

    activity.ActivitySessionJoinedMessage activitySessionJoined = 310;
    activity.ActivitySessionLeftMessage activitySessionLeft = 311;

    activity.ActivityUpdateStateMessage activityUpdateState = 312;
    activity.ActivityStateUpdatedMessage activityStateUpdated = 313;

    activity.ActivityDeletedMessage activityDeleted = 314;
    activity.ActivityForceLeaveMessage activityForceLeave = 315;


    //
    // Presence
    //
    presence.PresenceSetStateMessage presenceSetState = 400;
    presence.PresenceRemoveStateMessage presenceRemoveState = 401;
    presence.PresenceClearStateMessage presenceClearState = 402;

    presence.PresenceStateSetMessage presenceStateSet = 403;
    presence.PresenceStateRemovedMessage presenceStateRemoved = 404;
    presence.PresenceStateClearedMessage presenceStateCleared = 405;

    presence.PresenceAvailabilityChangedMessage presenceAvailabilityChanged  = 406;

    presence.PresenceRequestMessage presenceRequest = 407;
    presence.PresenceResponseMessage presenceResponse = 408;

    presence.SubscribePresenceRequestMessage presenceSubscribeRequest = 409;
    presence.SubscribePresenceResponseMessage presenceSubscribeResponse = 410;
    presence.UnsubscribePresenceMessage presenceUnsubscribe = 411;

    //
    // Chat
    //
    chat.CreateChatRequestMessage createChatRequest = 500;
    chat.CreateChatResponseMessage createChatResponse = 501;

    chat.RemoveChatRequestMessage removeChatRequest = 502;
    chat.RemoveChatResponseMessage removeChatResponse = 503;
    chat.ChatRemovedMessage chatRemoved = 504;

    chat.GetChatsRequestMessage getChatsRequest = 505;
    chat.GetChatsResponseMessage getChatsResponse = 506;

    chat.ChatsExistRequestMessage chatsExistRequest = 507;
    chat.ChatsExistResponseMessage chatsExistResponse = 508;

    chat.GetDirectChatsRequestMessage getDirectChatsRequest = 509;
    chat.GetDirectChatsResponseMessage getDirectChatsResponse = 510;

    chat.GetJoinedChatsRequestMessage getJoinedChatsRequest = 511;
    chat.GetJoinedChatsResponseMessage getJoinedChatsResponse = 512;

    chat.ChatsSearchRequestMessage chatsSearchRequest = 513;
    chat.ChatsSearchResponseMessage chatsSearchResponse = 514;

    chat.JoinChatRequestMessage joinChatRequest = 515;
    chat.JoinChatResponseMessage joinChatResponse = 516;
    chat.UserJoinedChatMessage userJoinedChat = 517;

    chat.LeaveChatRequestMessage leaveChatRequest = 518;
    chat.LeaveChatResponseMessage leaveChatResponse = 519;
    chat.UserLeftChatMessage userLeftChat = 520;

    chat.AddUserToChatRequestMessage addUserToChatRequest = 521;
    chat.AddUserToChatResponseMessage addUserToChatResponse = 522;
    chat.UserAddedToChatMessage userAddedToChat = 523;

    chat.RemoveUserFromChatRequestMessage removeUserFromChatRequest = 524;
    chat.RemoveUserFromChatResponseMessage removeUserFromChatResponse = 525;
    chat.UserRemovedFromChatMessage userRemovedFromChat = 526;

    chat.SetChatNameRequestMessage setChatNameRequest = 527;
    chat.SetChatNameResponseMessage setChatNameResponse = 528;
    chat.ChatNameSetMessage chatNameChanged = 529;

    chat.SetChatTopicRequestMessage setChatTopicRequest = 530;
    chat.SetChatTopicResponseMessage setChatTopicResponse = 531;
    chat.ChatTopicSetMessage chatTopicChanged = 532;

    chat.MarkChatEventsSeenRequestMessage markChatEventsSeenRequest = 533;
    chat.MarkChatEventsSeenResponseMessage markChatEventsSeenResponse = 534;
    chat.ChatEventsMarkedSeenMessage chatEventsMarkedSeen = 535;

    chat.PublishChatRequestMessage publishChatMessageRequest = 536;
    chat.PublishChatResponseMessage publishChatMessageResponse = 537;
    chat.RemoteChatMessageMessage remoteChatMessage = 538;

    chat.ChatHistoryRequestMessage getChatHistoryRequest = 539;
    chat.ChatHistoryResponseMessage getChatHistoryResponse = 540;

    //
    // Permissions
    //
    core.ResolvePermissionsForConnectedSessionRequestMessage resolvePermissionsForConnectedSessionRequest = 601;
    core.ResolvePermissionsForConnectedSessionResponseMessage resolvePermissionsForConnectedSessionResponse = 602;

    core.AddPermissionsRequestMessage addPermissionsRequest = 603;
    // 604 reserved for AddPermissionsResponseMessage

    core.RemovePermissionsRequestMessage removePermissionsRequest = 605;
    // 606 reserved for RemovePermissionsResponseMessage

    core.SetPermissionsRequestMessage setPermissionsRequest = 607;
    // 608 reserved for SetPermissionsResponseMessage

    core.GetPermissionsRequestMessage getPermissionsRequest = 609;
    core.GetPermissionsResponseMessage getPermissionsResponse = 610;
  }
}