ListChannelMessagesRequest.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<ListChannelMessagesRequest.Builder>
    - - com.heroiclabs.nakama.api.ListChannelMessagesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ListChannelMessagesRequest
```
public static final class ListChannelMessagesRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListChannelMessagesRequest.Builder>
implements ListChannelMessagesRequestOrBuilder
```
```
 List a channel's message history.
 
```
Protobuf type nakama.api.ListChannelMessagesRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListChannelMessagesRequest`	`build()`
`ListChannelMessagesRequest`	`buildPartial()`
`ListChannelMessagesRequest.Builder`	`clear()`
`ListChannelMessagesRequest.Builder`	`clearChannelId()` The channel ID to list from.
`ListChannelMessagesRequest.Builder`	`clearCursor()` A pagination cursor, if any.
`ListChannelMessagesRequest.Builder`	`clearForward()` True if listing should be older messages to newer, false if reverse.
`ListChannelMessagesRequest.Builder`	`clearLimit()` Max number of records to return.
`java.lang.String`	`getChannelId()` The channel ID to list from.
`com.google.protobuf.ByteString`	`getChannelIdBytes()` The channel ID to list from.
`java.lang.String`	`getCursor()` A pagination cursor, if any.
`com.google.protobuf.ByteString`	`getCursorBytes()` A pagination cursor, if any.
`ListChannelMessagesRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`com.google.protobuf.BoolValue`	`getForward()` True if listing should be older messages to newer, false if reverse.
`com.google.protobuf.BoolValue.Builder`	`getForwardBuilder()` True if listing should be older messages to newer, false if reverse.
`com.google.protobuf.BoolValueOrBuilder`	`getForwardOrBuilder()` True if listing should be older messages to newer, false if reverse.
`com.google.protobuf.Int32Value`	`getLimit()` Max number of records to return.
`com.google.protobuf.Int32Value.Builder`	`getLimitBuilder()` Max number of records to return.
`com.google.protobuf.Int32ValueOrBuilder`	`getLimitOrBuilder()` Max number of records to return.
`boolean`	`hasForward()` True if listing should be older messages to newer, false if reverse.
`boolean`	`hasLimit()` Max number of records to return.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListChannelMessagesRequest.Builder`	`mergeForward(com.google.protobuf.BoolValue value)` True if listing should be older messages to newer, false if reverse.
`ListChannelMessagesRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListChannelMessagesRequest.Builder`	`mergeFrom(ListChannelMessagesRequest other)`
`ListChannelMessagesRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListChannelMessagesRequest.Builder`	`mergeLimit(com.google.protobuf.Int32Value value)` Max number of records to return.
`ListChannelMessagesRequest.Builder`	`setChannelId(java.lang.String value)` The channel ID to list from.
`ListChannelMessagesRequest.Builder`	`setChannelIdBytes(com.google.protobuf.ByteString value)` The channel ID to list from.
`ListChannelMessagesRequest.Builder`	`setCursor(java.lang.String value)` A pagination cursor, if any.
`ListChannelMessagesRequest.Builder`	`setCursorBytes(com.google.protobuf.ByteString value)` A pagination cursor, if any.
`ListChannelMessagesRequest.Builder`	`setForward(com.google.protobuf.BoolValue.Builder builderForValue)` True if listing should be older messages to newer, false if reverse.
`ListChannelMessagesRequest.Builder`	`setForward(com.google.protobuf.BoolValue value)` True if listing should be older messages to newer, false if reverse.
`ListChannelMessagesRequest.Builder`	`setLimit(com.google.protobuf.Int32Value.Builder builderForValue)` Max number of records to return.
`ListChannelMessagesRequest.Builder`	`setLimit(com.google.protobuf.Int32Value value)` Max number of records to return.

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<ListChannelMessagesRequest.Builder>
  - clear
```
public ListChannelMessagesRequest.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<ListChannelMessagesRequest.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<ListChannelMessagesRequest.Builder>
  - getDefaultInstanceForType
