UrbitEx.API.Notifications (UrbitEx v0.6.0) View Source
Client API to interact with hark-store
, the notifications system of Urbit.
Link to this section Summary
Functions
Set Do Not Disturb option. When true
, you won't receive notifications.
Takes an UrbitEx.Session struct and a boolean.
Fetches all notifications stored on your ship.
Takes an UrbitEx.Session struct, a type atom (or string), which can be :archive
or :inbox
(for old and current notifications), an offset integer and a count integer.
Returns a Timebox struct.
Ignore a channel. When ignored, your ship won't track unread nodes from that channel. Takes an UrbitEx.Session struct and an UrbitEx.Resource struct for the channel.
Mark all nodes in a channel as read. Takes an UrbitEx.Session struct, an UrbitEx.Resource struct for the group and another one for the channel.
Mark a nodes and their children in a channel as read.
This is used for notes and links, to set them and their children as read, together.
Takes an UrbitEx.Session struct, an UrbitEx.Resource struct for the group and another one for the channel.
It also takes an index string of the target node and the type of channel it belongs, whether :publish
or :link
.
Mark a nodes and their children in a channel as read.
This is used for notes and links, to set them and their children as read, together.
Takes an UrbitEx.Session struct, an UrbitEx.Resource struct for the group and another one for the channel.
It also takes an index string of the target node and the type of channel it belongs, whether :publish
or :link
.
Unmute a channel. When unmuted, your ship will track unread nodes from that channel. Takes an UrbitEx.Session struct and an UrbitEx.Resource struct for the channel.
Set whether you want notifications when you are mentioned in a channel you are subscribed to.
When false
, you won't receive notifications.
Takes an UrbitEx.Session struct and a boolean.
Set whether you want notifications when a node you authored has received replies,
e.g. a channel you host or a notebook post you wrote.
When false
, you won't receive notifications.
Takes an UrbitEx.Session struct and a boolean.
Link to this section Functions
Set Do Not Disturb option. When true
, you won't receive notifications.
Takes an UrbitEx.Session struct and a boolean.
Fetches all notifications stored on your ship.
Takes an UrbitEx.Session struct, a type atom (or string), which can be :archive
or :inbox
(for old and current notifications), an offset integer and a count integer.
Returns a Timebox struct.
Ignore a channel. When ignored, your ship won't track unread nodes from that channel. Takes an UrbitEx.Session struct and an UrbitEx.Resource struct for the channel.
Mark all nodes in a channel as read. Takes an UrbitEx.Session struct, an UrbitEx.Resource struct for the group and another one for the channel.
read_node(session, channel, group, resource, node_index, channel_type)
View SourceMark a nodes and their children in a channel as read.
This is used for notes and links, to set them and their children as read, together.
Takes an UrbitEx.Session struct, an UrbitEx.Resource struct for the group and another one for the channel.
It also takes an index string of the target node and the type of channel it belongs, whether :publish
or :link
.
read_whole_node(session, channel, group, resource, node_index, channel_type)
View SourceMark a nodes and their children in a channel as read.
This is used for notes and links, to set them and their children as read, together.
Takes an UrbitEx.Session struct, an UrbitEx.Resource struct for the group and another one for the channel.
It also takes an index string of the target node and the type of channel it belongs, whether :publish
or :link
.
Unmute a channel. When unmuted, your ship will track unread nodes from that channel. Takes an UrbitEx.Session struct and an UrbitEx.Resource struct for the channel.
Set whether you want notifications when you are mentioned in a channel you are subscribed to.
When false
, you won't receive notifications.
Takes an UrbitEx.Session struct and a boolean.
Set whether you want notifications when a node you authored has received replies,
e.g. a channel you host or a notebook post you wrote.
When false
, you won't receive notifications.
Takes an UrbitEx.Session struct and a boolean.