Hierarchy

  • GroupChannelProps

Properties

Fragment: { channel: GroupChannel; collectionCreator?: (() => MessageCollection); enableMessageGrouping?: boolean; enableTypingIndicator?: boolean; flatListProps?: Omit<FlatListProps<SendbirdMessage>, "data" | "renderItem">; keyboardAvoidOffset?: number; onBeforeSendFileMessage?: OnBeforeHandler<FileMessageCreateParams>; onBeforeSendUserMessage?: OnBeforeHandler<UserMessageCreateParams>; onBeforeUpdateFileMessage?: OnBeforeHandler<BaseMessageUpdateParams>; onBeforeUpdateUserMessage?: OnBeforeHandler<UserMessageUpdateParams>; onChannelDeleted: (() => void); onPressHeaderLeft: (() => void); onPressHeaderRight: (() => void); onPressImageMessage?: ((message: FileMessage, uri: string) => void); onPressMediaMessage?: ((message: FileMessage, deleteMessage: (() => Promise<void>), uri: string) => void); queryCreator?: (() => PreviousMessageListQuery); renderMessage?: ((props: { channel: GroupChannel; currentUserId?: string; enableMessageGrouping: boolean; message: SendbirdMessage; nextMessage?: SendbirdMessage; onLongPress?: (() => void); onPress?: (() => void); prevMessage?: SendbirdMessage }) => null | ReactElement<any, string | JSXElementConstructor<any>>); renderNewMessagesButton?: null | CommonComponent<{ newMessages: SendbirdMessage[]; onPress: (() => void); visible: boolean }>; renderScrollToBottomButton?: null | CommonComponent<{ onPress: (() => void); visible: boolean }>; sortComparator?: ((a: SendbirdMessage, b: SendbirdMessage) => number) }

Type declaration

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

  • Optional enableMessageGrouping?: boolean
  • Optional enableTypingIndicator?: boolean
  • Optional flatListProps?: Omit<FlatListProps<SendbirdMessage>, "data" | "renderItem">
  • Optional keyboardAvoidOffset?: number
  • Optional onBeforeSendFileMessage?: OnBeforeHandler<FileMessageCreateParams>
  • Optional onBeforeSendUserMessage?: OnBeforeHandler<UserMessageCreateParams>
  • Optional onBeforeUpdateFileMessage?: OnBeforeHandler<BaseMessageUpdateParams>
  • Optional onBeforeUpdateUserMessage?: OnBeforeHandler<UserMessageUpdateParams>
  • onChannelDeleted: (() => void)
      • (): void
      • Returns void

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

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

  • Optional onPressImageMessage?: ((message: FileMessage, uri: string) => void)
      • (message: FileMessage, uri: string): void
      • Deprecated

        onPressImageMessage is deprecated, please use onPressMediaMessage instead *

        Parameters

        • message: FileMessage
        • uri: string

        Returns void

  • Optional onPressMediaMessage?: ((message: FileMessage, deleteMessage: (() => Promise<void>), uri: string) => void)
      • (message: FileMessage, deleteMessage: (() => Promise<void>), uri: string): void
      • Parameters

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

        • uri: string

        Returns void

  • Optional queryCreator?: (() => PreviousMessageListQuery)
      • (): PreviousMessageListQuery
      • Returns PreviousMessageListQuery

  • Optional renderMessage?: ((props: { channel: GroupChannel; currentUserId?: string; enableMessageGrouping: boolean; message: SendbirdMessage; nextMessage?: SendbirdMessage; onLongPress?: (() => void); onPress?: (() => void); prevMessage?: SendbirdMessage }) => null | ReactElement<any, string | JSXElementConstructor<any>>)
      • (props: { channel: GroupChannel; currentUserId?: string; enableMessageGrouping: boolean; message: SendbirdMessage; nextMessage?: SendbirdMessage; onLongPress?: (() => void); onPress?: (() => void); prevMessage?: SendbirdMessage }): null | ReactElement<any, string | JSXElementConstructor<any>>
      • Parameters

        • props: { channel: GroupChannel; currentUserId?: string; enableMessageGrouping: boolean; message: SendbirdMessage; nextMessage?: SendbirdMessage; onLongPress?: (() => void); onPress?: (() => void); prevMessage?: SendbirdMessage }
          • channel: GroupChannel
          • Optional currentUserId?: string
          • enableMessageGrouping: boolean
          • message: SendbirdMessage
          • Optional nextMessage?: SendbirdMessage
          • Optional onLongPress?: (() => void)
              • (): void
              • Returns void

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

          • Optional prevMessage?: SendbirdMessage

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

  • Optional renderNewMessagesButton?: null | CommonComponent<{ newMessages: SendbirdMessage[]; onPress: (() => void); visible: boolean }>
  • Optional renderScrollToBottomButton?: null | CommonComponent<{ onPress: (() => void); visible: boolean }>
  • Optional sortComparator?: ((a: SendbirdMessage, b: SendbirdMessage) => number)
      • (a: SendbirdMessage, b: SendbirdMessage): number
      • Parameters

        • a: SendbirdMessage
        • b: SendbirdMessage

        Returns number

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

Type declaration

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

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

Input: Pick<ChannelInputProps, "onPressUpdateUserMessage" | "onUpdateUserMessage" | "shouldRenderInput" | "onPressSendUserMessage" | "onPressSendFileMessage" | "onPressUpdateFileMessage" | "SuggestedMentionList" | "onSendFileMessage" | "onSendUserMessage" | "onUpdateFileMessage">
MessageList: { channel: GroupChannel; currentUserId?: string; enableMessageGrouping: boolean; flatListProps?: Omit<FlatListProps<SendbirdMessage>, "data" | "renderItem">; messages: SendbirdMessage[]; newMessagesFromMembers: SendbirdMessage[]; nextMessages: SendbirdMessage[]; onBottomReached: (() => void); onDeleteMessage: ((message: FileMessage | UserMessage) => Promise<void>); onPressImageMessage?: ((message: FileMessage, uri: string) => void); onPressMediaMessage?: ((message: FileMessage, deleteMessage: (() => Promise<void>), uri: string) => void); onResendFailedMessage: ((failedMessage: FileMessage | UserMessage) => Promise<void>); onTopReached: (() => void); renderMessage: ((props: { channel: GroupChannel; currentUserId?: string; enableMessageGrouping: boolean; message: SendbirdMessage; nextMessage?: SendbirdMessage; onLongPress?: (() => void); onPress?: (() => void); prevMessage?: SendbirdMessage }) => null | ReactElement<any, string | JSXElementConstructor<any>>); renderNewMessagesButton: null | CommonComponent<{ newMessages: SendbirdMessage[]; onPress: (() => void); visible: boolean }>; renderScrollToBottomButton: null | CommonComponent<{ onPress: (() => void); visible: boolean }> }

Type declaration

  • channel: GroupChannel
  • Optional currentUserId?: string
  • enableMessageGrouping: boolean
  • Optional flatListProps?: Omit<FlatListProps<SendbirdMessage>, "data" | "renderItem">
  • messages: SendbirdMessage[]
  • newMessagesFromMembers: SendbirdMessage[]
  • nextMessages: SendbirdMessage[]
  • onBottomReached: (() => void)
      • (): void
      • Returns void

  • onDeleteMessage: ((message: FileMessage | UserMessage) => Promise<void>)
      • (message: FileMessage | UserMessage): Promise<void>
      • Parameters

        • message: FileMessage | UserMessage

        Returns Promise<void>

  • Optional onPressImageMessage?: ((message: FileMessage, uri: string) => void)
      • (message: FileMessage, uri: string): void
      • Deprecated

        onPressImageMessage is deprecated, please use onPressMediaMessage instead *

        Parameters

        • message: FileMessage
        • uri: string

        Returns void

  • Optional onPressMediaMessage?: ((message: FileMessage, deleteMessage: (() => Promise<void>), uri: string) => void)
      • (message: FileMessage, deleteMessage: (() => Promise<void>), uri: string): void
      • Parameters

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

        • uri: string

        Returns void

  • onResendFailedMessage: ((failedMessage: FileMessage | UserMessage) => Promise<void>)
      • (failedMessage: FileMessage | UserMessage): Promise<void>
      • Parameters

        • failedMessage: FileMessage | UserMessage

        Returns Promise<void>

  • onTopReached: (() => void)
      • (): void
      • Returns void

  • renderMessage: ((props: { channel: GroupChannel; currentUserId?: string; enableMessageGrouping: boolean; message: SendbirdMessage; nextMessage?: SendbirdMessage; onLongPress?: (() => void); onPress?: (() => void); prevMessage?: SendbirdMessage }) => null | ReactElement<any, string | JSXElementConstructor<any>>)
      • (props: { channel: GroupChannel; currentUserId?: string; enableMessageGrouping: boolean; message: SendbirdMessage; nextMessage?: SendbirdMessage; onLongPress?: (() => void); onPress?: (() => void); prevMessage?: SendbirdMessage }): null | ReactElement<any, string | JSXElementConstructor<any>>
      • Parameters

        • props: { channel: GroupChannel; currentUserId?: string; enableMessageGrouping: boolean; message: SendbirdMessage; nextMessage?: SendbirdMessage; onLongPress?: (() => void); onPress?: (() => void); prevMessage?: SendbirdMessage }
          • channel: GroupChannel
          • Optional currentUserId?: string
          • enableMessageGrouping: boolean
          • message: SendbirdMessage
          • Optional nextMessage?: SendbirdMessage
          • Optional onLongPress?: (() => void)
              • (): void
              • Returns void

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

          • Optional prevMessage?: SendbirdMessage

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

  • renderNewMessagesButton: null | CommonComponent<{ newMessages: SendbirdMessage[]; onPress: (() => void); visible: boolean }>
  • renderScrollToBottomButton: null | CommonComponent<{ onPress: (() => void); visible: boolean }>
Provider: { channel: GroupChannel; enableTypingIndicator: boolean; keyboardAvoidOffset?: number }

Type declaration

  • channel: GroupChannel
  • enableTypingIndicator: boolean
  • Optional keyboardAvoidOffset?: number
SuggestedMentionList: SuggestedMentionListProps

Generated using TypeDoc