Namespace: PlusFriend

Kakao. PlusFriend

Include functions related to PlusFriend Plug-in.

Methods


<static> addFriend(settings)

Opens a popup window about Add PlusFriend. this must be called after users click event in order to make sure that browser does not block window. if it is not necessary to make custom login button refer Kakao.PlusFriend.createAddFriendButton.

Parameters:
Name Type Description
settings Object

Attributes of PlusFriend are passed by 'key/value' format.

Properties
Name Type Description
plusFriendId String

Plus Friend ID included in Target Plus Friend Home URL


<static> chat(settings)

Start a 1:1 chatting with PlusFriend. this must be called after users click event in order to make sure that browser does not block window. if it is not necessary to make custom login button refer Kakao.PlusFriend.createChatButton.

Parameters:
Name Type Description
settings Object

Attributes of PlusFriend are passed by 'key/value' format.

Properties
Name Type Description
plusFriendId String

Plus Friend ID included in Target Plus Friend Home URL


<static> createAddFriendButton(settings)

Create a Add PlusFriend button. Use Kakao.PlusFriend.addFriend when creating button manually.

Parameters:
Name Type Description
settings Object

Attributes of Add PlusFriend button are passed by 'key/value' format.

Properties
Name Type Argument Default Description
container String | DOMElement

ID Selector or DOM Element

plusFriendId String

Plus Friend ID included in Target Plus Friend Home URL

size "small" | "large" <optional>
"small"

Size of Add PlusFriend button

color "yellow" | "black" <optional>
"yellow"

Size of Add PlusFriend button

shape "rect" | "round" <optional>
"rect"

Shape of Add PlusFriend button

supportMultipleDensities Boolean <optional>
false

Use 2x 3x resolution images according to device pixel ratio, unsupported IE


<static> createChatButton(settings)

Create a 1:1 Chat PlusFriend button. Use Kakao.PlusFriend.chat when creating button manually.

Parameters:
Name Type Description
settings Object

Attributes of Add PlusFriend button are passed by 'key/value' format.

Properties
Name Type Argument Default Description
container String | DOMElement

ID Selector or DOM Element

plusFriendId String

Plus Friend ID included in Target Plus Friend Home URL

title "consult" | "question" <optional>
"consult"

Title of 1:1 Chat PlusFriend button

size "small" | "large" <optional>
"small"

Size of 1:1 Chat PlusFriend button

color "yellow" | "black" <optional>
"yellow"

Size of 1:1 Chat PlusFriend button

shape "pc" | "mobile" <optional>
"pc"

Shape of 1:1 Chat PlusFriend button

supportMultipleDensities Boolean <optional>
false

Use 2x 3x resolution images according to device pixel ratio, unsupported IE