BarkMessageBuilder

Class: BarkMessageBuilder

A class to help build Bark message properly

Table of contents

Constructors

• constructor

Properties

• barkMessage

Methods

• archive
• badge
• body
• build
• category
• copy
• deviceKey
• group
• icon
• isNotUrlErrorProducer
• level
• sound
• title
• url

Constructors

constructor

• new BarkMessageBuilder(): BarkMessageBuilder

Returns

BarkMessageBuilder

Defined in

src/lib/BarkMessageBuilder.ts:16

Properties

barkMessage

• Protected barkMessage: BarkMessage

The Bark message which will be built

Defined in

src/lib/BarkMessageBuilder.ts:14

Methods

archive

▸ archive(): BarkMessageBuilder

Set the message as archived

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:24

---

badge

▸ badge(badge): BarkMessageBuilder

Set the badge property of the message

Parameters

Name	Type
badge	number

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:34

---

body

▸ body(body): BarkMessageBuilder

Set the body property of the message

Parameters

Name	Type
body	string

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:52

---

build

▸ build(): BarkMessage

When all the properties is set, use this function to build the message

Returns

BarkMessage

Bark message

Defined in

src/lib/BarkMessageBuilder.ts:43

---

category

▸ category(category): BarkMessageBuilder

Set the category of the message

Parameters

Name	Type
category	string

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:62

---

copy

▸ copy(copy): BarkMessageBuilder

Set the copy property of the message

Parameters

Name	Type
copy	string

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:72

---

deviceKey

▸ deviceKey(deviceKey): BarkMessageBuilder

Set the device key property of the message

Parameters

Name	Type
deviceKey	string

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:82

---

group

▸ group(group): BarkMessageBuilder

Set the group property of the message

Parameters

Name	Type
group	string

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:92

---

icon

▸ icon(icon): BarkMessageBuilder

Set the icon property of the message

Parameters

Name	Type
icon	string

Returns

BarkMessageBuilder

The builder

Throws

BarkMessageError if the argument is not a URL

Defined in

src/lib/BarkMessageBuilder.ts:103

---

isNotUrlErrorProducer

▸ isNotUrlErrorProducer(argumentName): BarkMessageError

An error producing function

Parameters

Name	Type	Description
argumentName	string	The name of the argument which is not a URL

Returns

BarkMessageError

Bark message error

Defined in

src/lib/BarkMessageBuilder.ts:162

---

level

▸ level(level): BarkMessageBuilder

Set the level property of the message

Parameters

Name	Type
level	BarkMessageLevel

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:117

---

sound

▸ sound(sound): BarkMessageBuilder

Set the sound property of the message

Parameters

Name	Type
sound	BarkMessageSound

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:127

---

title

▸ title(title): BarkMessageBuilder

Set the title property of the message

Parameters

Name	Type
title	string

Returns

BarkMessageBuilder

The builder

Defined in

src/lib/BarkMessageBuilder.ts:137

---

url

▸ url(url): BarkMessageBuilder

Set the URL property of the message

Parameters

Name	Type
url	string

Returns

BarkMessageBuilder

The builder

Throws

BarkMessageError if the argument is not a URL

Defined in

src/lib/BarkMessageBuilder.ts:148