Interface GroupChannelListProps

Hierarchy

  • GroupChannelListProps

Properties

Fragment Header List TypeSelector

Properties

Fragment

Fragment: {
    collectionCreator?: (() => GroupChannelCollection);
    flatListProps?: Omit<FlatListProps<GroupChannel>, "data" | "renderItem">;
    menuItemCreator?: ((defaultMenuItem: ActionMenuItem) => ActionMenuItem);
    onPressChannel: ((channel: GroupChannel) => void);
    onPressCreateChannel: ((channelType: GroupChannelType) => void);
    queryCreator?: (() => GroupChannelListQuery);
    renderGroupChannelPreview?: ((channel: GroupChannel, onLongPressChannel: (() => void)) => null | ReactElement<any, string | JSXElementConstructor<any>>);
    skipTypeSelection?: boolean;
}

Props for GroupChannelListFragment *

Type declaration

  • Optional collectionCreator?: (() => GroupChannelCollection)
      • (): GroupChannelCollection

      • Custom Collection creator for group channel collection *

        Returns GroupChannelCollection

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

    FlatList props for GroupChannelList.List *

  • Optional menuItemCreator?: ((defaultMenuItem: ActionMenuItem) => ActionMenuItem)
      • (defaultMenuItem: ActionMenuItem): ActionMenuItem

      • Action menu item creator for onLongPress *

        Parameters

        • defaultMenuItem: ActionMenuItem

        Returns ActionMenuItem

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

      • Navigate to GroupChannelFragment *

        Parameters

        • channel: GroupChannel

        Returns void

  • onPressCreateChannel: ((channelType: GroupChannelType) => void)
  • Optional queryCreator?: (() => GroupChannelListQuery)
      • (): GroupChannelListQuery

      • Custom Query creator for channels query *

        Returns GroupChannelListQuery

  • Optional renderGroupChannelPreview?: ((channel: GroupChannel, onLongPressChannel: (() => void)) => null | ReactElement<any, string | JSXElementConstructor<any>>)
      • (channel: GroupChannel, onLongPressChannel: (() => void)): null | ReactElement<any, string | JSXElementConstructor<any>>

      • Method to render GroupChannel preview *

        Parameters

        • channel: GroupChannel
        • onLongPressChannel: (() => void)
            • (): void

            • Returns void

        Returns null | ReactElement<any, string | JSXElementConstructor<any>>

  • Optional skipTypeSelection?: boolean

    Skip type selection, When this is set to true 'channelType' only receive 'GROUP' type *

Header

Header: {}

Props for GroupChannelListModule.Header *

Type declaration

    List

    List: {
        flatListProps?: Omit<FlatListProps<GroupChannel>, "data" | "renderItem">;
        groupChannels: GroupChannel[];
        menuItemCreator?: ((defaultMenuItem: ActionMenuItem) => ActionMenuItem);
        onLoadNext: (() => Promise<void>);
        renderGroupChannelPreview: ((channel: GroupChannel, onLongPressChannel: (() => void)) => null | ReactElement<any, string | JSXElementConstructor<any>>);
    }

    Props for GroupChannelListModule.List *

    Type declaration

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

      Prop from Fragment *

    • groupChannels: GroupChannel[]

      GroupChannels from SendbirdChat SDK *

    • Optional menuItemCreator?: ((defaultMenuItem: ActionMenuItem) => ActionMenuItem)
        • (defaultMenuItem: ActionMenuItem): ActionMenuItem

        • Prop from Fragment *

          Parameters

          • defaultMenuItem: ActionMenuItem

          Returns ActionMenuItem

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

        • Method to load more data, called with onEndReached of FlatList *

          Returns Promise<void>

    • renderGroupChannelPreview: ((channel: GroupChannel, onLongPressChannel: (() => void)) => null | ReactElement<any, string | JSXElementConstructor<any>>)
        • (channel: GroupChannel, onLongPressChannel: (() => void)): null | ReactElement<any, string | JSXElementConstructor<any>>

        • Method to render GroupChannel preview *

          Parameters

          • channel: GroupChannel
          • onLongPressChannel: (() => void)
              • (): void

              • Returns void

          Returns null | ReactElement<any, string | JSXElementConstructor<any>>

    TypeSelector

    TypeSelector: {
        onSelectType: ((type: GroupChannelType) => void);
        skipTypeSelection: boolean;
    }

    Props for GroupChannelListModule.TypeSelector *

    Type declaration

    • onSelectType: ((type: GroupChannelType) => void)
    • skipTypeSelection: boolean

      Prop from Fragment Fragment.skipTypeSelection *

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc