Type alias OpenChannelListProps

Type declaration

• Fragment: {
      flatListProps?: OpenChannelListProps["List"]["flatListProps"];
      onPressChannel: ((channel: SendbirdOpenChannel) => void);
      onPressCreateChannel: (() => void);
      queryCreator?: UseOpenChannelListOptions["queryCreator"];
      renderOpenChannelPreview?: OpenChannelListProps["List"]["renderOpenChannelPreview"];
  }

  • Optional flatListProps?: OpenChannelListProps["List"]["flatListProps"]

    Props for FlatList component, it passed to OpenChannelList.List *

  • onPressChannel: ((channel: SendbirdOpenChannel) => void)

    • • (channel: SendbirdOpenChannel): void

      • Handler for navigating to OpenChannelFragment *

        Parameters

        • channel: SendbirdOpenChannel

        Returns void

  • onPressCreateChannel: (() => void)

    • • (): void

      • Handler for navigating to OpenChannelCreateFragment *

        Returns void

  • Optional queryCreator?: UseOpenChannelListOptions["queryCreator"]

    Method for creating a custom query of open channel list *

  • Optional renderOpenChannelPreview?: OpenChannelListProps["List"]["renderOpenChannelPreview"]

    Method for rendering open channel preview *

• Header: {
      onPressHeaderRight: (() => void);
  }

  • onPressHeaderRight: (() => void)

    • • (): void

      • Returns void

• List: {
      flatListProps?: Omit<FlatListProps<SendbirdOpenChannel>, "data" | "renderItem">;
      onLoadNext: (() => Promise<void>);
      onRefresh: (() => void);
      openChannels: SendbirdOpenChannel[];
      refreshing: boolean;
      renderOpenChannelPreview: ((props: {
          channel: SendbirdOpenChannel;
      }) => React.ReactElement | null);
  }

  • Optional flatListProps?: Omit<FlatListProps<SendbirdOpenChannel>, "data" | "renderItem">

    Props for the FlatList component, passed to the OpenChannelList.List *

  • onLoadNext: (() => Promise<void>)

    • • (): Promise<void>

      • Handler for loading the next batch of open channels *

        Returns Promise<void>

  • onRefresh: (() => void)

    • • (): void

      • Handler for refreshing the list of open channels *

        Returns void

  • openChannels: SendbirdOpenChannel[]

    OpenChannels from SendbirdChat SDK *

  • refreshing: boolean

    Props for the indicates if the FlatList is currently being refreshed *

  • renderOpenChannelPreview: ((props: {
        channel: SendbirdOpenChannel;
    }) => React.ReactElement | null)

    • • (props: {
            channel: SendbirdOpenChannel;
        }): React.ReactElement | null

      • Method for rendering a preview of each open channel *

        Parameters

        • props: {
              channel: SendbirdOpenChannel;
          }

          • channel: SendbirdOpenChannel

        Returns React.ReactElement | null

• StatusError: {
      onPressRetry: (() => void);
  }

  • onPressRetry: (() => void)

    • • (): void

      • Returns void