Class ChatworkBase

Direct known subclasses

wataridori\ChatworkSDK\ChatworkMessage, wataridori\ChatworkSDK\ChatworkRoom, wataridori\ChatworkSDK\ChatworkUser

Namespace: wataridori\ChatworkSDK
Located at ChatworkBase.php

Methods summary

`public`	# `__construct( string\|null $roomId = null )` Parameters `$roomId`
`public`	# `setApiKey( string $apiKey )` Set api key. Set api key. Parameters `$apiKey`
`public string`	# `getApiKey( )` Get ApiKey. Get ApiKey. Returns string
`public`	# `setRoomId( string $roomId )` Set RoomId. Set RoomId. Parameters `$roomId`
`public string\|null`	# `getRoomId( )` Returns string\|null
`public`	# `setMessage( string $message )` Set message. Set message. Parameters `$message`
`public`	# `resetMessage( )` Reset message to empty string. Reset message to empty string.
`public string`	# `getMessage( )` Returns string message
`public string`	# `appendMessage( string $appendText )` Append inputted text to current message. Append inputted text to current message. Parameters `$appendText` Returns string $message
`public string`	# `buildTo( wataridori\ChatworkSDK\ChatworkUser $chatworkUser, boolean $withName = true, boolean $newLine = true, boolean $usePicon = false )` Build a To Message. Build a To Message. Parameters `$chatworkUser` `$withName` `$newLine` `$usePicon` Returns string
`public string`	# `appendTo( wataridori\ChatworkSDK\ChatworkUser $chatworkUser, boolean $withName = true, boolean $newLine = true, boolean $usePicon = false )` Build a To Message and append it to current Message. Build a To Message and append it to current Message. Parameters `$chatworkUser` `$withName` `$newLine` `$usePicon` Returns string $message
`public string`	# `buildReply( string $roomId, wataridori\ChatworkSDK\ChatworkMessage $chatworkMessage, boolean $newLine = true )` Build a Reply Message. Build a Reply Message. Parameters `$roomId` `$chatworkMessage` `$newLine` Returns string Throws `wataridori\ChatworkSDK\Exception\NoChatworkRoomException`
`public string`	# `appendReply( string $roomId, 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 `$roomId` `$chatworkMessage` `$newLine` Returns string $message Throws Exception
`public string`	# `buildQuote( wataridori\ChatworkSDK\ChatworkMessage $chatworkMessage, boolean $time = true )` Build quote message. Build quote message. Parameters `$chatworkMessage` `$time` Returns string
`public string`	# `appendQuote( wataridori\ChatworkSDK\ChatworkMessage $chatworkMessage, boolean $time = true )` Build quote message and apply it to current Message. Build quote message and apply it to current Message. Parameters `$chatworkMessage` `$time` Returns string
`public string`	# `buildInfo( string $message, string $title = '' )` Build Information tag. Build Information tag. Parameters `$message` `$title` Returns string
`public string`	# `appendInfo( string $message, string $title = '' )` Build Information tag and append it to current message. Build Information tag and append it to current message. Parameters `$message` `$title` Returns string $message
`public string`	# `buildCode( string $message )` Build Code tag. Build Code tag. Parameters `$message` Returns string
`public string`	# `appendCode( string $message )` Build Code tag and append it to current message. Build Code tag and append it to current message. Parameters `$message` Returns string $message

Properties summary

`protected`	`$apiKey` Chatwork Api Key. Chatwork Api Key.	#
`protected`	`$roomId` Chatwork Room Id. Chatwork Room Id.	#
`protected`	`$message`	#
`protected`	`$chatworkApi`	#