Documentation - v0.27.1
    Preparing search index...

    Type Alias ChatActionBar

    ChatActionBar:
        | {
            chatTitle: string;
            isBroadcast: boolean;
            requestDate: Date;
            type: "join_request";
        }
        | { type: "invite_members" }
        | { needPhoneNumberPrivacyException: boolean; type: "add_contact" }
        | { type: "share_phone_number" }
        | { canReportSpam?: boolean; canUnarchive: boolean; type: "add_or_report" }
        | { bot: User; manageUrl: string; type: "business_bot" }

    Action bar that should be displayed in the chat with the user, containing the suggested actions to do with the user.

    Type Declaration

    • {
          chatTitle: string;
          isBroadcast: boolean;
          requestDate: Date;
          type: "join_request";
      }
      • chatTitle: string

        Title of the chat

      • isBroadcast: boolean

        Whether the chat is a broadcast channel

      • requestDate: Date

        Date when the join request was sent

      • type: "join_request"

        The user is an administrator of a chat to which we sent a join request

    • { type: "invite_members" }
      • type: "invite_members"

        The chat is a recently created group chat to which new members are suggested to be invited

    • { needPhoneNumberPrivacyException: boolean; type: "add_contact" }
      • needPhoneNumberPrivacyException: boolean

        Whether we will need to explicitly share phone number with the user when adding them to contacts

      • type: "add_contact"

        The chat is with a user, and adding them to contacts is suggested (normally this happens when they added us to their contacts)

    • { type: "share_phone_number" }
      • type: "share_phone_number"

        The chat is with a user, and sharing a phone number with them is suggested (normally this happens when they shared their phone number with us)

    • { canReportSpam?: boolean; canUnarchive: boolean; type: "add_or_report" }
      • OptionalcanReportSpam?: boolean

        Whether we can report this user for spamming

      • canUnarchive: boolean

        Whether this chat was automatically archived and we can unarchive it

      • type: "add_or_report"

        This chat is with a new user who is not in our contacts, and either adding them to contacts or block+report-ing them is suggested

    • { bot: User; manageUrl: string; type: "business_bot" }
      • bot: User

        The business bot that manages this chat

      • manageUrl: string

        Deep link to the bot's management menu

      • type: "business_bot"

        This chat is managed with a business bot