com.heroiclabs.nakama.api

Interface GroupOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Group, Group.Builder

public interface GroupOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	getDescription() A description for the group.
com.google.protobuf.ByteString	getDescriptionBytes() A description for the group.
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.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.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getId

java.lang.String getId()

 The id of a group.
 

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

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 The id of a group.
 

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

Returns:

The bytes for id.

getCreatorId

java.lang.String getCreatorId()

 The id of the user who created the group.
 

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

Returns:

The creatorId.

getCreatorIdBytes

com.google.protobuf.ByteString getCreatorIdBytes()

 The id of the user who created the group.
 

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

Returns:

The bytes for creatorId.

getName

java.lang.String getName()

 The unique name of the group.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The unique name of the group.
 

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

Returns:

The bytes for name.

getDescription

java.lang.String getDescription()

 A description for the group.
 

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

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 A description for the group.
 

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

Returns:

The bytes for description.

getLangTag

java.lang.String getLangTag()

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

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

Returns:

The langTag.

getLangTagBytes

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"];

Returns:

The bytes for langTag.

getMetadata

java.lang.String getMetadata()

 Additional information stored as a JSON object.
 

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

Returns:

The metadata.

getMetadataBytes

com.google.protobuf.ByteString getMetadataBytes()

 Additional information stored as a JSON object.
 

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

Returns:

The bytes for metadata.

getAvatarUrl

java.lang.String getAvatarUrl()

 A URL for an avatar image.
 

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

Returns:

The avatarUrl.

getAvatarUrlBytes

com.google.protobuf.ByteString getAvatarUrlBytes()

 A URL for an avatar image.
 

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

Returns:

The bytes for avatarUrl.

hasOpen

boolean hasOpen()

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

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

Returns:

Whether the open field is set.

getOpen

com.google.protobuf.BoolValue getOpen()

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

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

Returns:

The open.

getOpenOrBuilder

com.google.protobuf.BoolValueOrBuilder getOpenOrBuilder()

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

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

getEdgeCount

int getEdgeCount()

 The current count of all members in the group.
 

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

Returns:

The edgeCount.

getMaxCount

int getMaxCount()

 The maximum number of members allowed.
 

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

Returns:

The maxCount.

hasCreateTime

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"];

Returns:

Whether the createTime field is set.

getCreateTime

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"];

Returns:

The createTime.

getCreateTimeOrBuilder

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"];

hasUpdateTime

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"];

Returns:

Whether the updateTime field is set.

getUpdateTime

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"];

Returns:

The updateTime.

getUpdateTimeOrBuilder

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"];