```
public ListChannelMessagesRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public ListChannelMessagesRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public ListChannelMessagesRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public ListChannelMessagesRequest.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<ListChannelMessagesRequest.Builder>
  - mergeFrom
```
public ListChannelMessagesRequest.Builder mergeFrom(ListChannelMessagesRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListChannelMessagesRequest.Builder>
  - mergeFrom
```
public ListChannelMessagesRequest.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<ListChannelMessagesRequest.Builder>
    
    Throws:
    
    java.io.IOException
  - getChannelId
```
public java.lang.String getChannelId()
```
```
 The channel ID to list from.
 
```
    string channel_id = 1 [json_name = "channelId"];
    Specified by:
    
    getChannelId in interface ListChannelMessagesRequestOrBuilder
    
    Returns:
    
    The channelId.
  - getChannelIdBytes
```
public com.google.protobuf.ByteString getChannelIdBytes()
```
```
 The channel ID to list from.
 
```
    string channel_id = 1 [json_name = "channelId"];
    Specified by:
    
    getChannelIdBytes in interface ListChannelMessagesRequestOrBuilder
    
    Returns:
    
    The bytes for channelId.
  - setChannelId
```
public ListChannelMessagesRequest.Builder setChannelId(java.lang.String value)
```
```
 The channel ID to list from.
 
```
    string channel_id = 1 [json_name = "channelId"];
    Parameters:
    
    value - The channelId to set.
    
    Returns:
    
    This builder for chaining.
  - clearChannelId
```
public ListChannelMessagesRequest.Builder clearChannelId()
```
```
 The channel ID to list from.
 
```
    string channel_id = 1 [json_name = "channelId"];
    Returns:
    
    This builder for chaining.
  - setChannelIdBytes
```
public ListChannelMessagesRequest.Builder setChannelIdBytes(com.google.protobuf.ByteString value)
```
```
 The channel ID to list from.
 
```
    string channel_id = 1 [json_name = "channelId"];
    Parameters:
    
    value - The bytes for channelId to set.
    
    Returns:
    
    This builder for chaining.
  - hasLimit
```
public boolean hasLimit()
```
```
 Max number of records to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 2 [json_name = "limit"];
    Specified by:
    
    hasLimit in interface ListChannelMessagesRequestOrBuilder
    
    Returns:
    
    Whether the limit field is set.
  - getLimit
```
public com.google.protobuf.Int32Value getLimit()
```
```
 Max number of records to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 2 [json_name = "limit"];
    Specified by:
    
    getLimit in interface ListChannelMessagesRequestOrBuilder
    
    Returns:
    
    The limit.
  - setLimit
```
public ListChannelMessagesRequest.Builder setLimit(com.google.protobuf.Int32Value value)
```
```
 Max number of records to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 2 [json_name = "limit"];
  - setLimit
```
public ListChannelMessagesRequest.Builder setLimit(com.google.protobuf.Int32Value.Builder builderForValue)
```
```
 Max number of records to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 2 [json_name = "limit"];
  - mergeLimit
```
public ListChannelMessagesRequest.Builder mergeLimit(com.google.protobuf.Int32Value value)
```
```
 Max number of records to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 2 [json_name = "limit"];
  - clearLimit
```
public ListChannelMessagesRequest.Builder clearLimit()
```
```
 Max number of records to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 2 [json_name = "limit"];
  - getLimitBuilder
```
public com.google.protobuf.Int32Value.Builder getLimitBuilder()
```
```
 Max number of records to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 2 [json_name = "limit"];
  - getLimitOrBuilder
```
public com.google.protobuf.Int32ValueOrBuilder getLimitOrBuilder()
```
```
 Max number of records to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 2 [json_name = "limit"];
    Specified by:
    
    getLimitOrBuilder in interface ListChannelMessagesRequestOrBuilder
  - hasForward
```
public boolean hasForward()
```
```
 True if listing should be older messages to newer, false if reverse.
 
```
    .google.protobuf.BoolValue forward = 3 [json_name = "forward"];
    Specified by:
    
    hasForward in interface ListChannelMessagesRequestOrBuilder
    
    Returns:
    
    Whether the forward field is set.
  - getForward
```
public com.google.protobuf.BoolValue getForward()
```
```
 True if listing should be older messages to newer, false if reverse.
 
```
    .google.protobuf.BoolValue forward = 3 [json_name = "forward"];
    Specified by:
    
    getForward in interface ListChannelMessagesRequestOrBuilder
    
    Returns:
    
    The forward.
  - setForward
```
public ListChannelMessagesRequest.Builder setForward(com.google.protobuf.BoolValue value)
```
```
 True if listing should be older messages to newer, false if reverse.
 
```
    .google.protobuf.BoolValue forward = 3 [json_name = "forward"];
  - setForward
```
public ListChannelMessagesRequest.Builder setForward(com.google.protobuf.BoolValue.Builder builderForValue)
```
```
 True if listing should be older messages to newer, false if reverse.
 
```
    .google.protobuf.BoolValue forward = 3 [json_name = "forward"];
  - mergeForward
```
public ListChannelMessagesRequest.Builder mergeForward(com.google.protobuf.BoolValue value)
```
```
 True if listing should be older messages to newer, false if reverse.
 
```
    .google.protobuf.BoolValue forward = 3 [json_name = "forward"];
  - clearForward
```
public ListChannelMessagesRequest.Builder clearForward()
```
```
 True if listing should be older messages to newer, false if reverse.
 
```
    .google.protobuf.BoolValue forward = 3 [json_name = "forward"];
  - getForwardBuilder
```
public com.google.protobuf.BoolValue.Builder getForwardBuilder()
```
```
 True if listing should be older messages to newer, false if reverse.
 
```
    .google.protobuf.BoolValue forward = 3 [json_name = "forward"];
  - getForwardOrBuilder
```
public com.google.protobuf.BoolValueOrBuilder getForwardOrBuilder()
```
```
 True if listing should be older messages to newer, false if reverse.
 
```
    .google.protobuf.BoolValue forward = 3 [json_name = "forward"];
    Specified by:
    
    getForwardOrBuilder in interface ListChannelMessagesRequestOrBuilder
  - getCursor
```
public java.lang.String getCursor()
```
```
 A pagination cursor, if any.
 
```
    string cursor = 4 [json_name = "cursor"];
    Specified by:
    
    getCursor in interface ListChannelMessagesRequestOrBuilder
    
    Returns:
    
    The cursor.
  - getCursorBytes
```
public com.google.protobuf.ByteString getCursorBytes()
```
```
 A pagination cursor, if any.
 
```
    string cursor = 4 [json_name = "cursor"];
    Specified by:
    
    getCursorBytes in interface ListChannelMessagesRequestOrBuilder
    
    Returns:
    
    The bytes for cursor.
  - setCursor
```
public ListChannelMessagesRequest.Builder setCursor(java.lang.String value)
```
```
 A pagination cursor, if any.
 
```
    string cursor = 4 [json_name = "cursor"];
    Parameters:
    
    value - The cursor to set.
    
    Returns:
    
    This builder for chaining.
  - clearCursor
```
public ListChannelMessagesRequest.Builder clearCursor()
```
```
 A pagination cursor, if any.
 
```
    string cursor = 4 [json_name = "cursor"];
    Returns:
    
    This builder for chaining.
  - setCursorBytes
```
public ListChannelMessagesRequest.Builder setCursorBytes(com.google.protobuf.ByteString value)
```
```
 A pagination cursor, if any.
 
```
    string cursor = 4 [json_name = "cursor"];
    Parameters:
    
    value - The bytes for cursor to set.
    
    Returns:
    
    This builder for chaining.

Class ListChannelMessagesRequest.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

getChannelId

getChannelIdBytes

setChannelId

clearChannelId

setChannelIdBytes

hasLimit

getLimit

setLimit

setLimit

mergeLimit

clearLimit

getLimitBuilder

getLimitOrBuilder

hasForward

getForward

setForward

setForward

mergeForward

clearForward

getForwardBuilder

getForwardOrBuilder

getCursor

getCursorBytes

setCursor

clearCursor

setCursorBytes