Package com.heroiclabs.nakama.rtapi

Interface EnvelopeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Envelope, Envelope.Builder
public interface EnvelopeOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCid

      String getCid()
      string cid = 1;
      Returns:
      The cid.

    • getCidBytes

      com.google.protobuf.ByteString getCidBytes()
      string cid = 1;
      Returns:
      The bytes for cid.

    • hasChannel

      boolean hasChannel()
       A response from a channel join operation.
      .nakama.realtime.Channel channel = 2;
      Returns:
      Whether the channel field is set.

    • getChannel

      Channel getChannel()
       A response from a channel join operation.
      .nakama.realtime.Channel channel = 2;
      Returns:
      The channel.

    • getChannelOrBuilder

      ChannelOrBuilder getChannelOrBuilder()
       A response from a channel join operation.
      .nakama.realtime.Channel channel = 2;

    • hasChannelJoin

      boolean hasChannelJoin()
       Join a realtime chat channel.
      .nakama.realtime.ChannelJoin channel_join = 3;
      Returns:
      Whether the channelJoin field is set.

    • getChannelJoin

      ChannelJoin getChannelJoin()
       Join a realtime chat channel.
      .nakama.realtime.ChannelJoin channel_join = 3;
      Returns:
      The channelJoin.

    • getChannelJoinOrBuilder

      ChannelJoinOrBuilder getChannelJoinOrBuilder()
       Join a realtime chat channel.
      .nakama.realtime.ChannelJoin channel_join = 3;

    • hasChannelLeave

      boolean hasChannelLeave()
       Leave a realtime chat channel.
      .nakama.realtime.ChannelLeave channel_leave = 4;
      Returns:
      Whether the channelLeave field is set.

    • getChannelLeave

      ChannelLeave getChannelLeave()
       Leave a realtime chat channel.
      .nakama.realtime.ChannelLeave channel_leave = 4;
      Returns:
      The channelLeave.

    • getChannelLeaveOrBuilder

      ChannelLeaveOrBuilder getChannelLeaveOrBuilder()
       Leave a realtime chat channel.
      .nakama.realtime.ChannelLeave channel_leave = 4;

    • hasChannelMessage

      boolean hasChannelMessage()
       An incoming message on a realtime chat channel.
      .nakama.api.ChannelMessage channel_message = 5;
      Returns:
      Whether the channelMessage field is set.

    • getChannelMessage

      ChannelMessage getChannelMessage()
       An incoming message on a realtime chat channel.
      .nakama.api.ChannelMessage channel_message = 5;
      Returns:
      The channelMessage.

    • getChannelMessageOrBuilder

      ChannelMessageOrBuilder getChannelMessageOrBuilder()
       An incoming message on a realtime chat channel.
      .nakama.api.ChannelMessage channel_message = 5;

    • hasChannelMessageAck

      boolean hasChannelMessageAck()
       An acknowledgement received in response to sending a message on a chat channel.
      .nakama.realtime.ChannelMessageAck channel_message_ack = 6;
      Returns:
      Whether the channelMessageAck field is set.

    • getChannelMessageAck

      ChannelMessageAck getChannelMessageAck()
       An acknowledgement received in response to sending a message on a chat channel.
      .nakama.realtime.ChannelMessageAck channel_message_ack = 6;
      Returns:
      The channelMessageAck.

    • getChannelMessageAckOrBuilder

      ChannelMessageAckOrBuilder getChannelMessageAckOrBuilder()
       An acknowledgement received in response to sending a message on a chat channel.
      .nakama.realtime.ChannelMessageAck channel_message_ack = 6;

    • hasChannelMessageSend

      boolean hasChannelMessageSend()
       Send a message to a realtime chat channel.
      .nakama.realtime.ChannelMessageSend channel_message_send = 7;
      Returns:
      Whether the channelMessageSend field is set.

    • getChannelMessageSend

      ChannelMessageSend getChannelMessageSend()
       Send a message to a realtime chat channel.
      .nakama.realtime.ChannelMessageSend channel_message_send = 7;
      Returns:
      The channelMessageSend.

    • getChannelMessageSendOrBuilder

      ChannelMessageSendOrBuilder getChannelMessageSendOrBuilder()
       Send a message to a realtime chat channel.
      .nakama.realtime.ChannelMessageSend channel_message_send = 7;

    • hasChannelMessageUpdate

      boolean hasChannelMessageUpdate()
       Update a message previously sent to a realtime chat channel.
      .nakama.realtime.ChannelMessageUpdate channel_message_update = 8;
      Returns:
      Whether the channelMessageUpdate field is set.

    • getChannelMessageUpdate

      ChannelMessageUpdate getChannelMessageUpdate()
       Update a message previously sent to a realtime chat channel.
      .nakama.realtime.ChannelMessageUpdate channel_message_update = 8;
      Returns:
      The channelMessageUpdate.

    • getChannelMessageUpdateOrBuilder

      ChannelMessageUpdateOrBuilder getChannelMessageUpdateOrBuilder()
       Update a message previously sent to a realtime chat channel.
      .nakama.realtime.ChannelMessageUpdate channel_message_update = 8;

    • hasChannelMessageRemove

      boolean hasChannelMessageRemove()
       Remove a message previously sent to a realtime chat channel.
      .nakama.realtime.ChannelMessageRemove channel_message_remove = 9;
      Returns:
      Whether the channelMessageRemove field is set.

    • getChannelMessageRemove

      ChannelMessageRemove getChannelMessageRemove()
       Remove a message previously sent to a realtime chat channel.
      .nakama.realtime.ChannelMessageRemove channel_message_remove = 9;
      Returns:
      The channelMessageRemove.

    • getChannelMessageRemoveOrBuilder

      ChannelMessageRemoveOrBuilder getChannelMessageRemoveOrBuilder()
       Remove a message previously sent to a realtime chat channel.
      .nakama.realtime.ChannelMessageRemove channel_message_remove = 9;

    • hasChannelPresenceEvent

      boolean hasChannelPresenceEvent()
       Presence update for a particular realtime chat channel.
      .nakama.realtime.ChannelPresenceEvent channel_presence_event = 10;
      Returns:
      Whether the channelPresenceEvent field is set.

    • getChannelPresenceEvent

      ChannelPresenceEvent getChannelPresenceEvent()
       Presence update for a particular realtime chat channel.
      .nakama.realtime.ChannelPresenceEvent channel_presence_event = 10;
      Returns:
      The channelPresenceEvent.

    • getChannelPresenceEventOrBuilder

      ChannelPresenceEventOrBuilder getChannelPresenceEventOrBuilder()
       Presence update for a particular realtime chat channel.
      .nakama.realtime.ChannelPresenceEvent channel_presence_event = 10;

    • hasError

      boolean hasError()
       Describes an error which occurred on the server.
      .nakama.realtime.Error error = 11;
      Returns:
      Whether the error field is set.

    • getError

      Error getError()
       Describes an error which occurred on the server.
      .nakama.realtime.Error error = 11;
      Returns:
      The error.

    • getErrorOrBuilder

      ErrorOrBuilder getErrorOrBuilder()
       Describes an error which occurred on the server.
      .nakama.realtime.Error error = 11;

    • hasMatch

      boolean hasMatch()
       Incoming information about a realtime match.
      .nakama.realtime.Match match = 12;
      Returns:
      Whether the match field is set.

    • getMatch

      Match getMatch()
       Incoming information about a realtime match.
      .nakama.realtime.Match match = 12;
      Returns:
      The match.

    • getMatchOrBuilder

      MatchOrBuilder getMatchOrBuilder()
       Incoming information about a realtime match.
      .nakama.realtime.Match match = 12;

    • hasMatchCreate

      boolean hasMatchCreate()
       A client to server request to create a realtime match.
      .nakama.realtime.MatchCreate match_create = 13;
      Returns:
      Whether the matchCreate field is set.

    • getMatchCreate

      MatchCreate getMatchCreate()
       A client to server request to create a realtime match.
      .nakama.realtime.MatchCreate match_create = 13;
      Returns:
      The matchCreate.

    • getMatchCreateOrBuilder

      MatchCreateOrBuilder getMatchCreateOrBuilder()
       A client to server request to create a realtime match.
      .nakama.realtime.MatchCreate match_create = 13;

    • hasMatchData

      boolean hasMatchData()
       Incoming realtime match data delivered from the server.
      .nakama.realtime.MatchData match_data = 14;
      Returns:
      Whether the matchData field is set.

    • getMatchData

      MatchData getMatchData()
       Incoming realtime match data delivered from the server.
      .nakama.realtime.MatchData match_data = 14;
      Returns:
      The matchData.

    • getMatchDataOrBuilder

      MatchDataOrBuilder getMatchDataOrBuilder()
       Incoming realtime match data delivered from the server.
      .nakama.realtime.MatchData match_data = 14;

    • hasMatchDataSend

      boolean hasMatchDataSend()
       A client to server request to send data to a realtime match.
      .nakama.realtime.MatchDataSend match_data_send = 15;
      Returns:
      Whether the matchDataSend field is set.

    • getMatchDataSend

      MatchDataSend getMatchDataSend()
       A client to server request to send data to a realtime match.
      .nakama.realtime.MatchDataSend match_data_send = 15;
      Returns:
      The matchDataSend.

    • getMatchDataSendOrBuilder

      MatchDataSendOrBuilder getMatchDataSendOrBuilder()
       A client to server request to send data to a realtime match.
      .nakama.realtime.MatchDataSend match_data_send = 15;

    • hasMatchJoin

      boolean hasMatchJoin()
       A client to server request to join a realtime match.
      .nakama.realtime.MatchJoin match_join = 16;
      Returns:
      Whether the matchJoin field is set.

    • getMatchJoin

      MatchJoin getMatchJoin()
       A client to server request to join a realtime match.
      .nakama.realtime.MatchJoin match_join = 16;
      Returns:
      The matchJoin.

    • getMatchJoinOrBuilder

      MatchJoinOrBuilder getMatchJoinOrBuilder()
       A client to server request to join a realtime match.
      .nakama.realtime.MatchJoin match_join = 16;

    • hasMatchLeave

      boolean hasMatchLeave()
       A client to server request to leave a realtime match.
      .nakama.realtime.MatchLeave match_leave = 17;
      Returns:
      Whether the matchLeave field is set.

    • getMatchLeave

      MatchLeave getMatchLeave()
       A client to server request to leave a realtime match.
      .nakama.realtime.MatchLeave match_leave = 17;
      Returns:
      The matchLeave.

    • getMatchLeaveOrBuilder

      MatchLeaveOrBuilder getMatchLeaveOrBuilder()
       A client to server request to leave a realtime match.
      .nakama.realtime.MatchLeave match_leave = 17;

    • hasMatchPresenceEvent

      boolean hasMatchPresenceEvent()
       Presence update for a particular realtime match.
      .nakama.realtime.MatchPresenceEvent match_presence_event = 18;
      Returns:
      Whether the matchPresenceEvent field is set.

    • getMatchPresenceEvent

      MatchPresenceEvent getMatchPresenceEvent()
       Presence update for a particular realtime match.
      .nakama.realtime.MatchPresenceEvent match_presence_event = 18;
      Returns:
      The matchPresenceEvent.

    • getMatchPresenceEventOrBuilder

      MatchPresenceEventOrBuilder getMatchPresenceEventOrBuilder()
       Presence update for a particular realtime match.
      .nakama.realtime.MatchPresenceEvent match_presence_event = 18;

    • hasMatchmakerAdd

      boolean hasMatchmakerAdd()
       Submit a new matchmaking process request.
      .nakama.realtime.MatchmakerAdd matchmaker_add = 19;
      Returns:
      Whether the matchmakerAdd field is set.

    • getMatchmakerAdd

      MatchmakerAdd getMatchmakerAdd()
       Submit a new matchmaking process request.
      .nakama.realtime.MatchmakerAdd matchmaker_add = 19;
      Returns:
      The matchmakerAdd.

    • getMatchmakerAddOrBuilder

      MatchmakerAddOrBuilder getMatchmakerAddOrBuilder()
       Submit a new matchmaking process request.
      .nakama.realtime.MatchmakerAdd matchmaker_add = 19;

    • hasMatchmakerMatched

      boolean hasMatchmakerMatched()
       A successful matchmaking result.
      .nakama.realtime.MatchmakerMatched matchmaker_matched = 20;
      Returns:
      Whether the matchmakerMatched field is set.

    • getMatchmakerMatched

      MatchmakerMatched getMatchmakerMatched()
       A successful matchmaking result.
      .nakama.realtime.MatchmakerMatched matchmaker_matched = 20;
      Returns:
      The matchmakerMatched.

    • getMatchmakerMatchedOrBuilder

      MatchmakerMatchedOrBuilder getMatchmakerMatchedOrBuilder()
       A successful matchmaking result.
      .nakama.realtime.MatchmakerMatched matchmaker_matched = 20;

    • hasMatchmakerRemove

      boolean hasMatchmakerRemove()
       Cancel a matchmaking process using a ticket.
      .nakama.realtime.MatchmakerRemove matchmaker_remove = 21;
      Returns:
      Whether the matchmakerRemove field is set.

    • getMatchmakerRemove

      MatchmakerRemove getMatchmakerRemove()
       Cancel a matchmaking process using a ticket.
      .nakama.realtime.MatchmakerRemove matchmaker_remove = 21;
      Returns:
      The matchmakerRemove.

    • getMatchmakerRemoveOrBuilder

      MatchmakerRemoveOrBuilder getMatchmakerRemoveOrBuilder()
       Cancel a matchmaking process using a ticket.
      .nakama.realtime.MatchmakerRemove matchmaker_remove = 21;

    • hasMatchmakerTicket

      boolean hasMatchmakerTicket()
       A response from starting a new matchmaking process.
      .nakama.realtime.MatchmakerTicket matchmaker_ticket = 22;
      Returns:
      Whether the matchmakerTicket field is set.

    • getMatchmakerTicket

      MatchmakerTicket getMatchmakerTicket()
       A response from starting a new matchmaking process.
      .nakama.realtime.MatchmakerTicket matchmaker_ticket = 22;
      Returns:
      The matchmakerTicket.

    • getMatchmakerTicketOrBuilder

      MatchmakerTicketOrBuilder getMatchmakerTicketOrBuilder()
       A response from starting a new matchmaking process.
      .nakama.realtime.MatchmakerTicket matchmaker_ticket = 22;

    • hasNotifications

      boolean hasNotifications()
       Notifications send by the server.
      .nakama.realtime.Notifications notifications = 23;
      Returns:
      Whether the notifications field is set.

    • getNotifications

      Notifications getNotifications()
       Notifications send by the server.
      .nakama.realtime.Notifications notifications = 23;
      Returns:
      The notifications.

    • getNotificationsOrBuilder

      NotificationsOrBuilder getNotificationsOrBuilder()
       Notifications send by the server.
      .nakama.realtime.Notifications notifications = 23;

    • hasRpc

      boolean hasRpc()
       RPC call or response.
      .nakama.api.Rpc rpc = 24;
      Returns:
      Whether the rpc field is set.

    • getRpc

      Rpc getRpc()
       RPC call or response.
      .nakama.api.Rpc rpc = 24;
      Returns:
      The rpc.

    • getRpcOrBuilder

      RpcOrBuilder getRpcOrBuilder()
       RPC call or response.
      .nakama.api.Rpc rpc = 24;

    • hasStatus

      boolean hasStatus()
       An incoming status snapshot for some set of users.
      .nakama.realtime.Status status = 25;
      Returns:
      Whether the status field is set.

    • getStatus

      Status getStatus()
       An incoming status snapshot for some set of users.
      .nakama.realtime.Status status = 25;
      Returns:
      The status.

    • getStatusOrBuilder

      StatusOrBuilder getStatusOrBuilder()
       An incoming status snapshot for some set of users.
      .nakama.realtime.Status status = 25;

    • hasStatusFollow

      boolean hasStatusFollow()
       Start following some set of users to receive their status updates.
      .nakama.realtime.StatusFollow status_follow = 26;
      Returns:
      Whether the statusFollow field is set.

    • getStatusFollow

      StatusFollow getStatusFollow()
       Start following some set of users to receive their status updates.
      .nakama.realtime.StatusFollow status_follow = 26;
      Returns:
      The statusFollow.

    • getStatusFollowOrBuilder

      StatusFollowOrBuilder getStatusFollowOrBuilder()
       Start following some set of users to receive their status updates.
      .nakama.realtime.StatusFollow status_follow = 26;

    • hasStatusPresenceEvent

      boolean hasStatusPresenceEvent()
       An incoming status update.
      .nakama.realtime.StatusPresenceEvent status_presence_event = 27;
      Returns:
      Whether the statusPresenceEvent field is set.

    • getStatusPresenceEvent

      StatusPresenceEvent getStatusPresenceEvent()
       An incoming status update.
      .nakama.realtime.StatusPresenceEvent status_presence_event = 27;
      Returns:
      The statusPresenceEvent.

    • getStatusPresenceEventOrBuilder

      StatusPresenceEventOrBuilder getStatusPresenceEventOrBuilder()
       An incoming status update.
      .nakama.realtime.StatusPresenceEvent status_presence_event = 27;

    • hasStatusUnfollow

      boolean hasStatusUnfollow()
       Stop following some set of users to no longer receive their status updates.
      .nakama.realtime.StatusUnfollow status_unfollow = 28;
      Returns:
      Whether the statusUnfollow field is set.

    • getStatusUnfollow

      StatusUnfollow getStatusUnfollow()
       Stop following some set of users to no longer receive their status updates.
      .nakama.realtime.StatusUnfollow status_unfollow = 28;
      Returns:
      The statusUnfollow.

    • getStatusUnfollowOrBuilder

      StatusUnfollowOrBuilder getStatusUnfollowOrBuilder()
       Stop following some set of users to no longer receive their status updates.
      .nakama.realtime.StatusUnfollow status_unfollow = 28;

    • hasStatusUpdate

      boolean hasStatusUpdate()
       Set the user's own status.
      .nakama.realtime.StatusUpdate status_update = 29;
      Returns:
      Whether the statusUpdate field is set.

    • getStatusUpdate

      StatusUpdate getStatusUpdate()
       Set the user's own status.
      .nakama.realtime.StatusUpdate status_update = 29;
      Returns:
      The statusUpdate.

    • getStatusUpdateOrBuilder

      StatusUpdateOrBuilder getStatusUpdateOrBuilder()
       Set the user's own status.
      .nakama.realtime.StatusUpdate status_update = 29;

    • hasStreamData

      boolean hasStreamData()
       A data message delivered over a stream.
      .nakama.realtime.StreamData stream_data = 30;
      Returns:
      Whether the streamData field is set.

    • getStreamData

      StreamData getStreamData()
       A data message delivered over a stream.
      .nakama.realtime.StreamData stream_data = 30;
      Returns:
      The streamData.

    • getStreamDataOrBuilder

      StreamDataOrBuilder getStreamDataOrBuilder()
       A data message delivered over a stream.
      .nakama.realtime.StreamData stream_data = 30;

    • hasStreamPresenceEvent

      boolean hasStreamPresenceEvent()
       Presence update for a particular stream.
      .nakama.realtime.StreamPresenceEvent stream_presence_event = 31;
      Returns:
      Whether the streamPresenceEvent field is set.

    • getStreamPresenceEvent

      StreamPresenceEvent getStreamPresenceEvent()
       Presence update for a particular stream.
      .nakama.realtime.StreamPresenceEvent stream_presence_event = 31;
      Returns:
      The streamPresenceEvent.

    • getStreamPresenceEventOrBuilder

      StreamPresenceEventOrBuilder getStreamPresenceEventOrBuilder()
       Presence update for a particular stream.
      .nakama.realtime.StreamPresenceEvent stream_presence_event = 31;

    • hasPing

      boolean hasPing()
       Application-level heartbeat and connection check.
      .nakama.realtime.Ping ping = 32;
      Returns:
      Whether the ping field is set.

    • getPing

      Ping getPing()
       Application-level heartbeat and connection check.
      .nakama.realtime.Ping ping = 32;
      Returns:
      The ping.

    • getPingOrBuilder

      PingOrBuilder getPingOrBuilder()
       Application-level heartbeat and connection check.
      .nakama.realtime.Ping ping = 32;

    • hasPong

      boolean hasPong()
       Application-level heartbeat and connection check response.
      .nakama.realtime.Pong pong = 33;
      Returns:
      Whether the pong field is set.

    • getPong

      Pong getPong()
       Application-level heartbeat and connection check response.
      .nakama.realtime.Pong pong = 33;
      Returns:
      The pong.

    • getPongOrBuilder

      PongOrBuilder getPongOrBuilder()
       Application-level heartbeat and connection check response.
      .nakama.realtime.Pong pong = 33;

    • getMessageCase

      Envelope.MessageCase getMessageCase()