import chatwork from 'chatwork-utils/src/chatwork.js'

public class | source

chatwork

Extends:

baseChatwork → chatworkRo → chatwork

For use Chatwork services

See:

http://developer.chatwork.com/ja/endpoints.html

Method Summary

Public Methods
public	approveIncomingRequest(requestId: number): Promise 自分に対するコンタクト承認依頼を承認する
public	createChatroom(options: Object): Promise グループチャットを新規作成
public	createMessageChatroom(roomId: number, message: string): Promise チャットに新しいメッセージを追加
public	createTaskChatroom(roomId: number, options: Object): Promise チャットに新しいタスクを追加
public	deleteChatroom(roomId: number): Promise グループチャットを削除する
public	leaveChatroom(roomId: number): Promise グループチャットを退席する
public	modifyChatroomMembers(roomId: number, options: Object): Promise チャットのメンバーを一括変更
public	rejectIncomingRequest(requestId: number): Promise 自分に対するコンタクト承認依頼をキャンセルする
public	updateChatroom(roomId: number, options: Object): Promise チャットの名前、アイコンをアップデート

Inherited Summary

From class baseChatwork
public	instance: Object Set config defaults when create the axios instance

From class chatworkRo
public	getFileInfo(roomId: number, fileId: number, isUrl: number): Promise ファイル情報を取得
public	getMessageInfo(roomId: number, messageId: string): Promise メッセージ情報を取得
public	getMyStatus(): Promise 自分の未読数、未読To数、未完了タスク数を返す
public	getRoomInfo(roomId: number): Promise チャットの名前、アイコン、種類(my/direct/group)を取得
public	getTaskInfo(roomId: number, taskId: number): Promise タスク情報を取得
public	listIncomingRequests(): Promise 自分に対するコンタクト承認依頼一覧を取得する(100件まで取得可能)
public	listMyContacts(): Promise 自分のコンタクト一覧を取得
public	listMyMessages(): Promise 自分のチャット一覧の取得
public	listMyTasks(assignedByAccountId: number, status: string): Promise 自分のタスク一覧を取得する。(100件まで取得可能)
public	listRoomFiles(roomId: number, accountId: number): Promise チャットのファイル一覧を取得 (100件まで取得可能)
public	listRoomMembers(roomId: number): Promise チャットのメンバー一覧を取得
public	listRoomMessages(roomId: number, isForce: number): Promise チャットのメッセージ一覧を取得。パラメータ未指定だと前回取得分からの差分のみを返します。(最大100件まで取得)
public	listRoomTasks(roomId: number, accountId: number, assignedByAccountId: number, status: string): Promise チャットのタスク一覧を取得 (100件まで取得可能)
public	me(): Promise 自分自身の情報を取得

Public Methods

public approveIncomingRequest(requestId: number): Promise source

自分に対するコンタクト承認依頼を承認する

Params:

Name	Type	Attribute	Description
requestId	number		リクエストID

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_incoming_requests.html#PUT-incoming_requests-request_id

public createChatroom(options: Object): Promise source

グループチャットを新規作成

Params:

Name	Type	Attribute	Description
options	Object		オプション引数
options.description	string		チャット概要
options.membersAdminIds	number[]		管理者権限のユーザー
options.membersMemberIds	number[]		メンバー権限のユーザー
options.membersReadonlyIds	number[]		閲覧のみ権限のユーザー
options.iconPreset	string		アイコン種類
options.name	string		グループチャット名

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms

public createMessageChatroom(roomId: number, message: string): Promise source

チャットに新しいメッセージを追加

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームID
message	string		メッセージ本文

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-messages

public createTaskChatroom(roomId: number, options: Object): Promise source

チャットに新しいタスクを追加

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームID
options	Object		オプション引数
options.body	string		タスクの内容
options.limit	number		タスクの期限(Unix timeで入力してください)
options.toIds	number[]		担当者のアカウントID

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-messages

public deleteChatroom(roomId: number): Promise source

グループチャットを削除する

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームID

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_rooms.html#DELETE-rooms-room_id

public leaveChatroom(roomId: number): Promise source

グループチャットを退席する

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームID

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_rooms.html#DELETE-rooms-room_id

public modifyChatroomMembers(roomId: number, options: Object): Promise source

チャットのメンバーを一括変更

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームID
options	Object		オプション引数
options.membersAdminIds	number[]		管理者権限のユーザー
options.membersMemberIds	number[]		メンバー権限のユーザー
options.membersReadonlyIds	number[]		閲覧のみ権限のユーザー

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-members

public rejectIncomingRequest(requestId: number): Promise source

自分に対するコンタクト承認依頼をキャンセルする

Params:

Name	Type	Attribute	Description
requestId	number		リクエストID

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_incoming_requests.html#DELETE-incoming_requests-request_id

public updateChatroom(roomId: number, options: Object): Promise source

チャットの名前、アイコンをアップデート

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームID
options	Object		オプション引数
options.description	string		グループチャットの概要説明テキスト
options.iconPreset	string		グループチャットのアイコン種類
options.name	string		グループチャットのチャット名

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id