Class EnterOpenChannelParams

  • All Implemented Interfaces:

    
    public final class EnterOpenChannelParams
    
                        

    Parameters for entering (joining) an open channel.

    Usage Example:

    val params = EnterOpenChannelParams().apply {
        messageCount = 10
        extra = "hello"
    }
    openChannel.enterChannel(params) { error -> ... }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Integer messageCount
      private String extra
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final Integer getMessageCount() Number of history messages fetched on enter.
      final Unit setMessageCount(Integer messageCount) Number of history messages fetched on enter.
      final String getExtra() Additional info for entering (max 128 characters).
      final Unit setExtra(String extra) Additional info for entering (max 128 characters).
      String toString()
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • EnterOpenChannelParams

        EnterOpenChannelParams()
    • Method Detail

      • getMessageCount

         final Integer getMessageCount()

        Number of history messages fetched on enter.

        Value range is -1..50. -1 means no history messages are fetched, 0 fetches the default (10 messages). Default is 20.

      • setMessageCount

         final Unit setMessageCount(Integer messageCount)

        Number of history messages fetched on enter.

        Value range is -1..50. -1 means no history messages are fetched, 0 fetches the default (10 messages). Default is 20.

      • getExtra

         final String getExtra()

        Additional info for entering (max 128 characters).

      • setExtra

         final Unit setExtra(String extra)

        Additional info for entering (max 128 characters).