com.heroiclabs.nakama.api

Class Event

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.heroiclabs.nakama.api.Event

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EventOrBuilder, java.io.Serializable

public final class Event
extends com.google.protobuf.GeneratedMessage
implements EventOrBuilder

 Represents an event to be passed through the server to registered event handlers.
 

Protobuf type nakama.api.Event

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.Builder Represents an event to be passed through the server to registered event handlers.

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	EXTERNAL_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PROPERTIES_FIELD_NUMBER
static int	TIMESTAMP_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	containsProperties(java.lang.String key) Arbitrary event property values.
boolean	equals(java.lang.Object obj)
static Event	getDefaultInstance()
Event	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getExternal() True if the event came directly from a client call, false otherwise.
java.lang.String	getName() An event name, type, category, or identifier.
com.google.protobuf.ByteString	getNameBytes() An event name, type, category, or identifier.
com.google.protobuf.Parser<Event>	getParserForType()
java.util.Map<java.lang.String,java.lang.String>	getProperties() Deprecated.
int	getPropertiesCount() Arbitrary event property values.
java.util.Map<java.lang.String,java.lang.String>	getPropertiesMap() Arbitrary event property values.
java.lang.String	getPropertiesOrDefault(java.lang.String key, java.lang.String defaultValue) Arbitrary event property values.
java.lang.String	getPropertiesOrThrow(java.lang.String key) Arbitrary event property values.
int	getSerializedSize()
com.google.protobuf.Timestamp	getTimestamp() The time when the event was triggered.
com.google.protobuf.TimestampOrBuilder	getTimestampOrBuilder() The time when the event was triggered.
int	hashCode()
boolean	hasTimestamp() The time when the event was triggered.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static Event.Builder	newBuilder()
static Event.Builder	newBuilder(Event prototype)
Event.Builder	newBuilderForType()
protected Event.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Event	parseDelimitedFrom(java.io.InputStream input)
static Event	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(byte[] data)
static Event	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(java.nio.ByteBuffer data)
static Event	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(com.google.protobuf.ByteString data)
static Event	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(com.google.protobuf.CodedInputStream input)
static Event	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Event	parseFrom(java.io.InputStream input)
static Event	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Event>	parser()
Event.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, 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

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER

See Also:

Constant Field Values

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

EXTERNAL_FIELD_NUMBER

public static final int EXTERNAL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

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

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getName

public java.lang.String getName()

 An event name, type, category, or identifier.
 

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

Specified by:

getName in interface EventOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 An event name, type, category, or identifier.
 

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

Specified by:

getNameBytes in interface EventOrBuilder

Returns:

The bytes for name.

getPropertiesCount

public int getPropertiesCount()

Description copied from interface: EventOrBuilder

 Arbitrary event property values.
 

map<string, string> properties = 2 [json_name = "properties"];

Specified by:

getPropertiesCount in interface EventOrBuilder

containsProperties

public boolean containsProperties(java.lang.String key)

 Arbitrary event property values.
 

map<string, string> properties = 2 [json_name = "properties"];

Specified by:

containsProperties in interface EventOrBuilder

getProperties

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getProperties()

Deprecated.

Use getPropertiesMap() instead.

Specified by:

getProperties in interface EventOrBuilder

getPropertiesMap

public java.util.Map<java.lang.String,java.lang.String> getPropertiesMap()

 Arbitrary event property values.
 

map<string, string> properties = 2 [json_name = "properties"];

Specified by:

getPropertiesMap in interface EventOrBuilder

getPropertiesOrDefault

public java.lang.String getPropertiesOrDefault(java.lang.String key,
                                               java.lang.String defaultValue)

 Arbitrary event property values.
 

map<string, string> properties = 2 [json_name = "properties"];

Specified by:

getPropertiesOrDefault in interface EventOrBuilder

getPropertiesOrThrow

public java.lang.String getPropertiesOrThrow(java.lang.String key)

 Arbitrary event property values.
 

map<string, string> properties = 2 [json_name = "properties"];

Specified by:

getPropertiesOrThrow in interface EventOrBuilder

hasTimestamp

public boolean hasTimestamp()

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

Specified by:

hasTimestamp in interface EventOrBuilder

Returns:

Whether the timestamp field is set.

getTimestamp

public com.google.protobuf.Timestamp getTimestamp()

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

Specified by:

getTimestamp in interface EventOrBuilder

Returns:

The timestamp.

getTimestampOrBuilder

public com.google.protobuf.TimestampOrBuilder getTimestampOrBuilder()

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];

Specified by:

getTimestampOrBuilder in interface EventOrBuilder

getExternal

public boolean getExternal()

 True if the event came directly from a client call, false otherwise.
 

bool external = 4 [json_name = "external"];

Specified by:

getExternal in interface EventOrBuilder

Returns:

The external.

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 Event parseFrom(java.nio.ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(java.nio.ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Event parseFrom(java.io.InputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public Event.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Event.Builder newBuilder()

newBuilder

public static Event.Builder newBuilder(Event prototype)

toBuilder

public Event.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Event.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Event getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Event> 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 Event getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder