Overview
  • Namespace
  • Class

Namespaces

  • wataridori
    • ChatworkSDK
      • Exception

Classes

  • ChatworkApi
  • ChatworkBase
  • ChatworkMessage
  • ChatworkRequest
  • ChatworkRoom
  • ChatworkSDK
  • ChatworkUser

Class ChatworkApi

Namespace: wataridori\ChatworkSDK
Located at ChatworkApi.php

Methods summary

public
# __construct( )

Constructor.

Constructor.

public array
# me( )

Get user own information.

Get user own information.

Returns

array

See

http://developer.chatwork.com/ja/endpoint_me.html#GET-me
public array
# getMyStatus( )

Get user own statics information.

Get user own statics information.

Returns

array

See

http://developer.chatwork.com/ja/endpoint_my.html#GET-my-status
public array
# getMyTasks( array $params = [] )

Get user own task information.

Get user own task information.

Parameters

$params

Returns

array

See

http://developer.chatwork.com/ja/endpoint_my.html#GET-my-tasks
public array
# getContacts( )

Get user contacts list.

Get user contacts list.

Returns

array

See

http://developer.chatwork.com/ja/endpoint_contacts.html#GET-contacts
public array.
# getRooms( )

Get user rooms list.

Get user rooms list.

Returns

array.

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms
public array
# createRoom( string $name, array $members_admin_ids = [], array $params = [] )

Create new room.

Create new room.

Parameters

$name
$members_admin_ids
$params

Returns

array

See

http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms
public array
# getRoomById( integer $room_id )

Get room information.

Get room information.

Parameters

$room_id

Returns

array

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id
public mixed|
# updateRoomInfo( integer $room_id, array $params = [] )

Update room information.

Update room information.

Parameters

$room_id
$params

Returns

mixed|

See

http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id
public array
# deleteRoom( integer $room_id )

Delete room.

Delete room.

Parameters

$room_id

Returns

array

See

http://developer.chatwork.com/ja/endpoint_rooms.html#DELETE-rooms-room_id
public array
# leaveRoom( integer $room_id )

Leave room.

Leave room.

Parameters

$room_id

Returns

array

See

http://developer.chatwork.com/ja/endpoint_rooms.html#DELETE-rooms-room_id
public array
# getRoomMembersById( integer $room_id )

Get all members of a room.

Get all members of a room.

Parameters

$room_id

Returns

array

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-members
public mixed|
# updateRoomMembers( integer $room_id, array $members_admin_ids = [], array $params = [] )

Update current room members.

Update current room members.

Parameters

$room_id
$members_admin_ids
$params

Returns

mixed|

See

http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-members
public array
# getRoomMessages( integer $room_id, boolean $force = false )

Get messages of a room.

Get messages of a room.

Parameters

$room_id
$force

Returns

array

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-messages
public array
# createRoomMessage( integer $room_id, string $body )

Create a message.

Create a message.

Parameters

$room_id
$body

Returns

array

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-messages
public array
# getRoomMessageByMessageId( integer $room_id, string $message_id )

Get a message.

Get a message.

Parameters

$room_id
$message_id

Returns

array

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-messages-message_id
public mixed|
# getRoomTasks( integer $room_id, array $params = [] )

Get tasks of a room.

Get tasks of a room.

Parameters

$room_id
$params

Returns

mixed|

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-tasks
public mixed|
# getRoomTaskById( integer $room_id, integer $task_id )

Get a task of a room.

Get a task of a room.

Parameters

$room_id
$task_id

Returns

mixed|

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-tasks-task_id
public mixed|
# addTask( integer $room_id, array $to_ids, string $body, null|string $limit = null )

Add new task.

Add new task.

Parameters

$room_id
$to_ids
$body
$limit

Returns

mixed|

See

http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-tasks
public array
# getRoomFiles( integer $room_id, array $params = [] )

Get files of a room.

Get files of a room.

Parameters

$room_id
$params

Returns

array

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-files
public mixed|
# getRoomFileById( integer $room_id, integer $file_id, boolean $create_download_url = false )

Get file of a room.

Get file of a room.

Parameters

$room_id
$file_id
$create_download_url

Returns

mixed|

See

http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-files-file_id
public array
# getIncomingRequests( )

Get Friend Request list.

Get Friend Request list.

Returns

array

See

http://developer.chatwork.com/ja/endpoint_incoming_requests.html#GET-incoming_requests
public
# acceptFriendRequest( integer $request_id )

Accept Friend Request.

Accept Friend Request.

Parameters

$request_id
request_id

See

http://developer.chatwork.com/ja/endpoint_incoming_requests.html#PUT-incoming_requests-request_id
public
# deleteFriendRequest( integer $request_id )

Delete Friend Request.

Delete Friend Request.

Parameters

$request_id
request_id

See

http://developer.chatwork.com/ja/endpoint_incoming_requests.html#DELETE-incoming_requests-request_id
protected array
# api( string $endPoint, string $method = wataridori\ChatworkSDK\ChatworkRequest::REQUEST_METHOD_GET, array $params = [] )

Call Chatwork API.

Call Chatwork API.

Parameters

$endPoint
$method
$params

Returns

array

Properties summary

public static string $apiKey

apiKey

apiKey

# ''
API documentation generated by ApiGen