Overview
  • Namespace
  • Class

Namespaces

  • wataridori
    • ChatworkSDK
      • Exception

Classes

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

Class ChatworkRoom

wataridori\ChatworkSDK\ChatworkBase
Extended by wataridori\ChatworkSDK\ChatworkRoom
Namespace: wataridori\ChatworkSDK
Located at ChatworkRoom.php

Methods summary

public
# __construct( integer|array $room )

Constructor.

Constructor.

Parameters

$room

Overrides

wataridori\ChatworkSDK\ChatworkBase::__construct
public
# init( integer|array $room )

Parameters

$room
public array
# toArray( )

Returns

array
Room Information
public array
# get( )

Get Room Information.

Get Room Information.

Returns

array
public mixed|
# updateInfo( array $params = [] )

Update Room Information.

Update Room Information.

Parameters

$params

Returns

mixed|
public array
# getMembers( )

Get Members list of room.

Get Members list of room.

Returns

array
public mixed|
# updateMembers( array $members_admin_ids = [], array $params = [] )

Update members list of room.

Update members list of room.

Parameters

$members_admin_ids
$params

Returns

mixed|
public array
# getMessages( boolean $force = false )

Get Messages of Room.

Get Messages of Room.

Parameters

$force

Returns

array
public
# sendMessage( null $newMessage = null )

Send Message.

Send Message.

Parameters

$newMessage
public
# sendMessageToList( wataridori\ChatworkSDK\ChatworkUser[] $members, string $sendMessage, boolean $withName = true, boolean $newLine = true, boolean $usePicon = false )

Send Message to list of members.

Send Message to list of members.

Parameters

$members
$sendMessage
$withName
$newLine
$usePicon

Throws

wataridori\ChatworkSDK\Exception\ChatworkSDKException
public
# sendMessageToAll( null $sendMessage, boolean $withName = true, boolean $newLine = true, boolean $usePicon = false )

Send Message To All Members in Room.

Send Message To All Members in Room.

Parameters

$sendMessage
$withName
$newLine
$usePicon
public string
# buildReplyInRoom( wataridori\ChatworkSDK\ChatworkMessage $chatworkMessage, boolean $newLine = true )

Build a Reply Message.

Build a Reply Message.

Parameters

$chatworkMessage
$newLine

Returns

string
public string
# appendReplyInRoom( wataridori\ChatworkSDK\ChatworkMessage $chatworkMessage, boolean $newLine = true )

Build a Reply Message and append it to current Message.

Build a Reply Message and append it to current Message.

Parameters

$chatworkMessage
$newLine

Returns

string
$message

Throws

Exception
public
# reply( wataridori\ChatworkSDK\ChatworkMessage|wataridori\ChatworkSDK\ChatworkMessage[] $chatworkMessages, string $msg, boolean $newLine = true, boolean $resetMessage = true )

Reply list messages in room.

Reply list messages in room.

Parameters

$chatworkMessages
$msg
$newLine
$resetMessage

Methods inherited from wataridori\ChatworkSDK\ChatworkBase

appendCode(), appendInfo(), appendMessage(), appendQuote(), appendReply(), appendTo(), buildCode(), buildInfo(), buildQuote(), buildReply(), buildTo(), getApiKey(), getMessage(), getRoomId(), resetMessage(), setApiKey(), setMessage(), setRoomId()

Properties summary

public string $room_id
# ''
public string $name
# ''
public string $type
# ''
public string $role
# ''
public string $sticky
# ''
public string $unread_num
# ''
public string $mention_num
# ''
public string $mytask_num
# ''
public string $message_num
# ''
public string $file_num
# ''
public string $task_num
# ''
public string $icon_path
# ''
public string $description
# ''
protected array $listMembers
# []

Properties inherited from wataridori\ChatworkSDK\ChatworkBase

$apiKey, $chatworkApi, $message, $roomId

API documentation generated by ApiGen