ChannelJoin.Builder (nakama-java 2.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<ChannelJoin.Builder>
    - - com.heroiclabs.nakama.rtapi.ChannelJoin.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ChannelJoinOrBuilder, java.lang.Cloneable

Enclosing class:

ChannelJoin
```
public static final class ChannelJoin.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ChannelJoin.Builder>
implements ChannelJoinOrBuilder
```
```
 Join operation for a realtime chat channel.
 
```
Protobuf type nakama.realtime.ChannelJoin

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChannelJoin`	`build()`
`ChannelJoin`	`buildPartial()`
`ChannelJoin.Builder`	`clear()`
`ChannelJoin.Builder`	`clearHidden()` Whether the user should appear in the channel's presence list and events.
`ChannelJoin.Builder`	`clearPersistence()` Whether messages sent on this channel should be persistent.
`ChannelJoin.Builder`	`clearTarget()` The user ID to DM with, group ID to chat with, or room channel name to join.
`ChannelJoin.Builder`	`clearType()` The type of the chat channel.
`ChannelJoin`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`com.google.protobuf.BoolValue`	`getHidden()` Whether the user should appear in the channel's presence list and events.
`com.google.protobuf.BoolValue.Builder`	`getHiddenBuilder()` Whether the user should appear in the channel's presence list and events.
`com.google.protobuf.BoolValueOrBuilder`	`getHiddenOrBuilder()` Whether the user should appear in the channel's presence list and events.
`com.google.protobuf.BoolValue`	`getPersistence()` Whether messages sent on this channel should be persistent.
`com.google.protobuf.BoolValue.Builder`	`getPersistenceBuilder()` Whether messages sent on this channel should be persistent.
`com.google.protobuf.BoolValueOrBuilder`	`getPersistenceOrBuilder()` Whether messages sent on this channel should be persistent.
`java.lang.String`	`getTarget()` The user ID to DM with, group ID to chat with, or room channel name to join.
`com.google.protobuf.ByteString`	`getTargetBytes()` The user ID to DM with, group ID to chat with, or room channel name to join.
`int`	`getType()` The type of the chat channel.
`boolean`	`hasHidden()` Whether the user should appear in the channel's presence list and events.
`boolean`	`hasPersistence()` Whether messages sent on this channel should be persistent.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ChannelJoin.Builder`	`mergeFrom(ChannelJoin other)`
`ChannelJoin.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ChannelJoin.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ChannelJoin.Builder`	`mergeHidden(com.google.protobuf.BoolValue value)` Whether the user should appear in the channel's presence list and events.
`ChannelJoin.Builder`	`mergePersistence(com.google.protobuf.BoolValue value)` Whether messages sent on this channel should be persistent.
`ChannelJoin.Builder`	`setHidden(com.google.protobuf.BoolValue.Builder builderForValue)` Whether the user should appear in the channel's presence list and events.
`ChannelJoin.Builder`	`setHidden(com.google.protobuf.BoolValue value)` Whether the user should appear in the channel's presence list and events.
`ChannelJoin.Builder`	`setPersistence(com.google.protobuf.BoolValue.Builder builderForValue)` Whether messages sent on this channel should be persistent.
`ChannelJoin.Builder`	`setPersistence(com.google.protobuf.BoolValue value)` Whether messages sent on this channel should be persistent.
`ChannelJoin.Builder`	`setTarget(java.lang.String value)` The user ID to DM with, group ID to chat with, or room channel name to join.
`ChannelJoin.Builder`	`setTargetBytes(com.google.protobuf.ByteString value)` The user ID to DM with, group ID to chat with, or room channel name to join.
`ChannelJoin.Builder`	`setType(int value)` The type of the chat channel.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- 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.Builder<ChannelJoin.Builder>
  - clear
```
public ChannelJoin.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessage.Builder<ChannelJoin.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ChannelJoin.Builder>
  - getDefaultInstanceForType
```
public ChannelJoin getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public ChannelJoin build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public ChannelJoin buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public ChannelJoin.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ChannelJoin.Builder>
  - mergeFrom
```
public ChannelJoin.Builder mergeFrom(ChannelJoin other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ChannelJoin.Builder>
  - mergeFrom
```
public ChannelJoin.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ChannelJoin.Builder>
    
    Throws:
    
    java.io.IOException
  - getTarget
```
public java.lang.String getTarget()
```
```
 The user ID to DM with, group ID to chat with, or room channel name to join.
 
```
    string target = 1 [json_name = "target"];
    Specified by:
    
    getTarget in interface ChannelJoinOrBuilder
    
    Returns:
    
    The target.
  - getTargetBytes
```
public com.google.protobuf.ByteString getTargetBytes()
```
```
 The user ID to DM with, group ID to chat with, or room channel name to join.
 
```
    string target = 1 [json_name = "target"];
    Specified by:
    
    getTargetBytes in interface ChannelJoinOrBuilder
    
    Returns:
    
    The bytes for target.
  - setTarget
```
public ChannelJoin.Builder setTarget(java.lang.String value)
```
```
 The user ID to DM with, group ID to chat with, or room channel name to join.
 
```
    string target = 1 [json_name = "target"];
    Parameters:
    
    value - The target to set.
    
    Returns:
    
    This builder for chaining.
  - clearTarget
```
public ChannelJoin.Builder clearTarget()
```
```
 The user ID to DM with, group ID to chat with, or room channel name to join.
 
```
    string target = 1 [json_name = "target"];
    Returns:
    
    This builder for chaining.
  - setTargetBytes
```
public ChannelJoin.Builder setTargetBytes(com.google.protobuf.ByteString value)
```
```
 The user ID to DM with, group ID to chat with, or room channel name to join.
 
```
    string target = 1 [json_name = "target"];
    Parameters:
    
    value - The bytes for target to set.
    
    Returns:
    
    This builder for chaining.
  - getType
```
public int getType()
```
```
 The type of the chat channel.
 
```
    int32 type = 2 [json_name = "type"];
    Specified by:
    
    getType in interface ChannelJoinOrBuilder
    
    Returns:
    
    The type.
  - setType
```
public ChannelJoin.Builder setType(int value)
```
```
 The type of the chat channel.
 
```
    int32 type = 2 [json_name = "type"];
    Parameters:
    
    value - The type to set.
    
    Returns:
    
    This builder for chaining.
  - clearType
```
public ChannelJoin.Builder clearType()
```
```
 The type of the chat channel.
 
```
    int32 type = 2 [json_name = "type"];
    Returns:
    
    This builder for chaining.
  - hasPersistence
```
public boolean hasPersistence()
```
```
 Whether messages sent on this channel should be persistent.
 
```
    .google.protobuf.BoolValue persistence = 3 [json_name = "persistence"];
    Specified by:
    
    hasPersistence in interface ChannelJoinOrBuilder
    
    Returns:
    
    Whether the persistence field is set.
  - getPersistence
```
public com.google.protobuf.BoolValue getPersistence()
```
```
 Whether messages sent on this channel should be persistent.
 
```
    .google.protobuf.BoolValue persistence = 3 [json_name = "persistence"];
    Specified by:
    
    getPersistence in interface ChannelJoinOrBuilder
    
    Returns:
    
    The persistence.
  - setPersistence
```
public ChannelJoin.Builder setPersistence(com.google.protobuf.BoolValue value)
```
```
 Whether messages sent on this channel should be persistent.
 
```
    .google.protobuf.BoolValue persistence = 3 [json_name = "persistence"];
  - setPersistence
```
public ChannelJoin.Builder setPersistence(com.google.protobuf.BoolValue.Builder builderForValue)
```
```
 Whether messages sent on this channel should be persistent.
 
```
    .google.protobuf.BoolValue persistence = 3 [json_name = "persistence"];
  - mergePersistence
```
public ChannelJoin.Builder mergePersistence(com.google.protobuf.BoolValue value)
```
```
 Whether messages sent on this channel should be persistent.
 
```
    .google.protobuf.BoolValue persistence = 3 [json_name = "persistence"];
  - clearPersistence
```
public ChannelJoin.Builder clearPersistence()
```
```
 Whether messages sent on this channel should be persistent.
 
```
    .google.protobuf.BoolValue persistence = 3 [json_name = "persistence"];
  - getPersistenceBuilder
```
public com.google.protobuf.BoolValue.Builder getPersistenceBuilder()
```
```
 Whether messages sent on this channel should be persistent.
 
```
    .google.protobuf.BoolValue persistence = 3 [json_name = "persistence"];
  - getPersistenceOrBuilder
```
public com.google.protobuf.BoolValueOrBuilder getPersistenceOrBuilder()
```
```
 Whether messages sent on this channel should be persistent.
 
```
    .google.protobuf.BoolValue persistence = 3 [json_name = "persistence"];
    Specified by:
    
    getPersistenceOrBuilder in interface ChannelJoinOrBuilder
  - hasHidden
```
public boolean hasHidden()
```
```
 Whether the user should appear in the channel's presence list and events.
 
```
    .google.protobuf.BoolValue hidden = 4 [json_name = "hidden"];
    Specified by:
    
    hasHidden in interface ChannelJoinOrBuilder
    
    Returns:
    
    Whether the hidden field is set.
  - getHidden
```
public com.google.protobuf.BoolValue getHidden()
```
```
 Whether the user should appear in the channel's presence list and events.
 
```
    .google.protobuf.BoolValue hidden = 4 [json_name = "hidden"];
    Specified by:
    
    getHidden in interface ChannelJoinOrBuilder
    
    Returns:
    
    The hidden.
  - setHidden
```
public ChannelJoin.Builder setHidden(com.google.protobuf.BoolValue value)
```
```
 Whether the user should appear in the channel's presence list and events.
 
```
    .google.protobuf.BoolValue hidden = 4 [json_name = "hidden"];
  - setHidden
```
public ChannelJoin.Builder setHidden(com.google.protobuf.BoolValue.Builder builderForValue)
```
```
 Whether the user should appear in the channel's presence list and events.
 
```
    .google.protobuf.BoolValue hidden = 4 [json_name = "hidden"];
  - mergeHidden
```
public ChannelJoin.Builder mergeHidden(com.google.protobuf.BoolValue value)
```
```
 Whether the user should appear in the channel's presence list and events.
 
```
    .google.protobuf.BoolValue hidden = 4 [json_name = "hidden"];
  - clearHidden
```
public ChannelJoin.Builder clearHidden()
```
```
 Whether the user should appear in the channel's presence list and events.
 
```
    .google.protobuf.BoolValue hidden = 4 [json_name = "hidden"];
  - getHiddenBuilder
```
public com.google.protobuf.BoolValue.Builder getHiddenBuilder()
```
```
 Whether the user should appear in the channel's presence list and events.
 
```
    .google.protobuf.BoolValue hidden = 4 [json_name = "hidden"];
  - getHiddenOrBuilder
```
public com.google.protobuf.BoolValueOrBuilder getHiddenOrBuilder()
```
```
 Whether the user should appear in the channel's presence list and events.
 
```
    .google.protobuf.BoolValue hidden = 4 [json_name = "hidden"];
    Specified by:
    
    getHiddenOrBuilder in interface ChannelJoinOrBuilder

Class ChannelJoin.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getTarget

getTargetBytes

setTarget

clearTarget

setTargetBytes

getType

setType

clearType

hasPersistence

getPersistence

setPersistence

setPersistence

mergePersistence

clearPersistence

getPersistenceBuilder

getPersistenceOrBuilder

hasHidden

getHidden

setHidden

setHidden

mergeHidden

clearHidden

getHiddenBuilder

getHiddenOrBuilder