Interface GroupChannelProps

Hierarchy

  • GroupChannelProps

Properties

Fragment Header Input MessageList Provider SuggestedMentionList

Properties

Fragment

Fragment: {
    channel: GroupChannel;
    collectionCreator?: ((options?) => MessageCollection);
    enableMessageGrouping?: boolean;
    enableTypingIndicator?: boolean;
    flatListProps?: Omit<FlatListProps<SendbirdMessage>, "data" | "renderItem">;
    keyboardAvoidOffset?: number;
    messageListQueryParams?: MessageListQueryParamsType;
    onBeforeSendFileMessage?: OnBeforeHandler<FileMessageCreateParams>;
    onBeforeSendUserMessage?: OnBeforeHandler<UserMessageCreateParams>;
    onBeforeUpdateFileMessage?: OnBeforeHandler<FileMessageUpdateParams>;
    onBeforeUpdateUserMessage?: OnBeforeHandler<UserMessageUpdateParams>;
    onChannelDeleted: (() => void);
    onPressHeaderLeft: (() => void);
    onPressHeaderRight: (() => void);
    onPressMediaMessage?: ((message, deleteMessage, uri) => void);
    renderMessage?: ((props) => null | ReactElement<any, string | JSXElementConstructor<any>>);
    renderNewMessagesButton?: null | ((props) => null | ReactElement<any, string | JSXElementConstructor<any>>);
    renderScrollToBottomButton?: null | ((props) => null | ReactElement<any, string | JSXElementConstructor<any>>);
    searchItem?: {
        startingPoint: number;
    };
    sortComparator?: ((a, b) => number);
}

Type declaration

  • channel: GroupChannel
  • Optional collectionCreator?: ((options?) => MessageCollection)
      • (options?): MessageCollection

      • Parameters

        • Optional options: Pick<UseGroupChannelMessagesOptions, "startingPoint">

        Returns MessageCollection

        Deprecated

        Please use messageListQueryParams instead

  • Optional enableMessageGrouping?: boolean
  • Optional enableTypingIndicator?: boolean
  • Optional flatListProps?: Omit<FlatListProps<SendbirdMessage>, "data" | "renderItem">
  • Optional keyboardAvoidOffset?: number
  • Optional messageListQueryParams?: MessageListQueryParamsType

    Description

    You can specify the query parameters for the message list.

    Example

    <GroupChannelFragment messageListQueryParams={{ prevResultLimit: 20, customTypesFilter: ['filter'] }} />
  • Optional onBeforeSendFileMessage?: OnBeforeHandler<FileMessageCreateParams>
  • Optional onBeforeSendUserMessage?: OnBeforeHandler<UserMessageCreateParams>
  • Optional onBeforeUpdateFileMessage?: OnBeforeHandler<FileMessageUpdateParams>
  • Optional onBeforeUpdateUserMessage?: OnBeforeHandler<UserMessageUpdateParams>
  • onChannelDeleted: (() => void)
      • (): void

      • Returns void

  • onPressHeaderLeft: (() => void)
      • (): void

      • Returns void

  • onPressHeaderRight: (() => void)
      • (): void

      • Returns void

  • Optional onPressMediaMessage?: ((message, deleteMessage, uri) => void)
      • (message, deleteMessage, uri): void

      • Parameters

        • message: FileMessage
        • deleteMessage: (() => Promise<void>)
            • (): Promise<void>

            • Returns Promise<void>

        • uri: string

        Returns void

  • Optional renderMessage?: ((props) => null | ReactElement<any, string | JSXElementConstructor<any>>)
      • (props): null | ReactElement<any, string | JSXElementConstructor<any>>

      • Parameters

        • props: {
              bottomSheetItem?: BottomSheetItem;
              channel: GroupChannel;
              currentUserId?: string;
              enableMessageGrouping: boolean;
              focused: boolean;
              isFirstItem: boolean;
              message: SendbirdMessage;
              nextMessage?: SendbirdMessage;
              onLongPress?: (() => void);
              onPress?: (() => void);
              onPressParentMessage?: ((parentMessage) => void);
              onShowUserProfile?: ((user, options?) => void);
              prevMessage?: SendbirdMessage;
          }
          • Optional bottomSheetItem?: BottomSheetItem
          • channel: GroupChannel
          • Optional currentUserId?: string
          • enableMessageGrouping: boolean
          • focused: boolean
          • isFirstItem: boolean
          • message: SendbirdMessage
          • Optional nextMessage?: SendbirdMessage
          • Optional onLongPress?: (() => void)
              • (): void

              • Returns void

          • Optional onPress?: (() => void)
              • (): void

              • Returns void

          • Optional onPressParentMessage?: ((parentMessage) => void)
              • (parentMessage): void

              • Parameters

                • parentMessage: SendbirdMessage

                Returns void

          • Optional onShowUserProfile?: ((user, options?) => void)
              • (user, options?): void

              • Parameters

                • user: Member | User
                • Optional options: ShowOptions

                Returns void

          • Optional prevMessage?: SendbirdMessage

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

  • Optional renderNewMessagesButton?: null | ((props) => null | ReactElement<any, string | JSXElementConstructor<any>>)
  • Optional renderScrollToBottomButton?: null | ((props) => null | ReactElement<any, string | JSXElementConstructor<any>>)
  • Optional searchItem?: {
        startingPoint: number;
    }
    • startingPoint: number
  • Optional sortComparator?: ((a, b) => number)
      • (a, b): number

      • Parameters

        • a: SendbirdMessage
        • b: SendbirdMessage

        Returns number

