Package 

Class OpenChannelListQuery

    • Method Summary

      Modifier and Type Method Description
      void setIncludeFrozen(boolean includeFrozen) Sets true/false to include frozen channels or not.This flag is true by default.
      void setIncludeMetadata(boolean includeMetadata) Sets whether to include channel metadata on fetch.This flag is true by default.
      void setLimit(int limit) Sets the maximum number of OpenChannels per queried page.
      void setNameKeyword(String nameKeyword) Sets search keyword for channel name.
      void setUrlKeyword(String urlKeyword) Sets search keyword for channel URL.
      void setCustomTypeFilter(String customType) Sets a filter to return only channels with the specified Custom Type.
      boolean hasNext() Checks if there is a next page.
      synchronized boolean isLoading() Checks if the current query is in communication progress with server.
      boolean isIncludeFrozen() Checks whether query result includes frozen channels.
      boolean isIncludeMetadata()
      synchronized void next(OpenChannelListQuery.OpenChannelListQueryResultHandler handler) Gets the list of OpenChannels.
      • Methods inherited from class java.lang.Object

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

      • setIncludeFrozen

         void setIncludeFrozen(boolean includeFrozen)

        Sets true/false to include frozen channels or not.This flag is true by default.

        Parameters:
        includeFrozen - Flag to include frozen channels.
      • setIncludeMetadata

         void setIncludeMetadata(boolean includeMetadata)

        Sets whether to include channel metadata on fetch.This flag is true by default.

      • setLimit

         void setLimit(int limit)

        Sets the maximum number of OpenChannels per queried page.

        Parameters:
        limit - The maximum number of OpenChannels per page.
      • setNameKeyword

         void setNameKeyword(String nameKeyword)

        Sets search keyword for channel name.If this is set, next will return the list of OpenChannelsof which name matches the specified name.

        Parameters:
        nameKeyword - Name keyword.
      • setUrlKeyword

         void setUrlKeyword(String urlKeyword)

        Sets search keyword for channel URL.If this is set, next will return the list of OpenChannelsof which URL matches the specified URL.

        Parameters:
        urlKeyword - URL keyword.
      • setCustomTypeFilter

         void setCustomTypeFilter(String customType)

        Sets a filter to return only channels with the specified Custom Type.

        Parameters:
        customType - The Custom Type of the channels to return.
      • hasNext

         boolean hasNext()

        Checks if there is a next page.

      • isLoading

         synchronized boolean isLoading()

        Checks if the current query is in communication progress with server.

      • isIncludeFrozen

         boolean isIncludeFrozen()

        Checks whether query result includes frozen channels.

      • next

         synchronized void next(OpenChannelListQuery.OpenChannelListQueryResultHandler handler)

        Gets the list of OpenChannels. The queried result is passed to handler as list.If this method is repeatedly called after each next() is finished, it retrieves the following pages of the OpenChannel list.If there is no more pages to be read, an empty List (not null)is returned to handler.

        Parameters:
        handler - A callback handler to get the queried result.