Notify

Notify module for RobinPath.

Package: @robinpath/notify | Category: Messaging | Type: Integration

Authentication

No authentication required. All functions are available immediately.

Use Cases

Use the notify module when you need to:

• send -- Use notify.send to perform this operation
• sendUrgent -- Use notify.sendUrgent to perform this operation
• sendSilent -- Use notify.sendSilent to perform this operation
• beep -- Use notify.beep to perform this operation
• say -- Use notify.say to perform this operation

Quick Reference

Function	Description	Returns
send	send	object
sendUrgent	sendUrgent	object
sendSilent	sendSilent	object
beep	beep	object
say	say	object
alert	alert	object
confirm	confirm	object
prompt	prompt	object
clipboard	clipboard	object
getClipboard	getClipboard	object

Functions

send

send

Module: notify | Returns: object -- API response.

notify.send

Parameter	Type	Required	Description
input	string	No	Input parameter

---

sendUrgent

sendUrgent

Module: notify | Returns: object -- API response.

notify.sendUrgent

Parameter	Type	Required	Description
input	string	No	Input parameter

---

sendSilent

sendSilent

Module: notify | Returns: object -- API response.

notify.sendSilent

Parameter	Type	Required	Description
input	string	No	Input parameter

---

beep

beep

Module: notify | Returns: object -- API response.

notify.beep

Parameter	Type	Required	Description
input	string	No	Input parameter

---

say

say

Module: notify | Returns: object -- API response.

notify.say

Parameter	Type	Required	Description
input	string	No	Input parameter

---

alert

alert

Module: notify | Returns: object -- API response.

notify.alert

Parameter	Type	Required	Description
input	string	No	Input parameter

---

confirm

confirm

Module: notify | Returns: object -- API response.

notify.confirm

Parameter	Type	Required	Description
input	string	No	Input parameter

---

prompt

prompt

Module: notify | Returns: object -- API response.

notify.prompt

Parameter	Type	Required	Description
input	string	No	Input parameter

---

clipboard

clipboard

Module: notify | Returns: object -- API response.

notify.clipboard

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getClipboard

getClipboard

Module: notify | Returns: object -- API response.

notify.getClipboard

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Notify: "..." not configured. Call notify.setCredentials first.	Check the error message for details

@desc "Send and validate result"
do
  set $result as notify.send
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Clipboard

Retrieve all items and loop through them.

@desc "Get clipboard and iterate results"
do
  set $result as notify.getClipboard
  each $item in $result
    print $item
  end
enddo

2. Create a new item with send

Create a new resource and capture the result.

set $result as notify.send
print "Created: " + $result

3. Check before creating

List existing items and only create if needed.

@desc "Get clipboard and send"
do
  set $existing as notify.getClipboard
  if $existing == null
    notify.send
    print "Item created"
  else
    print "Item already exists"
  end
enddo

4. Multi-step Notify workflow

Chain multiple notify operations together.

@desc "Send, send urgent, and more"
do
  set $r_send as notify.send
  set $r_sendUrgent as notify.sendUrgent
  set $r_sendSilent as notify.sendSilent
  print "All operations complete"
enddo

5. Safe send with validation

Check results before proceeding.

@desc "Send and validate result"
do
  set $result as notify.send
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• slack -- Slack module for complementary functionality
• discord -- Discord module for complementary functionality
• teams -- Teams module for complementary functionality
• telegram -- Telegram module for complementary functionality
• whatsapp -- WhatsApp module for complementary functionality