Header

Header: {
    onPressHeaderLeft: (() => void);
    onPressHeaderRight: (() => void);
    shouldHideRight: (() => boolean);
}

Type declaration

  • onPressHeaderLeft: (() => void)
      • (): void

      • Returns void

  • onPressHeaderRight: (() => void)
      • (): void

      • Returns void

  • shouldHideRight: (() => boolean)
      • (): boolean

      • Returns boolean

Input

Input: PickPartial<ChannelInputProps, "onPressUpdateUserMessage" | "shouldRenderInput" | "onPressSendUserMessage" | "onPressSendFileMessage" | "onPressUpdateFileMessage" | "SuggestedMentionList" | "AttachmentsButton", "inputDisabled">

MessageList

MessageList: Pick<ChannelMessageListProps<GroupChannel>, "channel" | "onTopReached" | "onBottomReached" | "onScrolledAwayFromBottom" | "currentUserId" | "enableMessageGrouping" | "searchItem" | "hasNext" | "onDeleteMessage" | "onResendFailedMessage" | "onPressMediaMessage" | "renderNewMessagesButton" | "renderScrollToBottomButton" | "renderMessage" | "messages" | "newMessages" | "scrolledAwayFromBottom" | "flatListProps"> & {
    onResetMessageList: (() => Promise<void>);
    onResetMessageListWithStartingPoint: ((startingPoint) => Promise<void>);
    onUpdateSearchItem: ((searchItem?) => void);
}

Type declaration

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

      • Returns Promise<void>

  • onResetMessageListWithStartingPoint: ((startingPoint) => Promise<void>)
      • (startingPoint): Promise<void>

      • Parameters

        • startingPoint: number

        Returns Promise<void>

  • onUpdateSearchItem: ((searchItem?) => void)
      • (searchItem?): void

      • Parameters

        • Optional searchItem: {
              startingPoint: number;
          }
          • startingPoint: number

        Returns void

Provider

Provider: {
    channel: GroupChannel;
    enableTypingIndicator: boolean;
    groupChannelPubSub: PubSub<GroupChannelPubSubContextPayload>;
    keyboardAvoidOffset?: number;
    messages: SendbirdMessage[];
    onUpdateSearchItem: ((searchItem?) => void);
}

Type declaration

  • channel: GroupChannel
  • enableTypingIndicator: boolean
  • groupChannelPubSub: PubSub<GroupChannelPubSubContextPayload>
  • Optional keyboardAvoidOffset?: number
  • messages: SendbirdMessage[]
  • onUpdateSearchItem: ((searchItem?) => void)
      • (searchItem?): void

      • Parameters

        • Optional searchItem: {
              startingPoint: number;
          }
          • startingPoint: number

        Returns void

SuggestedMentionList

SuggestedMentionList: SuggestedMentionListProps

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc