Class UnreadMentionMeChannelsQueryParams

  • All Implemented Interfaces:

    
    public final class UnreadMentionMeChannelsQueryParams
    
                        

    Query parameters for channels with unread @me messages.

    Usage Example:

    val params = UnreadMentionMeChannelsQueryParams(
        channelTypes = listOf(ChannelType.GROUP, ChannelType.COMMUNITY)
    ).apply {
        topPriority = true
        pageSize = 20
    }
    val query = BaseChannel.createUnreadMentionMeChannelsQuery(params)
    query.loadNextPage { channels, error ->
        // ...
    }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final Boolean getTopPriority() Whether pinned channels are returned first.
      final Unit setTopPriority(Boolean topPriority) Whether pinned channels are returned first.
      final Long getStartTime() Start timestamp (milliseconds) for the query.
      final Unit setStartTime(Long startTime) Start timestamp (milliseconds) for the query.
      final Integer getPageSize() Number of items per page.
      final Unit setPageSize(Integer pageSize) Number of items per page.
      final List<ChannelType> getChannelTypes()
      • Methods inherited from class java.lang.Object

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

      • UnreadMentionMeChannelsQueryParams

        UnreadMentionMeChannelsQueryParams(List<ChannelType> channelTypes)
        Parameters:
        channelTypes - List of channel types to query.
    • Method Detail

      • getTopPriority

         final Boolean getTopPriority()

        Whether pinned channels are returned first.

        When true, pinned channels are prioritized in the results. When false, results are sorted by time only. Defaults to true.

      • setTopPriority

         final Unit setTopPriority(Boolean topPriority)

        Whether pinned channels are returned first.

        When true, pinned channels are prioritized in the results. When false, results are sorted by time only. Defaults to true.

      • getStartTime

         final Long getStartTime()

        Start timestamp (milliseconds) for the query.

        Pass 0 to query from the latest channels. For subsequent pages, pass the last item's timestamp from the previous page. Defaults to 0.

      • setStartTime

         final Unit setStartTime(Long startTime)

        Start timestamp (milliseconds) for the query.

        Pass 0 to query from the latest channels. For subsequent pages, pass the last item's timestamp from the previous page. Defaults to 0.

      • getPageSize

         final Integer getPageSize()

        Number of items per page. Valid range: 1, 100. Defaults to 20.

      • setPageSize

         final Unit setPageSize(Integer pageSize)

        Number of items per page. Valid range: 1, 100. Defaults to 20.