Skip to content

Commit

Permalink
Merge pull request #7 from Katinor/latest
Browse files Browse the repository at this point in the history
fix readme
  • Loading branch information
Katinor authored Sep 5, 2018
2 parents 63e6f52 + 854d1af commit 61954f8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ kakaobot.py는 Client를 선언하고 Client.run()을 통해 챗봇을 활성화
| ---- | ---- | -------- | ----------- |
| port | int | Optional | 카카오톡 플러스친구 API와 통신할 웹서버의 포트번호입니다. 생략시 Flask의 기본 포트번호인 5000이 적용됩니다. |
| kboard | [Kboard](#Kboard) | Optional | 챗봇 사용자가 처음으로 이 챗봇의 채팅방에 들어올 때 적용되는 Kboard입니다. 생략시 빈 Kboard 가 적용됩니다. |
| kboard | [Message](#message) | Optional | 사용자가 챗봇에게 전달한 메시지가 커맨드에 등록되어있지 않고, 별도의 처리가 없을 경우 사용자에게 전달되는 메시지입니다. 생략시 "Error occured" 라고 챗봇이 말합니다. |
| error_text | [Message](#message) | Optional | 사용자가 챗봇에게 전달한 메시지가 등록된 명령어들을 어느것도 만족하지 않을 경우 사용자에게 전달되는 메시지입니다. 생략시 "Error occured" 라고 챗봇이 말합니다.<br>set_extra()로 등록된 함수가 있다면 이 메시지가 전달되지 않습니다. (다른 데코레이터로 등록된 명령어들을 만족하는 메세지를 제외한 모든 메세지가 그 함수를 명령어처럼 발동시키기 때문입니다.) |

##### `명령어 등록시의 주의점`

Expand Down Expand Up @@ -229,7 +229,7 @@ def extra_func(user_key,content):

| 매개변수 | 타입 | 필수여부 | 설명 |
| ---- | ---- | -------- | ----------- |
| button | string | Require | 추가할 객관식 응답입니다. |
| button | string | Required | 추가할 객관식 응답입니다. |

#### Message

Expand All @@ -249,23 +249,23 @@ def extra_func(user_key,content):

| 매개변수 | 타입 | 필수여부 | 설명 |
| ---- | ---- | -------- | ----------- |
| text | string | Require | 교체할 텍스트 입니다. |
| text | string | Required | 교체할 텍스트 입니다. |

##### `set_photo(photo)`

메시지 객체의 사진을 교체합니다.

| 매개변수 | 타입 | 필수여부 | 설명 |
| ---- | ---- | -------- | ----------- |
| text | [Photo](#Photo) | Require | 교체할 Photo 객체입니다. |
| text | [Photo](#Photo) | Required | 교체할 Photo 객체입니다. |

##### `set_button(message_button)`

메시지 객체의 링크버튼을 교체합니다.

| 매개변수 | 타입 | 필수여부 | 설명 |
| ---- | ---- | -------- | ----------- |
| text | [Mbutton](#Mbutton) | Require | 교체할 Mbutton 객체입니다. |
| text | [Mbutton](#Mbutton) | Required | 교체할 Mbutton 객체입니다. |


##### `set_keyboard(keyboard)`
Expand All @@ -274,16 +274,16 @@ def extra_func(user_key,content):

| 매개변수 | 타입 | 필수여부 | 설명 |
| ---- | ---- | -------- | ----------- |
| text | [Kboard](#Kboard) | Require | 교체할 Kboard 객체입니다. |
| text | [Kboard](#Kboard) | Required | 교체할 Kboard 객체입니다. |

#### Mbutton

링크버튼(message_button) 객체입니다. Message 객체에 포함될 경우 말풍선 하단에 링크를 가진 버튼이 추가됩니다.

| 매개변수 | 타입 | 필수여부 | 설명 |
| ---- | ---- | -------- | ----------- |
| label | string | Require | 링크버튼의 타이틀입니다. |
| url | string | Require | 버튼을 누를 경우 연결되는 주소입니다. |
| label | string | Required | 링크버튼의 타이틀입니다. |
| url | string | Required | 버튼을 누를 경우 연결되는 주소입니다. |

#### Photo

Expand All @@ -293,7 +293,7 @@ def extra_func(user_key,content):

| 매개변수 | 타입 | 필수여부 | 설명 |
| ---- | ---- | -------- | ----------- |
| url | string | Require | 이미지를 불어 올 주소입니다. |
| url | string | Required | 이미지를 불어 올 주소입니다. |
| width | int | Optional | 이미지의 너비입니다. 생략시 720이 적용됩니다. |
| height | int | Optional | 이미지의 높이입니다. 생략시 630이 적용됩니다. |

Expand Down
2 changes: 1 addition & 1 deletion kakaobot/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -211,4 +211,4 @@ def _main_set_message():
return jsonify(target.make_dict())

self.app.run(host='0.0.0.0',port=self._port,debug=False)
log_append("Kakaobot","Chatbot started","SYS","run")
log_append("Kakaobot","Chatbot started","SYS","run")

0 comments on commit 61954f8

Please sign in to comment.