Skip to content
This repository was archived by the owner on Sep 27, 2019. It is now read-only.

Commit fc126f2

Browse files
committed
Update readme
1 parent a36a281 commit fc126f2

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ If you're using Laravel < 5.5 or if you have package auto-discovery turned off y
4444
NotificationChannels\HipChat\HipChatServiceProvider::class,
4545
],
4646
```
47+
4748
### Setting up the HipChat service
4849

4950
Add your HipChat Account Token and optionally the default room and Hipchat API server's base url to your `config/services.php`:
@@ -91,6 +92,7 @@ class UserRegistered extends Notification
9192
```
9293

9394
### Sending a room notification with a card
95+
9496
Read more about HipChat notification cards [here](https://developer.atlassian.com/hipchat/guide/sending-messages#SendingMessages-UsingCards).
9597

9698
```php
@@ -168,6 +170,7 @@ public function toHipChat($notifiable)
168170
### Available methods
169171

170172
#### `HipChatMessage`
173+
171174
- `create()`: Creates a new `HipChatMessage` instance.
172175
- `room()`: Sets the id or name of the HipChat room to send the notification to.
173176
- `from()`: Sets the optional label to be shown in addition to the sender's name.
@@ -181,6 +184,7 @@ public function toHipChat($notifiable)
181184
- `error()`: Sets notification level to `info` and color to `MessageColors::RED`.
182185

183186
#### `Card`
187+
184188
- `create()`: Creates a new `Card` instance.
185189
- `title()`: Sets the title of the card.
186190
- `id()`: Sets the id of the card.
@@ -195,6 +199,7 @@ public function toHipChat($notifiable)
195199
- `addAttribute()`: Adds a `CardAttribute` to the card.
196200

197201
#### `CardAttribute`
202+
198203
- `create()`: Creates a new `CardAttribute` instance.
199204
- `value()`: Sets the textual value of the attribute.
200205
- `label()`: Sets the label of the attribute.
@@ -203,6 +208,7 @@ public function toHipChat($notifiable)
203208
- `icon()`: Sets the icon of the attribute.
204209

205210
#### `HipChatFile`
211+
206212
- `create()`: Creates a new `HipChatFile` instance.
207213
- `room()`: Sets the id or name of the HipChat room to share the file in.
208214
- `path()`: Sets the `fileContent` to the resource of the existing file and tries to detect and set the `fileName` and `fileType` if they weren't explicitely set.

0 commit comments

Comments
 (0)