com.heroiclabs.nakama.api

Interface TournamentOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Tournament, Tournament.Builder

public interface TournamentOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAuthoritative() Whether the leaderboard was created authoritatively or not.
boolean	getCanEnter() True if the tournament is active and can enter.
int	getCategory() The category of the tournament.
com.google.protobuf.Timestamp	getCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament was created.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament was created.
java.lang.String	getDescription() The description of the tournament.
com.google.protobuf.ByteString	getDescriptionBytes() The description of the tournament.
int	getDuration() Duration of the tournament in seconds.
int	getEndActive() The UNIX time when the tournament stops being active until next reset.
com.google.protobuf.Timestamp	getEndTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will be stopped.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will be stopped.
java.lang.String	getId() The ID of the tournament.
com.google.protobuf.ByteString	getIdBytes() The ID of the tournament.
int	getMaxNumScore() The maximum score updates allowed per player for the current tournament.
int	getMaxSize() The maximum number of players for the tournament.
java.lang.String	getMetadata() Additional information stored as a JSON object.
com.google.protobuf.ByteString	getMetadataBytes() Additional information stored as a JSON object.
int	getNextReset() The UNIX time when the tournament is next playable.
Operator	getOperator() Operator.
int	getOperatorValue() Operator.
int	getPrevReset() The UNIX time when the tournament was last reset.
int	getSize() The current number of players in the tournament.
int	getSortOrder() ASC (0) or DESC (1) sort mode of scores in the tournament.
int	getStartActive() The UNIX time when the tournament start being active.
com.google.protobuf.Timestamp	getStartTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will start.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will start.
java.lang.String	getTitle() The title for the tournament.
com.google.protobuf.ByteString	getTitleBytes() The title for the tournament.
boolean	hasCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament was created.
boolean	hasEndTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will be stopped.
boolean	hasStartTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will start.

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 the tournament.
 

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

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 The ID of the tournament.
 

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

Returns:

The bytes for id.

getTitle

java.lang.String getTitle()

 The title for the tournament.
 

string title = 2 [json_name = "title"];

Returns:

The title.

getTitleBytes

com.google.protobuf.ByteString getTitleBytes()

 The title for the tournament.
 

string title = 2 [json_name = "title"];

Returns:

The bytes for title.

getDescription

java.lang.String getDescription()

 The description of the tournament. May be blank.
 

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

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 The description of the tournament. May be blank.
 

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

Returns:

The bytes for description.

getCategory

int getCategory()

 The category of the tournament. e.g. "vip" could be category 1.
 

uint32 category = 4 [json_name = "category"];

Returns:

The category.

getSortOrder

int getSortOrder()

 ASC (0) or DESC (1) sort mode of scores in the tournament.
 

uint32 sort_order = 5 [json_name = "sortOrder"];

Returns:

The sortOrder.

getSize

int getSize()

 The current number of players in the tournament.
 

uint32 size = 6 [json_name = "size"];

Returns:

The size.

getMaxSize

int getMaxSize()

 The maximum number of players for the tournament.
 

uint32 max_size = 7 [json_name = "maxSize"];

Returns:

The maxSize.

getMaxNumScore

int getMaxNumScore()

 The maximum score updates allowed per player for the current tournament.
 

uint32 max_num_score = 8 [json_name = "maxNumScore"];

Returns:

The maxNumScore.

getCanEnter

boolean getCanEnter()

 True if the tournament is active and can enter. A computed value.
 

bool can_enter = 9 [json_name = "canEnter"];

Returns:

The canEnter.

getEndActive

int getEndActive()

 The UNIX time when the tournament stops being active until next reset. A computed value.
 

uint32 end_active = 10 [json_name = "endActive"];

Returns:

The endActive.

getNextReset

int getNextReset()

 The UNIX time when the tournament is next playable. A computed value.
 

uint32 next_reset = 11 [json_name = "nextReset"];

Returns:

The nextReset.

getMetadata

java.lang.String getMetadata()

 Additional information stored as a JSON object.
 

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

Returns:

The metadata.

getMetadataBytes

com.google.protobuf.ByteString getMetadataBytes()

 Additional information stored as a JSON object.
 

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

Returns:

The bytes for metadata.

hasCreateTime

boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 13 [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 tournament was created.
 

.google.protobuf.Timestamp create_time = 13 [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 tournament was created.
 

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

hasStartTime

boolean hasStartTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will start.
 

.google.protobuf.Timestamp start_time = 14 [json_name = "startTime"];

Returns:

Whether the startTime field is set.

getStartTime

com.google.protobuf.Timestamp getStartTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will start.
 

.google.protobuf.Timestamp start_time = 14 [json_name = "startTime"];

Returns:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will start.
 

.google.protobuf.Timestamp start_time = 14 [json_name = "startTime"];

hasEndTime

boolean hasEndTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will be stopped.
 

.google.protobuf.Timestamp end_time = 15 [json_name = "endTime"];

Returns:

Whether the endTime field is set.

getEndTime

com.google.protobuf.Timestamp getEndTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will be stopped.
 

.google.protobuf.Timestamp end_time = 15 [json_name = "endTime"];

Returns:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the tournament will be stopped.
 

.google.protobuf.Timestamp end_time = 15 [json_name = "endTime"];

getDuration

int getDuration()

 Duration of the tournament in seconds.
 

uint32 duration = 16 [json_name = "duration"];

Returns:

The duration.

getStartActive

int getStartActive()

 The UNIX time when the tournament start being active. A computed value.
 

uint32 start_active = 17 [json_name = "startActive"];

Returns:

The startActive.

getPrevReset

int getPrevReset()

 The UNIX time when the tournament was last reset. A computed value.
 

uint32 prev_reset = 18 [json_name = "prevReset"];

Returns:

The prevReset.

getOperatorValue

int getOperatorValue()

 Operator.
 

.nakama.api.Operator operator = 19 [json_name = "operator"];

Returns:

The enum numeric value on the wire for operator.

getOperator

Operator getOperator()

 Operator.
 

.nakama.api.Operator operator = 19 [json_name = "operator"];

Returns:

The operator.

getAuthoritative

boolean getAuthoritative()

 Whether the leaderboard was created authoritatively or not.
 

bool authoritative = 20 [json_name = "authoritative"];

Returns:

The authoritative.