Package com.heroiclabs.nakama.api

Class Group

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.heroiclabs.nakama.api.Group
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GroupOrBuilder, Serializable
public final class Group extends com.google.protobuf.GeneratedMessageV3 implements GroupOrBuilder
 A group in the server.
Protobuf type nakama.api.Group
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Group.Builder
    A group in the server.

    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
    AVATAR_URL_FIELD_NUMBER
     
    static final int
    CREATE_TIME_FIELD_NUMBER
     
    static final int
    CREATOR_ID_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    EDGE_COUNT_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    LANG_TAG_FIELD_NUMBER
     
    static final int
    MAX_COUNT_FIELD_NUMBER
     
    static final int
    METADATA_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    OPEN_FIELD_NUMBER
     
    static final int
    UPDATE_TIME_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)
     
    String
    getAvatarUrl()
    A URL for an avatar image.
    com.google.protobuf.ByteString
    getAvatarUrlBytes()
    A URL for an avatar image.
    Timestamp
    getCreateTime()
    The UNIX time when the group was created.
    TimestampOrBuilder
    getCreateTimeOrBuilder()
    The UNIX time when the group was created.
    String
    getCreatorId()
    The id of the user who created the group.
    com.google.protobuf.ByteString
    getCreatorIdBytes()
    The id of the user who created the group.
    static Group
    getDefaultInstance()
     
    Group
    getDefaultInstanceForType()
     
    String
    getDescription()
    A description for the group.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A description for the group.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    int
    getEdgeCount()
    The current count of all members in the group.
    String
    getId()
    The id of a group.
    com.google.protobuf.ByteString
    getIdBytes()
    The id of a group.
    String
    getLangTag()
    The language expected to be a tag which follows the BCP-47 spec.
    com.google.protobuf.ByteString
    getLangTagBytes()
    The language expected to be a tag which follows the BCP-47 spec.
    int
    getMaxCount()
    The maximum number of members allowed.
    String
    getMetadata()
    Additional information stored as a JSON object.
    com.google.protobuf.ByteString
    getMetadataBytes()
    Additional information stored as a JSON object.
    String
    getName()
    The unique name of the group.
    com.google.protobuf.ByteString
    getNameBytes()
    The unique name of the group.
    BoolValue
    getOpen()
    Anyone can join open groups, otherwise only admins can accept members.
    BoolValueOrBuilder
    getOpenOrBuilder()
    Anyone can join open groups, otherwise only admins can accept members.
    com.google.protobuf.Parser<Group>
    getParserForType()
     
    int
    getSerializedSize()
     
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    Timestamp
    getUpdateTime()
    The UNIX time when the group was last updated.
    TimestampOrBuilder
    getUpdateTimeOrBuilder()
    The UNIX time when the group was last updated.
    boolean
    hasCreateTime()
    The UNIX time when the group was created.
    int
    hashCode()
     
    boolean
    hasOpen()
    Anyone can join open groups, otherwise only admins can accept members.
    boolean
    hasUpdateTime()
    The UNIX time when the group was last updated.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Group.Builder
    newBuilder()
     
    static Group.Builder
    newBuilder(Group prototype)
     
    Group.Builder
    newBuilderForType()
     
    protected Group.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Group
    parseDelimitedFrom(InputStream input)
     
    static Group
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Group
    parseFrom(byte[] data)
     
    static Group
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Group
    parseFrom(com.google.protobuf.ByteString data)
     
    static Group
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Group
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Group
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Group
    parseFrom(InputStream input)
     
    static Group
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Group
    parseFrom(ByteBuffer data)
     
    static Group
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Group>
    parser()
     
    Group.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 a group.
      string id = 1;
      Specified by:
      getId in interface GroupOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       The id of a group.
      string id = 1;
      Specified by:
      getIdBytes in interface GroupOrBuilder
      Returns:
      The bytes for id.

    • getCreatorId

      public String getCreatorId()
       The id of the user who created the group.
      string creator_id = 2;
      Specified by:
      getCreatorId in interface GroupOrBuilder
      Returns:
      The creatorId.

    • getCreatorIdBytes

      public com.google.protobuf.ByteString getCreatorIdBytes()
       The id of the user who created the group.
      string creator_id = 2;
      Specified by:
      getCreatorIdBytes in interface GroupOrBuilder
      Returns:
      The bytes for creatorId.

    • getName

      public String getName()
       The unique name of the group.
      string name = 3;
      Specified by:
      getName in interface GroupOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The unique name of the group.
      string name = 3;
      Specified by:
      getNameBytes in interface GroupOrBuilder
      Returns:
      The bytes for name.

    • getDescription

      public String getDescription()
       A description for the group.
      string description = 4;
      Specified by:
      getDescription in interface GroupOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       A description for the group.
      string description = 4;
      Specified by:
      getDescriptionBytes in interface GroupOrBuilder
      Returns:
      The bytes for description.

    • getLangTag

      public String getLangTag()
       The language expected to be a tag which follows the BCP-47 spec.
      string lang_tag = 5;
      Specified by:
      getLangTag in interface GroupOrBuilder
      Returns:
      The langTag.

    • getLangTagBytes

      public com.google.protobuf.ByteString getLangTagBytes()
       The language expected to be a tag which follows the BCP-47 spec.
      string lang_tag = 5;
      Specified by:
      getLangTagBytes in interface GroupOrBuilder
      Returns:
      The bytes for langTag.

    • getMetadata

      public String getMetadata()
       Additional information stored as a JSON object.
      string metadata = 6;
      Specified by:
      getMetadata in interface GroupOrBuilder
      Returns:
      The metadata.

    • getMetadataBytes

      public com.google.protobuf.ByteString getMetadataBytes()
       Additional information stored as a JSON object.
      string metadata = 6;
      Specified by:
      getMetadataBytes in interface GroupOrBuilder
      Returns:
      The bytes for metadata.

    • getAvatarUrl

      public String getAvatarUrl()
       A URL for an avatar image.
      string avatar_url = 7;
      Specified by:
      getAvatarUrl in interface GroupOrBuilder
      Returns:
      The avatarUrl.

    • getAvatarUrlBytes

      public com.google.protobuf.ByteString getAvatarUrlBytes()
       A URL for an avatar image.
      string avatar_url = 7;
      Specified by:
      getAvatarUrlBytes in interface GroupOrBuilder
      Returns:
      The bytes for avatarUrl.

    • hasOpen

      public boolean hasOpen()
       Anyone can join open groups, otherwise only admins can accept members.
      .google.protobuf.BoolValue open = 8;
      Specified by:
      hasOpen in interface GroupOrBuilder
      Returns:
      Whether the open field is set.

    • getOpen

      public BoolValue getOpen()
       Anyone can join open groups, otherwise only admins can accept members.
      .google.protobuf.BoolValue open = 8;
      Specified by:
      getOpen in interface GroupOrBuilder
      Returns:
      The open.

    • getOpenOrBuilder

      public BoolValueOrBuilder getOpenOrBuilder()
       Anyone can join open groups, otherwise only admins can accept members.
      .google.protobuf.BoolValue open = 8;
      Specified by:
      getOpenOrBuilder in interface GroupOrBuilder

    • getEdgeCount

      public int getEdgeCount()
       The current count of all members in the group.
      int32 edge_count = 9;
      Specified by:
      getEdgeCount in interface GroupOrBuilder
      Returns:
      The edgeCount.

    • getMaxCount

      public int getMaxCount()
       The maximum number of members allowed.
      int32 max_count = 10;
      Specified by:
      getMaxCount in interface GroupOrBuilder
      Returns:
      The maxCount.

    • hasCreateTime

      public boolean hasCreateTime()
       The UNIX time when the group was created.
      .google.protobuf.Timestamp create_time = 11;
      Specified by:
      hasCreateTime in interface GroupOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public Timestamp getCreateTime()
       The UNIX time when the group was created.
      .google.protobuf.Timestamp create_time = 11;
      Specified by:
      getCreateTime in interface GroupOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public TimestampOrBuilder getCreateTimeOrBuilder()
       The UNIX time when the group was created.
      .google.protobuf.Timestamp create_time = 11;
      Specified by:
      getCreateTimeOrBuilder in interface GroupOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       The UNIX time when the group was last updated.
      .google.protobuf.Timestamp update_time = 12;
      Specified by:
      hasUpdateTime in interface GroupOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public Timestamp getUpdateTime()
       The UNIX time when the group was last updated.
      .google.protobuf.Timestamp update_time = 12;
      Specified by:
      getUpdateTime in interface GroupOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public TimestampOrBuilder getUpdateTimeOrBuilder()
       The UNIX time when the group was last updated.
      .google.protobuf.Timestamp update_time = 12;
      Specified by:
      getUpdateTimeOrBuilder in interface GroupOrBuilder

    • 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 Group parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Group.Builder newBuilder()

    • newBuilder

      public static Group.Builder newBuilder(Group prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Group getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Group> 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 Group getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder