Hierarchy

  • GroupChannelProps

Properties

Fragment: {
    channel: GroupChannel;
    collectionCreator?: ((options?: Pick<UseGroupChannelMessagesOptions, "startingPoint">) => 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;
        focused: boolean;
        message: SendbirdMessage;
        nextMessage?: SendbirdMessage;
        onLongPress?: (() => void);
        onPress?: (() => void);
        onPressAvatar?: ((user: Member | User, options?: ShowOptions) => 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;
    }>;
    searchItem?: {
        startingPoint: number;
    };
    sortComparator?: ((a: SendbirdMessage, b: SendbirdMessage) => number);
}

Type declaration

  • channel: GroupChannel
  • Optional collectionCreator?: ((options?: Pick<UseGroupChannelMessagesOptions, "startingPoint">) => MessageCollection)
      • (options?: Pick<UseGroupChannelMessagesOptions, "startingPoint">): MessageCollection
      • Parameters

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

        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

        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;
        focused: boolean;
        message: SendbirdMessage;
        nextMessage?: SendbirdMessage;
        onLongPress?: (() => void);
        onPress?: (() => void);
        onPressAvatar?: ((user: Member | User, options?: ShowOptions) => void);
        prevMessage?: SendbirdMessage;
    }) => null | ReactElement<any, string | JSXElementConstructor<any>>)
      • (props: {
            channel: GroupChannel;
            currentUserId?: string;
            enableMessageGrouping: boolean;
            focused: boolean;
            message: SendbirdMessage;
            nextMessage?: SendbirdMessage;
            onLongPress?: (() => void);
            onPress?: (() => void);
            onPressAvatar?: ((user: Member | User, options?: ShowOptions) => void);
            prevMessage?: SendbirdMessage;
        }): null | ReactElement<any, string | JSXElementConstructor<any>>
      • Parameters

        • props: {
              channel: GroupChannel;
              currentUserId?: string;
              enableMessageGrouping: boolean;
              focused: boolean;
              message: SendbirdMessage;
              nextMessage?: SendbirdMessage;
              onLongPress?: (() => void);
              onPress?: (() => void);
              onPressAvatar?: ((user: Member | User, options?: ShowOptions) => void);
              prevMessage?: SendbirdMessage;
          }
          • channel: GroupChannel
          • Optional currentUserId?: string
          • enableMessageGrouping: boolean
          • focused: boolean
          • message: SendbirdMessage
          • Optional nextMessage?: SendbirdMessage
          • Optional onLongPress?: (() => void)
              • (): void
              • Returns void

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

          • Optional onPressAvatar?: ((user: Member | User, options?: ShowOptions) => void)
              • (user: Member | User, options?: ShowOptions): void
              • Parameters

                • user: Member | User
                • Optional options: ShowOptions

                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 searchItem?: {
        startingPoint: number;
    }
    • startingPoint: number
  • Optional sortComparator?: ((a: SendbirdMessage, b: SendbirdMessage) => number)
      • (a: SendbirdMessage, b: SendbirdMessage): number
      • Parameters

        • a: SendbirdMessage
        • b: SendbirdMessage

        Returns number

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: Pick<ChannelInputProps, "onPressUpdateUserMessage" | "onUpdateUserMessage" | "shouldRenderInput" | "onPressSendUserMessage" | "onPressSendFileMessage" | "onPressUpdateFileMessage" | "SuggestedMentionList" | "onSendFileMessage" | "onSendUserMessage" | "onUpdateFileMessage">
MessageList: Pick<ChannelMessageListProps<GroupChannel>, "channel" | "onTopReached" | "onBottomReached" | "onScrolledAwayFromBottom" | "currentUserId" | "enableMessageGrouping" | "searchItem" | "hasNext" | "onDeleteMessage" | "onResendFailedMessage" | "onPressMediaMessage" | "renderNewMessagesButton" | "renderScrollToBottomButton" | "renderMessage" | "messages" | "newMessages" | "scrolledAwayFromBottom" | "flatListProps" | "onPressImageMessage"> & {
    newMessagesFromMembers: SendbirdMessage[];
    nextMessages: SendbirdMessage[];
    onResetMessageList: ((callback?: (() => void)) => void);
}
Provider: {
    channel: GroupChannel;
    enableTypingIndicator: boolean;
    groupChannelPubSub: PubSub<GroupChannelPubSubContextPayload>;
    keyboardAvoidOffset?: number;
}

Type declaration

SuggestedMentionList: SuggestedMentionListProps

Generated using TypeDoc