diff --git a/functions/addTags.html b/functions/addTags.html index d4c57a7..44e0540 100644 --- a/functions/addTags.html +++ b/functions/addTags.html @@ -19,19 +19,19 @@

Function addTags

+
  • Defined in index.ts:613
    • diff --git a/functions/boot.html b/functions/boot.html index b80fc9f..950c924 100644 --- a/functions/boot.html +++ b/functions/boot.html @@ -19,34 +19,31 @@

    Function boot

    +
  • Defined in index.ts:291
    • diff --git a/functions/clearCallbacks.html b/functions/clearCallbacks.html index 78afb5d..7061f81 100644 --- a/functions/clearCallbacks.html +++ b/functions/clearCallbacks.html @@ -19,24 +19,14 @@

    Function clearCallbacks

    +
  • Defined in index.ts:533
    • diff --git a/functions/hideChannelButton.html b/functions/hideChannelButton.html index 891076a..b1ef977 100644 --- a/functions/hideChannelButton.html +++ b/functions/hideChannelButton.html @@ -19,14 +19,17 @@

    Function hideChannelButton

    +
  • Defined in index.ts:705
    • diff --git a/functions/hideMessenger.html b/functions/hideMessenger.html index 0eb4d59..c6ad20b 100644 --- a/functions/hideMessenger.html +++ b/functions/hideMessenger.html @@ -19,17 +19,17 @@

    Function hideMessenger

    +
  • Defined in index.ts:342
    • diff --git a/functions/loadScript.html b/functions/loadScript.html index 5d90520..3af3ad4 100644 --- a/functions/loadScript.html +++ b/functions/loadScript.html @@ -19,16 +19,16 @@

    Function loadScript

    diff --git a/functions/onBadgeChanged.html b/functions/onBadgeChanged.html index f6be89b..1bc822a 100644 --- a/functions/onBadgeChanged.html +++ b/functions/onBadgeChanged.html @@ -30,13 +30,12 @@
    callback: Returns void

    See
    +
  • Defined in index.ts:450
    • diff --git a/functions/onChatCreated.html b/functions/onChatCreated.html index 22458d9..53102de 100644 --- a/functions/onChatCreated.html +++ b/functions/onChatCreated.html @@ -19,13 +19,15 @@

    Function onChatCreated

    • -

      Register a callback invoked when a chat is created.

      +

      Registers a callback function that is invoked when a chat is created.

      Parameters

      • callback: (() => void)
        +

        The callback function to be executed.

        +
        • @@ -36,7 +38,7 @@

          Returns voidReturns void

      +
    • Defined in index.ts:466
    diff --git a/functions/onFollowUpChanged.html b/functions/onFollowUpChanged.html index bb91d32..f792161 100644 --- a/functions/onFollowUpChanged.html +++ b/functions/onFollowUpChanged.html @@ -19,14 +19,14 @@

    Function onFollowUpChanged

    • -

      Register a callback invoked when the user changes the user’s profile.

      +

      Registers a callback function that is invoked when the user updates their profile.

      Parameters

      • callback: FollowUpChangedCallback
        -

        The callback invoked when the user changes the user’s profile. It receives the profile object as the argument.

        +

        The callback function, receiving the FollowUpProfile object as an argument.

      Returns void

      @@ -34,7 +34,7 @@

      Returns voidSee

      https://developers.channel.io/docs/web-channelio#onfollowupchanged

    +
  • Defined in index.ts:495
    • diff --git a/functions/onHideMessenger.html b/functions/onHideMessenger.html index c69cd72..784c02f 100644 --- a/functions/onHideMessenger.html +++ b/functions/onHideMessenger.html @@ -19,13 +19,15 @@

    Function onHideMessenger

    • -

      Register a callback invoked when the messenger is hidden.

      +

      Registers a callback function that is invoked when the messenger is hidden.

      Parameters

      • callback: (() => void)
        +

        The callback function to be executed.

        +
        • @@ -36,7 +38,7 @@

          Returns voidReturns void

      +
    • Defined in index.ts:424
    diff --git a/functions/onShowMessenger.html b/functions/onShowMessenger.html index 62ebb92..cf104ed 100644 --- a/functions/onShowMessenger.html +++ b/functions/onShowMessenger.html @@ -19,13 +19,15 @@

    Function onShowMessenger

    • -

      Register a callback invoked when the messenger is shown.

      +

      Registers a callback function that is invoked when the messenger is displayed.

      Parameters

      • callback: (() => void)
        +

        The callback function to be executed.

        +
        • @@ -36,7 +38,7 @@

          Returns voidReturns void

      +
    • Defined in index.ts:408
    diff --git a/functions/onUrlClicked.html b/functions/onUrlClicked.html index 909c301..f8b2a29 100644 --- a/functions/onUrlClicked.html +++ b/functions/onUrlClicked.html @@ -19,11 +19,11 @@

    Function onUrlClicked

    • -
        -
      • Register a callback invoked when the user clicks a link.
        • -
      • The links that the user can click include the following list.
          -
        • Link button/text in marketing pop-up
          • -
        • Link button/text sent by manager in chat
          • +

          Registers a callback function that is invoked when the user clicks on a link.

          +
            +
          • Supported link types include:
              +
            • Link buttons or text in marketing pop-ups
              • +
            • Link buttons or text sent by a manager in chat
          @@ -33,7 +33,7 @@

          Parameters

          • callback: UrlClickedCallback
            -

            The callback invoked when the user clicks a link. It receives the URL of the link as the argument.

            +

            The callback function, receiving the clicked URL as an argument.

          Returns void

          @@ -41,7 +41,7 @@

          Returns voidSee

          https://developers.channel.io/docs/web-channelio#onurlclicked

    +
  • Defined in index.ts:517
    • diff --git a/functions/openChat.html b/functions/openChat.html index 61d45aa..fcb05ad 100644 --- a/functions/openChat.html +++ b/functions/openChat.html @@ -19,11 +19,12 @@

    Function openChat

    • -
        -
      • Open a chat.
        • -
      • A new chat is opened if you pass an empty value to chatId. In this case, if you pass a message, the message is entered in the input. If the support bot is active, the support bot runs.
        • -
      • The chat is opened if the chat with the given chatId exists. In this case, a message is ignored. The lounge is opened if the chat doesn't exist.
        • -
      • If you use openChat outside of the click event handler, it may not work properly in the Safari browser on the mobile device.
        • +

        Opens a chat within the messenger.

        +
          +
        • For an empty chatId, a new chat is opened. Any provided message appears in the chat input. If the support bot is active, it will initiate.
          • +
        • If a chat with the provided chatId exists, that chat will open, and any message will be ignored.
          • +
        • If a chat doesn't exist, the home is opened.
          • +
        • Note: Using this function outside a click event handler may lead to issues on iOS Safari.
        @@ -31,10 +32,12 @@

        Parameters

        • Optional chatId: string | number
          +

          The ID of the chat to open.

          +
        • Optional message: string
          -

          Message to enter in the input

          +

          Message to appear in the chat input.

        Returns void

        @@ -42,7 +45,7 @@

        Returns voidSee

        https://developers.channel.io/docs/web-channelio#openchat

    +
  • Defined in index.ts:366
    • diff --git a/functions/removeTags.html b/functions/removeTags.html index 070eacd..e73532d 100644 --- a/functions/removeTags.html +++ b/functions/removeTags.html @@ -19,19 +19,19 @@

    Function removeTags

    • -

      Remove a user’s tags.

      +

      Removes tags from a user.

      Parameters

      • tags: string[]
        -

        If the corresponding tag don’t exist, that tag is ignored. null or an empty array([]) not allowed.

        +

        Ignores non-existent tags. Empty array or null not allowed.

      • Optional callback: Callback
        -

        If fails, the callback passes an error object at the first argument, null at the second argument. If succeeds, the callback passes null at the first argument, a user object at the second argument.

        +

        Called on success or failure.

      Returns void

      @@ -39,7 +39,7 @@

      Returns voidSee

      https://developers.channel.io/docs/web-channelio#removetags

    +
  • Defined in index.ts:631
    • diff --git a/functions/resetPage.html b/functions/resetPage.html index 1a81807..a4c5d28 100644 --- a/functions/resetPage.html +++ b/functions/resetPage.html @@ -20,16 +20,20 @@

    Function resetPage

    • -
    • Reset the page value set by setPage.
      • -
    • If you use resetPage, the canonical URL is used as the page value.
      • +
    • Reset the page value.
      • +
    • If you use resetPage, a canonical URL is used as the page value.

    Returns void

    -

    See

    https://developers.channel.io/docs/web-channelio#resetpage

    +

    See

    • +
  • Defined in index.ts:670
    • diff --git a/functions/setAppearance.html b/functions/setAppearance.html index 8508b94..67bb39a 100644 --- a/functions/setAppearance.html +++ b/functions/setAppearance.html @@ -19,7 +19,7 @@

    Function setAppearance

    +
  • Defined in index.ts:721
    • diff --git a/functions/setPage.html b/functions/setPage.html index 0f757f4..c986d8f 100644 --- a/functions/setPage.html +++ b/functions/setPage.html @@ -19,8 +19,8 @@

    Function setPage

    +
  • Defined in index.ts:651
    • diff --git a/functions/showChannelButton.html b/functions/showChannelButton.html index 32f61f5..ae91f6d 100644 --- a/functions/showChannelButton.html +++ b/functions/showChannelButton.html @@ -19,18 +19,20 @@

    Function showChannelButton

    diff --git a/functions/showMessenger.html b/functions/showMessenger.html index 1d616f9..5fca61d 100644 --- a/functions/showMessenger.html +++ b/functions/showMessenger.html @@ -19,17 +19,17 @@

    Function showMessenger

    +
  • Defined in index.ts:324
    • diff --git a/functions/shutdown.html b/functions/shutdown.html index 85323a6..8d9ebd9 100644 --- a/functions/shutdown.html +++ b/functions/shutdown.html @@ -19,12 +19,12 @@

    Function shutdown

    • -

      Stop all operations of the SDK and initialize internal data.

      +

      Terminates all SDK operations and reinitializes internal data.

      Returns void

    +
  • Defined in index.ts:306
    • diff --git a/functions/track.html b/functions/track.html index 269857c..eb1e5e7 100644 --- a/functions/track.html +++ b/functions/track.html @@ -19,10 +19,10 @@

    Function track

    diff --git a/functions/updateUser.html b/functions/updateUser.html index c398213..0b29db5 100644 --- a/functions/updateUser.html +++ b/functions/updateUser.html @@ -19,19 +19,19 @@

    Function updateUser

    • -

      Update user’s information.

      +

      Updates user information.

      Parameters

      • userInfo: UpdateUserInfo
        -

        Object with user’s information.

        +

        Object containing user information to be updated.

      • Optional callback: Callback
        -

        When it fails, the callback passes an error object at the first argument, null at the second argument. When it succeeds, the callback passes null at the first argument, an user object at the second argument.

        +

        Optional callback function to be executed upon completion.

      Returns void

      @@ -39,7 +39,7 @@

      Returns voidSee

      https://developers.channel.io/docs/web-channelio#updateuser

    +
  • Defined in index.ts:595
    • diff --git a/index.html b/index.html index aebf5f9..696b1b5 100644 --- a/index.html +++ b/index.html @@ -16,29 +16,29 @@

    @channel.io/channel-web-sdk-loader

    NPM npm

    -

    Official Channel Web SDK Loader

    +

    The Official Channel SDK Loader for Web

    -

    Links

    @@ -65,15 +65,15 @@

    channel-web-sdk-loader

    • +
  • Step1: Import the ChannelService Module
    • +
  • Step2: Load the Channel Web SDK
    • +
  • Step3: Initialize the Channel Web SDK
    • +
  • API Documentation
    • +

    Boot options for initializing the SDK.

    +

    See

    https://developers.channel.io/docs/web-boot-option

    @@ -24,7 +26,7 @@

    Hierarchy

    • BootOption
    +
  • Defined in index.ts:172
    • @@ -53,175 +55,204 @@

    Properties

    Optional appearance

    appearance?: Appearance
    -
      -
    • Set the initial appearance of the theme.
      • -
    • The default value is null.
      • +

      Configure the initial appearance of your theme.

      +
        +
      • The default value is null.
    +
  • Defined in index.ts:177

    • Optional customLauncherSelector

    customLauncherSelector?: string
    -
    +
  • Defined in index.ts:185

    • Optional hideChannelButtonOnBoot

    hideChannelButtonOnBoot?: boolean
    -
    +
  • Defined in index.ts:193

    • Optional hidePopup

    hidePopup?: boolean
    -
      -
    • Set whether to hide the marketing pop-ups and the message alarm pop-ups.
      • -
    • The default value is false.
      • +

      Determines whether to hide marketing pop-ups and message alert pop-ups.

      +
        +
      • The default value is false.
    +
  • Defined in index.ts:199

    • Optional language

    -
    language?: "en" | "ko" | "ja"
    -
      -
    • Set the default value of the language.
      • -
    • Texts differ based on the language.
      • -
    • When a user is created newly, the user’s language is set as the language.
      • -
    • language doesn’t change the user’s language already created.
      • +
      language?: string
      +

      Specifies the default language setting.

      +
        +
      • Applies to new users; does not modify existing users' language settings.
        • +
      • Supports message translation in 32 languages and UI language in ko, ja, and en.
        • +
      • UI text adapts to ko or ja; defaults to en otherwise.
      -

      See

      https://developers.channel.io/docs/web-boot-option#language

      +

      See

    +
  • Defined in index.ts:209

    • Optional memberHash

    memberHash?: string
    -

    Set the hashed value of the memberId using HMAC-SHA256.

    +

    Pass the HMAC-SHA256 hash of the user memberid using the issued secret key.

    +
      +
    • No need to pass memberHash unless using user data encryption.
      • +
    -
    +
  • Defined in index.ts:218

    • Optional memberId

    memberId?: string
    -

    The id of member user.

    +

    Specifies the member user's ID.

    See

    https://developers.channel.io/docs/web-boot-option#memberid

    +
  • Defined in index.ts:224

    • pluginKey

    pluginKey: string
    -

    The plugin key of your channel.

    +

    Specifies the plugin key for your channel.

    -

    See

    https://developers.channel.io/docs/web-boot-option#pluginkey

    +

    See

    +
  • Defined in index.ts:231

    • Optional profile

    profile?: Profile
    -

    Set the user’s profile.

    +

    Specifies the user’s profile.

    -

    See

    https://developers.channel.io/docs/web-boot-option#profile

    +

    See

    +
  • Defined in index.ts:238

    • Optional trackDefaultEvent

    trackDefaultEvent?: boolean
    -
    +
  • Defined in index.ts:246

    • Optional trackUtmSource

    trackUtmSource?: boolean
    -
    +
  • Defined in index.ts:253

    • Optional unsubscribe

    unsubscribe?: boolean
    -
      -
    • Set whether to unsubscribe marketing email and SMS for the user.
      • -
    • The default value is false.
      • +

      Determines whether to opt out of receiving marketing emails and text messages.

      +
        +
      • The default value is false.
    +
  • Defined in index.ts:259

    • Optional unsubscribeEmail

    unsubscribeEmail?: boolean
    -
      -
    • Set whether to unsubscribe marketing email for the user.
      • -
    • The default value is false.
      • +

      Determines whether to opt out of receiving marketing emails.

      +
        +
      • The default value is false.
    +
  • Defined in index.ts:265

    • Optional unsubscribeTexting

    unsubscribeTexting?: boolean
    -
      -
    • Set whether to unsubscribe marketing SMS for the user.
      • -
    • The default value is false.
      • +

      Determines whether to opt out of receiving marketing text messages.

      +
        +
      • The default value is false.
    +
  • Defined in index.ts:271

    • Optional zIndex

    zIndex?: number
    -
      -
    • Set the z-index of the elements made by the SDK.
      • -
    • Applied at chat button, messenger, and marketing pop-up.
      • -
    • The default value is 10000000.
      • +

      Sets the z-index for elements generated by the SDK.

      +
        +
      • Applies to the channel button, messenger, and marketing pop-ups.
        • +
      • The default value is 10,000,000.

      See

      https://developers.channel.io/docs/web-boot-option#zindex

    +
  • Defined in index.ts:279
    • diff --git a/interfaces/EventProperty.html b/interfaces/EventProperty.html index fcec6de..6309e34 100644 --- a/interfaces/EventProperty.html +++ b/interfaces/EventProperty.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: string | number | boolean | null
    +
  • Defined in index.ts:378
    • diff --git a/interfaces/FollowUpProfile.html b/interfaces/FollowUpProfile.html index e5924a9..6e83baa 100644 --- a/interfaces/FollowUpProfile.html +++ b/interfaces/FollowUpProfile.html @@ -15,12 +15,16 @@
  • @channel.io/channel-web-sdk-loader
  • FollowUpProfile

    • Interface FollowUpProfile

    +
    +

    Represents the user profile information passed in the onFollowUpChanged callback argument.

    +
    +

    Hierarchy

    • FollowUpProfile
    +
  • Defined in index.ts:481
    • @@ -37,27 +41,27 @@

    Properties

    Optional email

    email?: null | string
    -

    The email of a user.

    +

    User's email address.

    +
  • Defined in index.ts:487

    • Optional mobileNumber

    mobileNumber?: null | string
    -

    The mobile number of a user. It follows E.164 format.

    +

    User's mobile number, following the E.164 format.

    +
  • Defined in index.ts:485

    • Optional name

    name?: null | string
    -

    The name of a user.

    +

    User's name.

    +
  • Defined in index.ts:483
    • diff --git a/interfaces/Profile.html b/interfaces/Profile.html index 737484b..d63e241 100644 --- a/interfaces/Profile.html +++ b/interfaces/Profile.html @@ -16,9 +16,9 @@
  • Profile

    • Interface Profile

    -
      -
    • A User’s profile information.
      • -
    • Set by updateUser or profile of boot option.
      • +

      Represents user profile information.

      +
        +
      • Populated by updateUser or the profile field in boot options.
      @@ -32,7 +32,7 @@

      Hierarchy

      Indexable

      [key: string]: string | number | boolean | null
    +
  • Defined in index.ts:105
    • diff --git a/interfaces/UpdateUserInfo.html b/interfaces/UpdateUserInfo.html index 7f6b8b3..a81c020 100644 --- a/interfaces/UpdateUserInfo.html +++ b/interfaces/UpdateUserInfo.html @@ -16,6 +16,8 @@
  • UpdateUserInfo

    • Interface UpdateUserInfo

    +

    Information required to update a user.

    +

    See

    https://developers.channel.io/docs/web-channelio#updateuser

    @@ -24,7 +26,7 @@

    Hierarchy

    • UpdateUserInfo
    +
  • Defined in index.ts:549
    • @@ -44,70 +46,76 @@

    Properties

    Optional language

    language?: string
    -
      -
    • If language is ‘ko’ or ‘ja’, UI text inside ChannelTalk changes with that language.
      • -
    • Otherwise, UI text is set with English.
      • +

      Specifies the user's language.

      +
        +
      • Supports message translation in 32 languages and UI language in ko, ja, and en.
        • +
      • UI text adapts to ko or ja; defaults to en otherwise.
    +
  • Defined in index.ts:555

    • Optional profile

    profile?: null | Profile
    -
      -
    • If you pass null, the whole profile is initialized.
      • -
    • If you pass null to the specific field inside profile object, that specific field is initialized.
      • -
    • An empty object is not allowed.
      • -
    • The name of the field must follow Camel Case.
      • -
    • If you pass mobileNumber, it must follow e.164 format.
      • +

      Specifies the user's profile.

      +
        +
      • Passing null will initialize the whole profile.
        • +
      • For specific fields inside the profile object, passing null will initialize that field.
        • +
      • Field names must be in camelCase.
        • +
      • The mobileNumber field must follow the E.164 format.
        • +
      • Empty objects are not allowed.
    +
  • Defined in index.ts:564

    • Optional profileOnce

    profileOnce?: Profile
    -

    Among the fields inside profileOnce object, only the fields with no existing value are added.

    +

    Specifies the user's profile.

    +
      +
    • Only fields with no existing values in the profile will be added from the profileOnce object.
      • +
    +
  • Defined in index.ts:569

    • Optional tags

    tags?: null | string[]
    -
      -
    • Max 10 tags are allowed.
      • -
    • If you pass null, tags are initialized.
      • -
    • An empty array([]) is not allowed.
      • +

      Specifies the User's tags.

      +
        +
      • Up to 10 tags are allowed.
        • +
      • Passing null will initialize the tags.
        • +
      • Empty arrays are not allowed.
    +
  • Defined in index.ts:576

    • Optional unsubscribeEmail

    unsubscribeEmail?: boolean
    -
      -
    • Set whether the user subscribes to the marketing email.
      • -
    • Terminates subscription if the value is true.
      • +

      Determines whether to opt out of receiving marketing emails.

      +
        +
      • Setting this to true will terminate the subscription.
    +
  • Defined in index.ts:581

    • Optional unsubscribeTexting

    unsubscribeTexting?: boolean
    -
      -
    • Set whether the user subscribes to the marketing SMS.
      • -
    • Terminates subscription if the value is true.
      • +

      Determines whether to opt out of receiving marketing text messages.

      +
        +
      • Setting this to true will terminate the subscription.
    +
  • Defined in index.ts:586
    • diff --git a/interfaces/User.html b/interfaces/User.html index 4c169be..7f71779 100644 --- a/interfaces/User.html +++ b/interfaces/User.html @@ -16,6 +16,8 @@
  • User

    • Interface User

    +

    Represents user information.

    +

    See

    https://developers.channel.io/docs/web-user-object

    @@ -24,7 +26,7 @@

    Hierarchy

    • User
    +
  • Defined in index.ts:18
    • @@ -49,40 +51,40 @@

    Properties

    alert

    alert: number
    -
      -
    • The number of important notifications that the user has not read.
      • -
    • It is displayed as a number on the channel button.
      • +

      The number of important notifications that are unread.

      +
        +
      • A numerical indicator is displayed on the channel button to signify this count.

      See

      https://developers.channel.io/docs/web-user-object#alert

    +
  • Defined in index.ts:24

    • avatarUrl

    avatarUrl: string
    -

    The avatar image URL of a user.

    +

    URL representing the user's avatar image.

    +
  • Defined in index.ts:27

    • id

    id: string
    -

    The id of a user

    +

    Unique identifier for the user.

    +
  • Defined in index.ts:30

    • language

    language: string
    -
      -
    • The language of a user.
      • -
    • Used for translation.
      • -
    • Set by updateUser and language of boot option.
      • -
    • Following 32 languages supported.
        +

        The language setting for the user.

        +
          +
        • Utilized for translation purposes.
          • +
        • Configurable via the updateUser method or the language boot option.
          • +
        • Supports the following 32 languages:
          • 'de'(German), 'hi'(Hindi), 'no'(Norwegian), 'ru'(Russian), 'fi'(Finnish), 'pt'(Portuguese), 'hr'(Croatian), 'fr'(French), 'hu'(Hungarian), 'uk'(Ukrainian), 'sk'(Slovak), 'ca'(Catalan), 'sv'(Swedish), 'ko'(Korean), 'id'(Indonesian), 'ms'(Malay), 'el'(Greek), 'en'(English), 'it'(Italian), 'es'(Spanish), 'he'(Hebrew), 'zh'(Chinese), 'cs'(Czech), 'ar'(Arabic), 'vi'(Vietnamese),'th'(Thai), 'ja'(Japanese), 'pl'(Polish), 'ro'(Romanian), 'da'(Danish), 'nl'(Dutch), 'tr'(Turkish)
          • @@ -92,99 +94,99 @@

          languageSee

          https://developers.channel.io/docs/web-user-object#language

    +
  • Defined in index.ts:40

    • memberId

    memberId: string
    -
    +
  • Defined in index.ts:47

    • Optional name

    name?: string
    -
    +
  • Defined in index.ts:54

    • Optional profile

    profile?: null | Profile
    -
    +
  • Defined in index.ts:61

    • Optional tags

    tags?: null | string[]
    -
    +
  • Defined in index.ts:69

    • unread

    unread: number
    -
      -
    • The number of all unread notifications the user has not read.
      • -
    • It includes the number of alert. It is displayed as a red dot on the channel button.
      • +

      The total count of unread notifications for the user.

      +
        +
      • If you have 'unread' notifications but no 'alert', a red dot is displayed on the channel button to signify unread messages.

      See

      https://developers.channel.io/docs/web-user-object#unread

    +
  • Defined in index.ts:76

    • unsubscribeEmail

    unsubscribeEmail: boolean
    -
    +
  • Defined in index.ts:83

    • unsubscribeTexting

    unsubscribeTexting: boolean
    -
    +
  • Defined in index.ts:90
    • diff --git a/types/Appearance.html b/types/Appearance.html index 93d6318..98958f4 100644 --- a/types/Appearance.html +++ b/types/Appearance.html @@ -16,18 +16,19 @@
  • Appearance

    • Type alias Appearance

    Appearance: "light" | "dark" | "system" | null
    -
      -
    • light: Use the light theme.
      • -
    • dark: Use the dark theme.
      • -
    • system: Follow the System theme.
      • -
    • null: Follow the desk's theme setting.
      • +

      Defines appearance options for the theme.

      +
        +
      • light: Light theme.
        • +
      • dark: Dark theme.
        • +
      • system: System-defined theme.
        • +
      • null: Inherits Desk theme setting.

      See

      https://developers.channel.io/docs/web-boot-option#appearance

    +
  • Defined in index.ts:117
    • diff --git a/types/BadgeChangedCallback.html b/types/BadgeChangedCallback.html index 10febca..1810b46 100644 --- a/types/BadgeChangedCallback.html +++ b/types/BadgeChangedCallback.html @@ -23,28 +23,30 @@

    Type declaration

    • (unread, alert): void
    • +

      Callback function type for handling badge changes.

      +

      Parameters

      • unread: number
        -

        unread is the number of all unread notifications the user has not read. It includes the number of alert. It is displayed as a red dot on the channel button.

        +

        The total number of unread notifications. If you have unread notifications but no alert, a red dot is displayed on the channel button to signify unread messages.

      • alert: number
        -

        alert is the number of important notifications that the user has not read. It is displayed as a number on the channel button.

        +

        The number of important unread notifications. This count is displayed as a number on the channel button.

      Returns void

      See

    +
  • Defined in index.ts:443
    • diff --git a/types/Callback.html b/types/Callback.html index dc58a85..95b78ec 100644 --- a/types/Callback.html +++ b/types/Callback.html @@ -23,9 +23,10 @@

    Type declaration

    • (error, user): void
    • -
        -
      • When it fails, the callback passes an error object at the first argument, null at the second argunent.
        • -
      • When it succeeds, the callback passes null at the first argument, an user object at the second argument.
        • +

        Callback for error or success responses.

        +
          +
        • On failure: passes an Error object as the first argument and null as the second.
          • +
        • On success: passes null as the first argument and a User object as the second.
        @@ -38,7 +39,7 @@
        user: Returns void
    +
  • Defined in index.ts:98
    • diff --git a/types/FollowUpChangedCallback.html b/types/FollowUpChangedCallback.html index a526439..d5b82c0 100644 --- a/types/FollowUpChangedCallback.html +++ b/types/FollowUpChangedCallback.html @@ -15,22 +15,22 @@
  • @channel.io/channel-web-sdk-loader
  • FollowUpChangedCallback

    • Type alias FollowUpChangedCallback

    -
    FollowUpChangedCallback: ((profile) => void)
    +
    FollowUpChangedCallback: ((followUpProfile) => void)

    Type declaration

    Returns void

    +
  • Defined in index.ts:489
    • diff --git a/types/UrlClickedCallback.html b/types/UrlClickedCallback.html index 51acd0d..7f03424 100644 --- a/types/UrlClickedCallback.html +++ b/types/UrlClickedCallback.html @@ -30,7 +30,7 @@

    Parameters

    url: string

    Returns void

    +
  • Defined in index.ts:508