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

public class | source

chatworkRo

Extends:

baseChatwork → chatworkRo

Direct Subclass:

chatwork

For use Chatwork Readonly services

See:

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

Method Summary

Public Methods
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 自分自身の情報を取得

Inherited Summary

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

Public Methods

public getFileInfo(roomId: number, fileId: number, isUrl: number): Promise source

ファイル情報を取得

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームのID
fileId	number		参照するファイルのID
isUrl	number	optional default: 0	1のときダウンロードする為のURLを生成する

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-files-file_id

public getMessageInfo(roomId: number, messageId: string): Promise source

メッセージ情報を取得

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームのID
messageId	string		参照するメッセージのID

Return:

Promise

Return response or error message.

See:

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

public getMyStatus(): Promise source

自分の未読数、未読To数、未完了タスク数を返す

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_my.html#GET-my-status

public getRoomInfo(roomId: number): Promise source

チャットの名前、アイコン、種類(my/direct/group)を取得

Params:

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

Return:

Promise

Return response or error message.

See:

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

public getTaskInfo(roomId: number, taskId: number): Promise source

タスク情報を取得

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームのID
taskId	number		参照するタスクのID

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-tasks-task_id

public listIncomingRequests(): Promise source

自分に対するコンタクト承認依頼一覧を取得する(100件まで取得可能)

Return:

Promise

Return response or error message.

See:

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

public listMyContacts(): Promise source

自分のコンタクト一覧を取得

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_contacts.html#GET-contacts

public listMyMessages(): Promise source

自分のチャット一覧の取得

Return:

Promise

Return response or error message.

See:

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

public listMyTasks(assignedByAccountId: number, status: string): Promise source

自分のタスク一覧を取得する。(100件まで取得可能)

Params:

Name	Type	Attribute	Description
assignedByAccountId	number		タスクの依頼者のアカウントID
status	string	optional default: 'open'	タスクのステータス 'open' or 'done'

Return:

Promise

Return response or error message.

See:

http://developer.chatwork.com/ja/endpoint_my.html#GET-my-tasks

public listRoomFiles(roomId: number, accountId: number): Promise source

チャットのファイル一覧を取得 (100件まで取得可能)

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームのID
accountId	number		アップロードしたユーザーのアカウントID

Return:

Promise

Return response or error message.

See:

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

public listRoomMembers(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#GET-rooms-room_id-members

public listRoomMessages(roomId: number, isForce: number): Promise source

チャットのメッセージ一覧を取得。パラメータ未指定だと前回取得分からの差分のみを返します。(最大100件まで取得)

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームのID
isForce	number	optional default: 0	1を指定すると未取得にかかわらず最新の100件を取得します

Return:

Promise

Return response or error message.

See:

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

public listRoomTasks(roomId: number, accountId: number, assignedByAccountId: number, status: string): Promise source

チャットのタスク一覧を取得 (100件まで取得可能)

Params:

Name	Type	Attribute	Description
roomId	number		チャットルームのID
accountId	number		タスクの担当者のアカウントID
assignedByAccountId	number		タスクの依頼者のアカウントID
status	string	optional default: 'open'	タスクのステータス 'open' or 'done'

Return:

Promise

Return response or error message.

See:

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

public me(): Promise source

自分自身の情報を取得

Return:

Promise

Return response or error message.

Example:

const cw = new Chatwork(apiKey);
cw.me()
  .then(res => {
    console.log(res.data);
    console.log(res.status);
    console.log(res.statusText);
    console.log(res.headers);
    console.log(res.config);
  })
  .catch(err => {
    if(err.response) {
      console.log(err.response.data);
      console.log(err.response.status);
      console.log(err.response.headers);
    } else if(err.request) {
      console.log(err.request);
    } else {
      console.log('Error', err.message);
    }
    console.log(err.config);
  });

See:

http://developer.chatwork.com/ja/endpoint_me.html#GET-me