Package com.heroiclabs.nakama.rtapi

Class Channel

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.heroiclabs.nakama.rtapi.Channel
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ChannelOrBuilder, Serializable
public final class Channel extends com.google.protobuf.GeneratedMessageV3 implements ChannelOrBuilder
 A realtime chat channel.
Protobuf type nakama.realtime.Channel
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Channel.Builder
    A realtime chat channel.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    GROUP_ID_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    PRESENCES_FIELD_NUMBER
     
    static final int
    ROOM_NAME_FIELD_NUMBER
     
    static final int
    SELF_FIELD_NUMBER
     
    static final int
    USER_ID_ONE_FIELD_NUMBER
     
    static final int
    USER_ID_TWO_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Channel
    getDefaultInstance()
     
    Channel
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<Channel>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    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.
    int
    hashCode()
     
    boolean
    hasSelf()
    A reference to the current user's presence in the channel.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Channel.Builder
    newBuilder()
     
    static Channel.Builder
    newBuilder(Channel prototype)
     
    Channel.Builder
    newBuilderForType()
     
    protected Channel.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Channel
    parseDelimitedFrom(InputStream input)
     
    static Channel
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Channel
    parseFrom(byte[] data)
     
    static Channel
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Channel
    parseFrom(com.google.protobuf.ByteString data)
     
    static Channel
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Channel
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Channel
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Channel
    parseFrom(InputStream input)
     
    static Channel
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Channel
    parseFrom(ByteBuffer data)
     
    static Channel
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Channel>
    parser()
     
    Channel.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getId

      public String getId()
       The ID of the channel.
      string id = 1;
      Specified by:
      getId in interface ChannelOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       The ID of the channel.
      string id = 1;
      Specified by:
      getIdBytes in interface ChannelOrBuilder
      Returns:
      The bytes for id.

    • getPresencesList

      public List<UserPresence> getPresencesList()
       The users currently in the channel.
      repeated .nakama.realtime.UserPresence presences = 2;
      Specified by:
      getPresencesList in interface ChannelOrBuilder

    • getPresencesOrBuilderList

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

    • getPresencesCount

      public int getPresencesCount()
       The users currently in the channel.
      repeated .nakama.realtime.UserPresence presences = 2;
      Specified by:
      getPresencesCount in interface ChannelOrBuilder

    • getPresences

      public UserPresence getPresences(int index)
       The users currently in the channel.
      repeated .nakama.realtime.UserPresence presences = 2;
      Specified by:
      getPresences in interface ChannelOrBuilder

    • getPresencesOrBuilder

      public UserPresenceOrBuilder getPresencesOrBuilder(int index)
       The users currently in the channel.
      repeated .nakama.realtime.UserPresence presences = 2;
      Specified by:
      getPresencesOrBuilder in interface ChannelOrBuilder

    • hasSelf

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

    • getSelf

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

    • getSelfOrBuilder

      public UserPresenceOrBuilder getSelfOrBuilder()
       A reference to the current user's presence in the channel.
      .nakama.realtime.UserPresence self = 3;
      Specified by:
      getSelfOrBuilder in interface ChannelOrBuilder

    • getRoomName

      public 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;
      Specified by:
      getRoomName in interface ChannelOrBuilder
      Returns:
      The roomName.

    • getRoomNameBytes

      public 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;
      Specified by:
      getRoomNameBytes in interface ChannelOrBuilder
      Returns:
      The bytes for roomName.

    • getGroupId

      public 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;
      Specified by:
      getGroupId in interface ChannelOrBuilder
      Returns:
      The groupId.

    • getGroupIdBytes

      public 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;
      Specified by:
      getGroupIdBytes in interface ChannelOrBuilder
      Returns:
      The bytes for groupId.

    • getUserIdOne

      public 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;
      Specified by:
      getUserIdOne in interface ChannelOrBuilder
      Returns:
      The userIdOne.

    • getUserIdOneBytes

      public 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;
      Specified by:
      getUserIdOneBytes in interface ChannelOrBuilder
      Returns:
      The bytes for userIdOne.

    • getUserIdTwo

      public 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;
      Specified by:
      getUserIdTwo in interface ChannelOrBuilder
      Returns:
      The userIdTwo.

    • getUserIdTwoBytes

      public 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;
      Specified by:
      getUserIdTwoBytes in interface ChannelOrBuilder
      Returns:
      The bytes for userIdTwo.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Channel parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Channel parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Channel parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Channel parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Channel parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Channel parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Channel parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Channel.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Channel.Builder newBuilder()

    • newBuilder

      public static Channel.Builder newBuilder(Channel prototype)

    • toBuilder

      public Channel.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Channel.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Channel getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Channel> parser()

    • getParserForType

      public com.google.protobuf.Parser<Channel> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Channel getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder