com.heroiclabs.nakama.api

Class Group

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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, java.io.Serializable

public final class Group
extends com.google.protobuf.GeneratedMessage
implements GroupOrBuilder

 A group in the server.
 

Protobuf type nakama.api.Group

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessage.BuilderParent

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AVATAR_URL_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	CREATOR_ID_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	EDGE_COUNT_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	LANG_TAG_FIELD_NUMBER
static int	MAX_COUNT_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	OPEN_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

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 and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAvatarUrl() A URL for an avatar image.
com.google.protobuf.ByteString	getAvatarUrlBytes() A URL for an avatar image.
com.google.protobuf.Timestamp	getCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created.
java.lang.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()
java.lang.String	getDescription() A description for the group.
com.google.protobuf.ByteString	getDescriptionBytes() A description for the group.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getEdgeCount() The current count of all members in the group.
java.lang.String	getId() The id of a group.
com.google.protobuf.ByteString	getIdBytes() The id of a group.
java.lang.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.
java.lang.String	getMetadata() Additional information stored as a JSON object.
com.google.protobuf.ByteString	getMetadataBytes() Additional information stored as a JSON object.
java.lang.String	getName() The unique name of the group.
com.google.protobuf.ByteString	getNameBytes() The unique name of the group.
com.google.protobuf.BoolValue	getOpen() Anyone can join open groups, otherwise only admins can accept members.
com.google.protobuf.BoolValueOrBuilder	getOpenOrBuilder() Anyone can join open groups, otherwise only admins can accept members.
com.google.protobuf.Parser<Group>	getParserForType()
int	getSerializedSize()
com.google.protobuf.Timestamp	getUpdateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was last updated.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was last updated.
boolean	hasCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) 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 (for gRPC clients) or ISO string (for REST clients) when the group was last updated.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Group.Builder	newBuilder()
static Group.Builder	newBuilder(Group prototype)
Group.Builder	newBuilderForType()
protected Group.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Group	parseDelimitedFrom(java.io.InputStream input)
static Group	parseDelimitedFrom(java.io.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(java.nio.ByteBuffer data)
static Group	parseFrom(java.nio.ByteBuffer 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(java.io.InputStream input)
static Group	parseFrom(java.io.InputStream input, 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.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

CREATOR_ID_FIELD_NUMBER

public static final int CREATOR_ID_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

LANG_TAG_FIELD_NUMBER

public static final int LANG_TAG_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

AVATAR_URL_FIELD_NUMBER

public static final int AVATAR_URL_FIELD_NUMBER

See Also:

Constant Field Values

OPEN_FIELD_NUMBER

public static final int OPEN_FIELD_NUMBER

See Also:

Constant Field Values

EDGE_COUNT_FIELD_NUMBER

public static final int EDGE_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

MAX_COUNT_FIELD_NUMBER

public static final int MAX_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getId

public java.lang.String getId()

 The id of a group.
 

string id = 1 [json_name = "id"];

Specified by:

getId in interface GroupOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 The id of a group.
 

string id = 1 [json_name = "id"];

Specified by:

getIdBytes in interface GroupOrBuilder

Returns:

The bytes for id.

getCreatorId

public java.lang.String getCreatorId()

 The id of the user who created the group.
 

string creator_id = 2 [json_name = "creatorId"];

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 [json_name = "creatorId"];

Specified by:

getCreatorIdBytes in interface GroupOrBuilder

Returns:

The bytes for creatorId.

getName

public java.lang.String getName()

 The unique name of the group.
 

string name = 3 [json_name = "name"];

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 [json_name = "name"];

Specified by:

getNameBytes in interface GroupOrBuilder

Returns:

The bytes for name.

getDescription

public java.lang.String getDescription()

 A description for the group.
 

string description = 4 [json_name = "description"];

Specified by:

getDescription in interface GroupOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 A description for the group.
 

string description = 4 [json_name = "description"];

Specified by:

getDescriptionBytes in interface GroupOrBuilder

Returns:

The bytes for description.

getLangTag

public java.lang.String getLangTag()

 The language expected to be a tag which follows the BCP-47 spec.
 

string lang_tag = 5 [json_name = "langTag"];

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 [json_name = "langTag"];

Specified by:

getLangTagBytes in interface GroupOrBuilder

Returns:

The bytes for langTag.

getMetadata

public java.lang.String getMetadata()

 Additional information stored as a JSON object.
 

string metadata = 6 [json_name = "metadata"];

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 [json_name = "metadata"];

Specified by:

getMetadataBytes in interface GroupOrBuilder

Returns:

The bytes for metadata.

getAvatarUrl

public java.lang.String getAvatarUrl()

 A URL for an avatar image.
 

string avatar_url = 7 [json_name = "avatarUrl"];

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 [json_name = "avatarUrl"];

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 [json_name = "open"];

Specified by:

hasOpen in interface GroupOrBuilder

Returns:

Whether the open field is set.

getOpen

public com.google.protobuf.BoolValue getOpen()

 Anyone can join open groups, otherwise only admins can accept members.
 

.google.protobuf.BoolValue open = 8 [json_name = "open"];

Specified by:

getOpen in interface GroupOrBuilder

Returns:

The open.

getOpenOrBuilder

public com.google.protobuf.BoolValueOrBuilder getOpenOrBuilder()

 Anyone can join open groups, otherwise only admins can accept members.
 

.google.protobuf.BoolValue open = 8 [json_name = "open"];

Specified by:

getOpenOrBuilder in interface GroupOrBuilder

getEdgeCount

public int getEdgeCount()

 The current count of all members in the group.
 

int32 edge_count = 9 [json_name = "edgeCount"];

Specified by:

getEdgeCount in interface GroupOrBuilder

Returns:

The edgeCount.

getMaxCount

public int getMaxCount()

 The maximum number of members allowed.
 

int32 max_count = 10 [json_name = "maxCount"];

Specified by:

getMaxCount in interface GroupOrBuilder

Returns:

The maxCount.

hasCreateTime

public boolean hasCreateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created.
 

.google.protobuf.Timestamp create_time = 11 [json_name = "createTime"];

Specified by:

hasCreateTime in interface GroupOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created.
 

.google.protobuf.Timestamp create_time = 11 [json_name = "createTime"];

Specified by:

getCreateTime in interface GroupOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created.
 

.google.protobuf.Timestamp create_time = 11 [json_name = "createTime"];

Specified by:

getCreateTimeOrBuilder in interface GroupOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was last updated.
 

.google.protobuf.Timestamp update_time = 12 [json_name = "updateTime"];

Specified by:

hasUpdateTime in interface GroupOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was last updated.
 

.google.protobuf.Timestamp update_time = 12 [json_name = "updateTime"];

Specified by:

getUpdateTime in interface GroupOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was last updated.
 

.google.protobuf.Timestamp update_time = 12 [json_name = "updateTime"];

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.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.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(java.nio.ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Group parseFrom(java.nio.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(java.io.InputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

public static Group parseDelimitedFrom(java.io.InputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

public static Group parseFrom(com.google.protobuf.CodedInputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.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.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

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.GeneratedMessage

getDefaultInstanceForType

public Group getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder