Package com.heroiclabs.nakama.rtapi

Interface ChannelOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getGroupId()
    The ID of the group, or an empty string if this message was not sent through a group channel.
    com.google.protobuf.ByteString
    getGroupIdBytes()
    The ID of the group, or an empty string if this message was not sent through a group channel.
    String
    getId()
    The ID of the channel.
    com.google.protobuf.ByteString
    getIdBytes()
    The ID of the channel.
    UserPresence
    getPresences(int index)
    The users currently in the channel.
    int
    getPresencesCount()
    The users currently in the channel.
    List<UserPresence>
    getPresencesList()
    The users currently in the channel.
    UserPresenceOrBuilder
    getPresencesOrBuilder(int index)
    The users currently in the channel.
    List<? extends UserPresenceOrBuilder>
    getPresencesOrBuilderList()
    The users currently in the channel.
    String
    getRoomName()
    The name of the chat room, or an empty string if this message was not sent through a chat room.
    com.google.protobuf.ByteString
    getRoomNameBytes()
    The name of the chat room, or an empty string if this message was not sent through a chat room.
    UserPresence
    getSelf()
    A reference to the current user's presence in the channel.
    UserPresenceOrBuilder
    getSelfOrBuilder()
    A reference to the current user's presence in the channel.
    String
    getUserIdOne()
    The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
    com.google.protobuf.ByteString
    getUserIdOneBytes()
    The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
    String
    getUserIdTwo()
    The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
    com.google.protobuf.ByteString
    getUserIdTwoBytes()
    The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
    boolean
    hasSelf()
    A reference to the current user's presence in the channel.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      String getId()
       The ID of the channel.
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       The ID of the channel.
      string id = 1;
      Returns:
      The bytes for id.

    • getPresencesList

      List<UserPresence> getPresencesList()
       The users currently in the channel.
      repeated .nakama.realtime.UserPresence presences = 2;

    • getPresences

      UserPresence getPresences(int index)
       The users currently in the channel.
      repeated .nakama.realtime.UserPresence presences = 2;

    • getPresencesCount

      int getPresencesCount()
       The users currently in the channel.
      repeated .nakama.realtime.UserPresence presences = 2;

    • getPresencesOrBuilderList

      List<? extends UserPresenceOrBuilder> getPresencesOrBuilderList()
       The users currently in the channel.
      repeated .nakama.realtime.UserPresence presences = 2;

    • getPresencesOrBuilder

      UserPresenceOrBuilder getPresencesOrBuilder(int index)
       The users currently in the channel.
      repeated .nakama.realtime.UserPresence presences = 2;

    • hasSelf

      boolean hasSelf()
       A reference to the current user's presence in the channel.
      .nakama.realtime.UserPresence self = 3;
      Returns:
      Whether the self field is set.

    • getSelf

      UserPresence getSelf()
       A reference to the current user's presence in the channel.
      .nakama.realtime.UserPresence self = 3;
      Returns:
      The self.

    • getSelfOrBuilder

      UserPresenceOrBuilder getSelfOrBuilder()
       A reference to the current user's presence in the channel.
      .nakama.realtime.UserPresence self = 3;

    • getRoomName

      String getRoomName()
       The name of the chat room, or an empty string if this message was not sent through a chat room.
      string room_name = 4;
      Returns:
      The roomName.

    • getRoomNameBytes

      com.google.protobuf.ByteString getRoomNameBytes()
       The name of the chat room, or an empty string if this message was not sent through a chat room.
      string room_name = 4;
      Returns:
      The bytes for roomName.

    • getGroupId

      String getGroupId()
       The ID of the group, or an empty string if this message was not sent through a group channel.
      string group_id = 5;
      Returns:
      The groupId.

    • getGroupIdBytes

      com.google.protobuf.ByteString getGroupIdBytes()
       The ID of the group, or an empty string if this message was not sent through a group channel.
      string group_id = 5;
      Returns:
      The bytes for groupId.

    • getUserIdOne

      String getUserIdOne()
       The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
      string user_id_one = 6;
      Returns:
      The userIdOne.

    • getUserIdOneBytes

      com.google.protobuf.ByteString getUserIdOneBytes()
       The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
      string user_id_one = 6;
      Returns:
      The bytes for userIdOne.

    • getUserIdTwo

      String getUserIdTwo()
       The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
      string user_id_two = 7;
      Returns:
      The userIdTwo.

    • getUserIdTwoBytes

      com.google.protobuf.ByteString getUserIdTwoBytes()
       The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
      string user_id_two = 7;
      Returns:
      The bytes for userIdTwo.