BootConfig

Configures options for ChannelIO.boot().

Field	Type	Description
pluginKey	`@NonNull` String	A plugin key.
memberId	`@Nullable` String	An identifier to distinguish each user. See how to boot as a member user.
memberHash	`@Nullable` String	A HMAC-SHA256 value of memberId. See enabling member hash. You should also pass `memberId` whenever `memberHash` is non-null.
profile	`@Nullable` Profile	A user’s profile.
language	`@Nullable` Language	A user’s language. If null, the language is set to the language of the device.
unsubscribeEmail	`@Nullable` Boolean	Whether to unsubscribe from the email marketing message.
unsubscribeTexting	`@Nullable` Boolean	Whether to unsubcribe from the SMS marketing message.
trackDefaultEvent	`@NonNull` Boolean	Whether to track default events such as PageView.
hidePopup	`@NonNull` Boolean	Whether to hide popups such as marketing popup and in-app notification.
channelButtonOption	`@Nullable` ChannelButtonOption	An option for channel button. See customizing channel button.
buttonOption	`@Nullable` BubbleOption	An option for popups such as marketing popup and in-app notification. See customizing popups.
appearance	`@Nullable` Appearance	An option for appearance that the SDK will use.

enum Language

Languages that the Channel supports.

Field	Description
KOREAN	Korean.
JAPANESE	Japanese.
ENGLISH	English.

ChannelButtonIcon

Preset icons for the channel button.

enum class ChannelButtonIcon {  
  Channel,
  ChatBubbleFilled,
  ChatProgressFilled,
  ChatQuestionFilled,
  ChatLightningFilled,
  ChatBubbleAltFilled,
  SmsFilled,
  CommentFilled,
  SendForwardFilled,
  HelpFilled,
  ChatProgress,
  ChatQuestion,
  ChatBubbleAlt,
  Sms,
  Comment,
  SendForward,
  Communication,
  Headset,
}

ChannelButtonPosition

Position values for the channel button.

enum class ChannelButtonPosition {
  RIGHT,
  LEFT,
}

ChannelButtonOption

An option for the Channel button.

파라미터	타입	설명
icon	ChannelButtonIcon	The icon type of the Channel button.
position	ChannelButtonPosition	The position of the Channel button.
xMargin	float	A X-axis margin from `position` in DP.
yMargin	float	A Y-axis margin from `position` in DP.

파라미터	타입	설명
icon	ChannelButtonIcon	The icon type of the Channel button.

파라미터	타입	설명
position	ChannelButtonPosition	The position of the Channel button.
xMargin	float	A X-axis margin from `position` in DP.
yMargin	float	A Y-axis margin from `position` in DP.

BubbleOption

An option for the marketing popups and in-app notifications.

Field	Type	Description
position	`@NonNull` BubblePosition	The position of the popup.
yMargin	float	A Y-axis margin from position in DP.

Profile

A user’s profile. See BootConfig#setProfile(Profile).

Primitive fields

Field	Type	Description
name	`@Nullable` String	A name of a user.
email	`@Nullable` String	An email of a user.
mobileNumber	`@Nullable` String	A mobile number of a user.
avatarUrl	`@Nullable` String	An avatar URL of a user.

setProperty

Set custom field for the profile.

Field	Type	Description
propertyKey	`@NonNull` String	A key of the profile property.
propertyValue	`@Nullable` Object	A value of the profile property.

setProperties

Set multiple profile properties.

User

Field	Type	Description
id	`@NonNull` String	A user id.
memberId	`@Nullable` String	An identifier to distinguish member users. Anonymous user is null.
name	`@Nullable` String	A name of the user.
avatarUrl	`@Nullable` String	An avatar URL of the user.
profile	`@Nullable` Map<String, Object>	A profile of the user.
alert	int	The number of important notifications. The default channel button shows it as a number in the badge.
unread	int	The number of unread notifications. It includes the value of `alert`. The default channel button shows it as a dot.
tags	`@Nullable` List	A tag list of the user.
language	`@Nullable` String	A language of the user.
unsubscribeTexting	boolean	Whether the user has unsubcribed from receiving a SMS or LMS marketing message.
unsubcribeEmail	boolean	Whether the user has unsubscribed from receiving an email marketing message.

PopupData

An information of in-app popup.

Field	Type	Description
chatId	`@NonNull` String	A chat room ID that the popup was shown.
avatarUrl	`@Nullable` String	An avatar URL of the popup.
name	`@NonNull` String	A name shown on the popup.
message	`@NonNull` String	A message that is shown on the popup.

UserData.Builder

Builds a new User instance. See ChannelIO.updateUser(UserData, UserUpdateCallback) for details.

setLanguage

Sets a language of the user.

Field	Type	Description
language	`@NonNull` Language	A language of the user.

setTags

Sets a tag list of the user.

Field	Type	Description
tags	`@Nullable` List	A tag list of the user.

setProfileMap

Sets profile information of the user.

Field	Type	Description
tags	`@Nullable` List	A tag list of the user.

setProfileOnceMap

Sets profile information of the user only when it is not present.

Field	Type	Description
profileOnceMap	`@Nullable` Map<String, Object>	A profile information of the user.

setUnsubscribeEmail

Sets whether the user wants to unsubscribe from an email marketing message.

Field	Type	Description
unsubcribeEmail	`@NonNull` Boolean	Whether the user wants to unsubscribe from an email marketing message.

setUnsubcribeTexting

Sets whether the user wants to unsubscribe from a SMS or LMS marketing message.

Field	Type	Description
unsubscribeTexting	`@NonNull` Boolean	Whether the user wants to unsubscribe from a SMS or LMS marketing message.

BootStatus

A result for ChannelIO.boot().

Field	Description
SUCCESS	The boot was successful.
NOT_INITIALIZED	`ChannelIO.initialize()` was not called.
NETWORK_TIMEOUT	The boot failed because of a network issue.
NOT_AVAILABLE_VERSION	Not a supported SDK version.
SERVICE_UNDER_CONSTRUCTION	Channel.io server is under construction.
REQUIRE_PAYMENT	The channel is blocked or you need to check the subscription plan.
ACCESS_DENIED	Server responded with 4xx status code.
UNKNOWN	An unknown error.

enum Appearance

An appearance for the SDK.

Field	Description
LIGHT	A light theme.
DARK	A dark theme.
SYSTEM	Follows the system theme.